Skip to content

DescribeStreamInput

Source code in docs_src/capo_dynamodb_streams/types/describe_stream_input.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
class DescribeStreamInput(TypedDict, closed=True):
    stream_arn: "capo_dynamodb_streams.types.stream_arn.StreamArn"
    """<p>The Amazon Resource Name (ARN) for the stream.</p>"""
    limit: NotRequired[
        "capo_dynamodb_streams.types.positive_integer_object.PositiveIntegerObject"
    ]
    """<p>The maximum number of shard objects to return. The upper limit is 100.</p>"""
    exclusive_start_shard_id: NotRequired[
        "capo_dynamodb_streams.types.shard_id.ShardId"
    ]
    """<p>The shard ID of the first item that this operation will evaluate. Use the value that was returned for <code>LastEvaluatedShardId</code> in the previous operation. </p>"""
    shard_filter: NotRequired["capo_dynamodb_streams.types.shard_filter.ShardFilter"]
    """<p>This optional field contains the filter definition for the <code>DescribeStream</code> API.</p>"""

exclusive_start_shard_id instance-attribute 

exclusive_start_shard_id: NotRequired[ShardId]

The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId in the previous operation.

limit instance-attribute 

limit: NotRequired[PositiveIntegerObject]

The maximum number of shard objects to return. The upper limit is 100.

shard_filter instance-attribute 

shard_filter: NotRequired[ShardFilter]

This optional field contains the filter definition for the DescribeStream API.

stream_arn instance-attribute 

stream_arn: StreamArn

The Amazon Resource Name (ARN) for the stream.