KeyspacesStreams / Client / list_streams

list_streams¶

KeyspacesStreams.Client.list_streams(**kwargs)¶

Returns a list of all data capture streams associated with your Amazon Keyspaces account or for a specific keyspace or table. The response includes information such as stream ARNs, table associations, creation timestamps, and current status. This operation helps you discover and manage all active data streams in your Amazon Keyspaces environment.

Request Syntax

response = client.list_streams(
    keyspaceName='string',
    tableName='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

keyspaceName (string) – The name of the keyspace for which to list streams. If specified, only streams associated with tables in this keyspace are returned. If omitted, streams from all keyspaces are included in the results.
tableName (string) – The name of the table for which to list streams. Must be used together with keyspaceName. If specified, only streams associated with this specific table are returned.
maxResults (integer) – The maximum number of streams to return in a single ListStreams request. Default value is 100. The minimum value is 1 and the maximum value is 1000.
nextToken (string) – An optional pagination token provided by a previous ListStreams operation. If this parameter is specified, the response includes only records beyond the token, up to the value specified by maxResults.

Return type:

dict

Returns:

Response Syntax

{
    'streams': [
        {
            'streamArn': 'string',
            'keyspaceName': 'string',
            'tableName': 'string',
            'streamLabel': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- streams (list) –
  
  An array of stream objects, each containing summary information about a stream including its ARN, status, and associated table information. This list includes all streams that match the request criteria.
  - (dict) –
    
    Represents a change data capture stream for an Amazon Keyspaces table, which enables tracking and processing of data changes.
    - streamArn (string) –
      
      The Amazon Resource Name (ARN) that uniquely identifies this stream.
    - keyspaceName (string) –
      
      The name of the keyspace containing the table associated with this stream.
    - tableName (string) –
      
      The name of the table associated with this stream.
    - streamLabel (string) –
      
      A unique identifier for this stream that can be used in stream operations.
- nextToken (string) –
  
  A pagination token that can be used in a subsequent ListStreams request. This token is returned if the response contains more streams than can be returned in a single response based on the MaxResults parameter.

Exceptions

KeyspacesStreams.Client.exceptions.ThrottlingException
KeyspacesStreams.Client.exceptions.AccessDeniedException
KeyspacesStreams.Client.exceptions.InternalServerException
KeyspacesStreams.Client.exceptions.ValidationException
KeyspacesStreams.Client.exceptions.ResourceNotFoundException