Skip to content

SubscribeToShardInput

Source code in docs_src/capo_kinesis/types/subscribe_to_shard_input.py 
17
18
19
20
21
22
23
24
25
26
27
class SubscribeToShardInput(TypedDict, closed=True):
    consumer_arn: "capo_kinesis.types.consumer_arn.ConsumerARN"
    """<p>For this parameter, use the value you obtained when you called <a>RegisterStreamConsumer</a>.</p>"""
    stream_id: NotRequired["capo_kinesis.types.stream_id.StreamId"]
    """<p>Not Implemented. Reserved for future use.</p>"""
    shard_id: "capo_kinesis.types.shard_id.ShardId"
    """<p>The ID of the shard you want to subscribe to. To see a list of all the shards for a given stream, use <a>ListShards</a>.</p>"""
    starting_position: "capo_kinesis.types.starting_position.StartingPosition"
    """<p>The starting position in the data stream from which to start streaming.</p>"""
    dry_run: NotRequired["capo_kinesis.types.boolean_object.BooleanObject"]
    """<p>Checks if your request will succeed. <code>DryRun</code> is an optional parameter.</p>"""

consumer_arn instance-attribute 

consumer_arn: ConsumerARN

For this parameter, use the value you obtained when you called RegisterStreamConsumer.

dry_run instance-attribute 

dry_run: NotRequired[BooleanObject]

Checks if your request will succeed. DryRun is an optional parameter.

shard_id instance-attribute 

shard_id: ShardId

The ID of the shard you want to subscribe to. To see a list of all the shards for a given stream, use ListShards.

starting_position instance-attribute 

starting_position: StartingPosition

The starting position in the data stream from which to start streaming.

stream_id instance-attribute 

stream_id: NotRequired[StreamId]

Not Implemented. Reserved for future use.