AWS API Changes

2026/05/13 - Amazon Aurora DSQL - 4 new api methods

Changes Added support for Amazon Aurora DSQL change data capture (CDC) streams that deliver row-level database changes to Amazon Kinesis in JSON format. Includes CreateStream, GetStream, ListStreams, and DeleteStream operations.

ListStreams (new)

Link ¶

Retrieves information about a list of streams for a cluster.

See also: AWS API Documentation

Request Syntax

client.list_streams(
    clusterIdentifier='string',
    maxResults=123,
    nextToken='string'
)

type clusterIdentifier:

string

param clusterIdentifier:

[REQUIRED]

The ID of the cluster for which to list streams.

type maxResults:

integer

param maxResults:

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.

type nextToken:

string

param nextToken:

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.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'streams': [
        {
            'clusterIdentifier': 'string',
            'streamIdentifier': 'string',
            'arn': 'string',
            'creationTime': datetime(2015, 1, 1),
            'status': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'FAILED'|'IMPAIRED'
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  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 (list) --
  
  An array of the returned streams.
  - (dict) --
    
    Summary information about a stream.
    - clusterIdentifier (string) --
      
      The ID of the cluster.
    - streamIdentifier (string) --
      
      The ID of the stream.
    - arn (string) --
      
      The ARN of the stream.
    - creationTime (datetime) --
      
      The timestamp when the stream was created.
    - status (string) --
      
      The current status of the stream.

DeleteStream (new)

Link ¶

Deletes a stream from a cluster.

See also: AWS API Documentation

Request Syntax

client.delete_stream(
    clusterIdentifier='string',
    streamIdentifier='string',
    clientToken='string'
)

type clusterIdentifier:

string

param clusterIdentifier:

[REQUIRED]

The ID of the cluster containing the stream to delete.

type streamIdentifier:

string

param streamIdentifier:

[REQUIRED]

The ID of the stream to delete.

type clientToken:

string

param clientToken:

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.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'clusterIdentifier': 'string',
    'streamIdentifier': 'string',
    'arn': 'string',
    'status': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'FAILED'|'IMPAIRED',
    'creationTime': datetime(2015, 1, 1)
}

Response Structure

(dict) --

The output from a deleted stream.
- clusterIdentifier (string) --
  
  The ID of the cluster for the deleted stream.
- streamIdentifier (string) --
  
  The ID of the deleted stream.
- arn (string) --
  
  The ARN of the deleted stream.
- status (string) --
  
  The status of the stream.
- creationTime (datetime) --
  
  The time when the stream was created.

CreateStream (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.create_stream(
    clusterIdentifier='string',
    targetDefinition={
        'kinesis': {
            'streamArn': 'string',
            'roleArn': 'string'
        }
    },
    ordering='UNORDERED',
    format='JSON',
    tags={
        'string': 'string'
    },
    clientToken='string'
)

type clusterIdentifier:

string

param clusterIdentifier:

[REQUIRED]

The ID of the cluster for which to create the stream.

type targetDefinition:

dict

param targetDefinition:

[REQUIRED]

The target destination configuration for the stream. Contains Kinesis stream configuration including stream ARN and IAM role ARN.

kinesis (dict) --

Kinesis stream target configuration.
- streamArn (string) -- [REQUIRED]
  
  The ARN of the Kinesis stream.
- roleArn (string) -- [REQUIRED]
  
  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.

type ordering:

string

param ordering:

[REQUIRED]

The ordering mode for the stream. Determines how change events are ordered when delivered to the target.

type format:

string

param format:

[REQUIRED]

The format of the stream records.

type tags:

dict

param tags:

A map of key and value pairs to use to tag your stream.

(string) --

Unique tag key, maximum 128 Unicode characters in UTF-8.
- (string) --
  
  Tag value, maximum 256 Unicode characters in UTF-8.

type clientToken:

string

param clientToken:

If you don't specify a client token, the Amazon Web Services SDK automatically generates one.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'clusterIdentifier': 'string',
    'streamIdentifier': 'string',
    'arn': 'string',
    'status': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'FAILED'|'IMPAIRED',
    'creationTime': datetime(2015, 1, 1),
    'ordering': 'UNORDERED',
    'format': 'JSON'
}

Response Structure

(dict) --

The output of a created stream.
- clusterIdentifier (string) --
  
  The ID of the cluster for the created stream.
- streamIdentifier (string) --
  
  The ID of the created stream.
- arn (string) --
  
  The ARN of the created stream.
- status (string) --
  
  The status of the created stream.
- creationTime (datetime) --
  
  The time when created the stream.
- ordering (string) --
  
  The ordering mode of the created stream.
- format (string) --
  
  The format of the created stream records.

GetStream (new)

Link ¶

Retrieves information about a stream.

See also: AWS API Documentation

Request Syntax

client.get_stream(
    clusterIdentifier='string',
    streamIdentifier='string'
)

type clusterIdentifier:

string

param clusterIdentifier:

[REQUIRED]

The ID of the cluster containing the stream to retrieve.

type streamIdentifier:

string

param streamIdentifier:

[REQUIRED]

The ID of the stream to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'clusterIdentifier': 'string',
    'streamIdentifier': 'string',
    'arn': 'string',
    'status': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'FAILED'|'IMPAIRED',
    'creationTime': datetime(2015, 1, 1),
    'ordering': 'UNORDERED',
    'format': 'JSON',
    'targetDefinition': {
        'kinesis': {
            'streamArn': 'string',
            'roleArn': 'string'
        }
    },
    'statusReason': {
        'error': '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',
        'updatedAt': datetime(2015, 1, 1)
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --

The output of a retrieved stream.
- clusterIdentifier (string) --
  
  The ID of the cluster for the retrieved stream.
- streamIdentifier (string) --
  
  The ID of the retrieved stream.
- arn (string) --
  
  The ARN of the retrieved stream.
- status (string) --
  
  The current status of the retrieved stream.
- creationTime (datetime) --
  
  The time when the stream was created.
- ordering (string) --
  
  The ordering mode of the stream.
- format (string) --
  
  The format of the stream records.
- targetDefinition (dict) --
  
  The target definition for the stream destination.
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys will be set: kinesis. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
  - kinesis (dict) --
    
    Kinesis stream target configuration.
    - streamArn (string) --
      
      The ARN of the Kinesis stream.
    - roleArn (string) --
      
      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.
- statusReason (dict) --
  
  Stream status reason with error code and timestamp (if applicable).
  - error (string) --
    
    The error code for the stream failure.
  - updatedAt (datetime) --
    
    The timestamp when the status was updated.
- tags (dict) --
  
  A map of tags associated with the stream.
  - (string) --
    
    Unique tag key, maximum 128 Unicode characters in UTF-8.
    - (string) --
      
      Tag value, maximum 256 Unicode characters in UTF-8.