Amazon Aurora DSQL Aurora Dsql Stream API
The Aurora Dsql Stream API from Amazon Aurora DSQL — 2 operation(s) for aurora dsql stream.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-aurora-dsql:amazon-aurora-dsql-stream-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Amazon Aurora DSQL Stream API
version: '2018-05-10'
description: Generated from AWS's published Smithy model for Amazon Aurora DSQL. 4 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://dsql.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
tags:
- name: Stream
paths:
/stream/{clusterIdentifier}:
post:
operationId: CreateStream
summary: Create Stream
description: 'Creates a new change data capture (CDC) stream for a cluster. The stream captures database changes and delivers them to the specified target destination. Required permissions dsql:CreateStream Permission to create a new stream. Resources: arn:aws:dsql:region:account-id:cluster/cluster-id iam:PassRole Permission to pass the IAM role specified in the target definition to the service. Resources: ARN of the IAM role specified in targetDefinition.kinesis.roleArn kms:Decrypt Required when the cluster uses a customer managed KMS key (CMK). Permission to decrypt data using the cluster''s CMK. Resources: ARN of the KMS key used by the cluster'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateStreamOutput'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'402':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'400':
description: ValidationException; ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateStreamInput'
tags:
- Stream
get:
operationId: ListStreams
summary: List Streams
description: Retrieves information about a list of streams for a cluster.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListStreamsOutput'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListStreamsInput'
tags:
- Stream
/stream/{clusterIdentifier}/{streamIdentifier}:
get:
operationId: GetStream
summary: Get Stream
description: Retrieves information about a stream.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetStreamOutput'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetStreamInput'
tags:
- Stream
delete:
operationId: DeleteStream
summary: Delete Stream
description: Deletes a stream from a cluster.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteStreamOutput'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'403':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteStreamInput'
tags:
- Stream
components:
schemas:
DeleteStreamOutput:
type: object
properties:
clusterIdentifier:
type: string
description: The ID of the cluster for the deleted stream.
streamIdentifier:
type: string
description: The ID of the deleted stream.
arn:
type: string
description: The ARN of the deleted stream.
status:
type: string
enum:
- CREATING
- ACTIVE
- DELETING
- DELETED
- FAILED
- IMPAIRED
description: The status of the stream.
creationTime:
type: string
format: date-time
description: The time when the stream was created.
required:
- clusterIdentifier
- streamIdentifier
- arn
- status
- creationTime
InternalServerException:
type: object
properties:
message:
type: string
retryAfterSeconds:
type: integer
description: Retry after seconds.
required:
- message
ConflictException:
type: object
properties:
message:
type: string
resourceId:
type: string
description: Resource Id
resourceType:
type: string
description: Resource Type
required:
- message
StreamSummary:
type: object
properties:
clusterIdentifier:
type: string
description: The ID of the cluster.
streamIdentifier:
type: string
description: The ID of the stream.
arn:
type: string
description: The ARN of the stream.
creationTime:
type: string
format: date-time
description: The timestamp when the stream was created.
status:
type: string
enum:
- CREATING
- ACTIVE
- DELETING
- DELETED
- FAILED
- IMPAIRED
description: The current status of the stream.
required:
- clusterIdentifier
- streamIdentifier
- arn
- creationTime
- status
CreateStreamInput:
type: object
properties:
clusterIdentifier:
type: string
description: The ID of the cluster for which to create the stream.
targetDefinition:
$ref: '#/components/schemas/TargetDefinition'
ordering:
type: string
enum:
- UNORDERED
description: The ordering mode for the stream. Determines how change events are ordered when delivered to the target.
format:
type: string
enum:
- JSON
description: The format of the stream records.
tags:
type: object
additionalProperties:
type: string
description: A map of key and value pairs to use to tag your stream.
clientToken:
type: string
description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the Amazon Web Services SDK automatically generates one.
required:
- clusterIdentifier
- targetDefinition
- ordering
- format
ResourceNotFoundException:
type: object
properties:
message:
type: string
resourceId:
type: string
description: The resource ID could not be found.
resourceType:
type: string
description: The resource type could not be found.
required:
- message
- resourceId
- resourceType
ValidationExceptionField:
type: object
properties:
name:
type: string
description: The name of the field.
message:
type: string
description: A message describing why this field failed validation.
required:
- name
- message
KinesisTargetDefinition:
type: object
properties:
streamArn:
type: string
description: The ARN of the Kinesis stream.
roleArn:
type: string
description: The ARN of the IAM role that grants permission to write to the Kinesis stream. This can be a standard role (arn:aws:iam::account-id:role/role-name) or a role with a path prefix (arn:aws:iam::account-id:role/service-role/role-name), such as roles auto-created by the console.
required:
- streamArn
- roleArn
AccessDeniedException:
type: object
properties:
message:
type: string
required:
- message
ListStreamsInput:
type: object
properties:
clusterIdentifier:
type: string
description: The ID of the cluster for which to list streams.
maxResults:
type: integer
description: 'An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results. Default: 10.'
nextToken:
type: string
description: If your initial ListStreams operation returns a nextToken, you can include the returned nextToken in following ListStreams operations, which returns results in the next page.
required:
- clusterIdentifier
CreateStreamOutput:
type: object
properties:
clusterIdentifier:
type: string
description: The ID of the cluster for the created stream.
streamIdentifier:
type: string
description: The ID of the created stream.
arn:
type: string
description: The ARN of the created stream.
status:
type: string
enum:
- CREATING
- ACTIVE
- DELETING
- DELETED
- FAILED
- IMPAIRED
description: The status of the created stream.
creationTime:
type: string
format: date-time
description: The time when created the stream.
ordering:
type: string
enum:
- UNORDERED
description: The ordering mode of the created stream.
format:
type: string
enum:
- JSON
description: The format of the created stream records.
required:
- clusterIdentifier
- streamIdentifier
- arn
- status
- creationTime
- ordering
- format
GetStreamInput:
type: object
properties:
clusterIdentifier:
type: string
description: The ID of the cluster containing the stream to retrieve.
streamIdentifier:
type: string
description: The ID of the stream to retrieve.
required:
- clusterIdentifier
- streamIdentifier
StatusReason:
type: object
properties:
error:
type: string
enum:
- KINESIS_THROUGHPUT_EXCEEDED
- KINESIS_STREAM_NOT_FOUND
- ROLE_ACCESS_DENIED
- KINESIS_ACCESS_DENIED
- KINESIS_KMS_ACCESS_DENIED
- KINESIS_OVERSIZE_RECORD
- CLUSTER_CMK_INACCESSIBLE
- INTERNAL_ERROR
description: The error code for the stream failure.
updatedAt:
type: string
description: The timestamp when the status was updated.
required:
- error
- updatedAt
GetStreamOutput:
type: object
properties:
clusterIdentifier:
type: string
description: The ID of the cluster for the retrieved stream.
streamIdentifier:
type: string
description: The ID of the retrieved stream.
arn:
type: string
description: The ARN of the retrieved stream.
status:
type: string
enum:
- CREATING
- ACTIVE
- DELETING
- DELETED
- FAILED
- IMPAIRED
description: The current status of the retrieved stream.
creationTime:
type: string
format: date-time
description: The time when the stream was created.
ordering:
type: string
enum:
- UNORDERED
description: The ordering mode of the stream.
format:
type: string
enum:
- JSON
description: The format of the stream records.
targetDefinition:
$ref: '#/components/schemas/TargetDefinition'
statusReason:
$ref: '#/components/schemas/StatusReason'
tags:
type: object
additionalProperties:
type: string
description: A map of tags associated with the stream.
required:
- clusterIdentifier
- streamIdentifier
- arn
- status
- creationTime
- ordering
- format
TargetDefinition:
type: object
properties:
kinesis:
$ref: '#/components/schemas/KinesisTargetDefinition'
description: Exactly one member is set.
ThrottlingException:
type: object
properties:
message:
type: string
description: The message that the request was denied due to request throttling.
serviceCode:
type: string
description: The request exceeds a service quota.
quotaCode:
type: string
description: The request exceeds a request rate quota.
retryAfterSeconds:
type: integer
description: The request exceeds a request rate quota. Retry after seconds.
required:
- message
ServiceQuotaExceededException:
type: object
properties:
message:
type: string
description: The service exception for exceeding a quota.
resourceId:
type: string
description: The resource ID exceeds a quota.
resourceType:
type: string
description: The resource type exceeds a quota.
serviceCode:
type: string
description: The request exceeds a service quota.
quotaCode:
type: string
description: The service exceeds a quota.
required:
- message
- resourceId
- resourceType
- serviceCode
- quotaCode
DeleteStreamInput:
type: object
properties:
clusterIdentifier:
type: string
description: The ID of the cluster containing the stream to delete.
streamIdentifier:
type: string
description: The ID of the stream to delete.
clientToken:
type: string
description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the Amazon Web Services SDK automatically generates one.
required:
- clusterIdentifier
- streamIdentifier
ValidationException:
type: object
properties:
message:
type: string
reason:
type: string
enum:
- unknownOperation
- cannotParse
- fieldValidationFailed
- deletionProtectionEnabled
- other
description: The reason for the validation exception.
fieldList:
type: array
items:
$ref: '#/components/schemas/ValidationExceptionField'
description: A list of fields that didn't validate.
required:
- message
- reason
ListStreamsOutput:
type: object
properties:
nextToken:
type: string
description: If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token.
streams:
type: array
items:
$ref: '#/components/schemas/StreamSummary'
description: An array of the returned streams.
required:
- streams
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: dsql
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/dsql/service/2018-05-10/dsql-2018-05-10.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)