Skip to content

GetStreamInput

Source code in docs_src/capo_keyspacesstreams/types/get_stream_input.py 
15
16
17
18
19
20
21
22
23
class GetStreamInput(TypedDict, closed=True):
    stream_arn: "capo_keyspacesstreams.types.stream_arn.StreamArn"
    """<p> The Amazon Resource Name (ARN) of the stream for which detailed information is requested. This uniquely identifies the specific stream you want to get information about. </p>"""
    max_results: NotRequired["int"]
    """<p> The maximum number of shard objects to return in a single <code>GetStream</code> request. The default value is 100. The minimum value is 1 and the maximum value is 100. </p>"""
    shard_filter: NotRequired["capo_keyspacesstreams.types.shard_filter.ShardFilter"]
    """<p> Optional filter criteria to apply when retrieving shards. You can filter shards based on their parent <code>shardID</code> to get a list of children shards to narrow down the results returned by the <code>GetStream</code> operation. </p>"""
    next_token: NotRequired["capo_keyspacesstreams.types.shard_id_token.ShardIdToken"]
    """<p> An optional pagination token provided by a previous <code>GetStream</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>"""

max_results instance-attribute 

max_results: NotRequired[int]

The maximum number of shard objects to return in a single GetStream request. The default value is 100. The minimum value is 1 and the maximum value is 100.

next_token instance-attribute 

next_token: NotRequired[ShardIdToken]

An optional pagination token provided by a previous GetStream operation. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxResults.

shard_filter instance-attribute 

shard_filter: NotRequired[ShardFilter]

Optional filter criteria to apply when retrieving shards. You can filter shards based on their parent shardID to get a list of children shards to narrow down the results returned by the GetStream operation.

stream_arn instance-attribute 

stream_arn: StreamArn

The Amazon Resource Name (ARN) of the stream for which detailed information is requested. This uniquely identifies the specific stream you want to get information about.