Skip to content

ListStreamsInput

Source code in docs_src/capo_keyspacesstreams/types/list_streams_input.py 
13
14
15
16
17
18
19
20
21
22
23
class ListStreamsInput(TypedDict, closed=True):
    keyspace_name: NotRequired["capo_keyspacesstreams.types.keyspace_name.KeyspaceName"]
    """<p> 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. </p>"""
    table_name: NotRequired["capo_keyspacesstreams.types.table_name.TableName"]
    """<p> The name of the table for which to list streams. Must be used together with <code>keyspaceName</code>. If specified, only streams associated with this specific table are returned. </p>"""
    max_results: NotRequired["int"]
    """<p> The maximum number of streams to return in a single <code>ListStreams</code> request. The default value is 100. The minimum value is 1 and the maximum value is 100. </p>"""
    next_token: NotRequired[
        "capo_keyspacesstreams.types.stream_arn_token.StreamArnToken"
    ]
    """<p> An optional pagination token provided by a previous <code>ListStreams</code> operation. If this parameter is specified, the response includes only records beyond the token, up to the value specified by <code>maxResults</code>. </p>"""

keyspace_name instance-attribute 

keyspace_name: NotRequired[KeyspaceName]

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.

max_results instance-attribute 

max_results: NotRequired[int]

The maximum number of streams to return in a single ListStreams request. The default value is 100. The minimum value is 1 and the maximum value is 100.

next_token instance-attribute 

next_token: NotRequired[StreamArnToken]

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.

table_name instance-attribute 

table_name: NotRequired[TableName]

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.