KeyspacesStreams / Paginator / ListStreams

ListStreams

class KeyspacesStreams.Paginator.ListStreams

paginator = client.get_paginator('list_streams')

paginate(**kwargs)

Creates an iterator that will paginate through responses from KeyspacesStreams.Client.list_streams().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    keyspaceName='string',
    tableName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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 token to resume pagination.