Skip to content

GetShardIteratorInput

Source code in docs_src/capo_keyspacesstreams/types/get_shard_iterator_input.py
class GetShardIteratorInput(TypedDict, closed=True):
    stream_arn: "capo_keyspacesstreams.types.stream_arn.StreamArn"
    """<p> The Amazon Resource Name (ARN) of the stream for which to get the shard iterator. The ARN uniquely identifies the stream within Amazon Keyspaces. </p>"""
    shard_id: "capo_keyspacesstreams.types.shard_id.ShardId"
    """<p> The identifier of the shard within the stream. The shard ID uniquely identifies a subset of the stream's data records that you want to access. </p>"""
    shard_iterator_type: (
        "capo_keyspacesstreams.types.shard_iterator_type.ShardIteratorType"
    )
    """<p> Determines how the shard iterator is positioned. Must be one of the following: </p> <ul> <li> <p> <code>TRIM_HORIZON</code> - Start reading at the last untrimmed record in the shard, which is the oldest data record in the shard.</p> </li> <li> <p> <code>AT_SEQUENCE_NUMBER</code> - Start reading exactly from the specified sequence number.</p> </li> <li> <p> <code>AFTER_SEQUENCE_NUMBER</code> - Start reading right after the specified sequence number. </p> </li> <li> <p> <code>LATEST</code> - Start reading just after the most recent record in the shard, so that you always read the most recent data. </p> </li> </ul>"""
    sequence_number: NotRequired[
        "capo_keyspacesstreams.types.sequence_number.SequenceNumber"
    ]
    """<p> The sequence number of the data record in the shard from which to start reading. Required if <code>ShardIteratorType</code> is <code>AT_SEQUENCE_NUMBER</code> or <code>AFTER_SEQUENCE_NUMBER</code>. This parameter is ignored for other iterator types. </p>"""

sequence_number instance-attribute

sequence_number: NotRequired[SequenceNumber]

The sequence number of the data record in the shard from which to start reading. Required if ShardIteratorType is AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. This parameter is ignored for other iterator types.

shard_id instance-attribute

shard_id: ShardId

The identifier of the shard within the stream. The shard ID uniquely identifies a subset of the stream's data records that you want to access.

shard_iterator_type instance-attribute

shard_iterator_type: ShardIteratorType

Determines how the shard iterator is positioned. Must be one of the following:

  • TRIM_HORIZON - Start reading at the last untrimmed record in the shard, which is the oldest data record in the shard.

  • AT_SEQUENCE_NUMBER - Start reading exactly from the specified sequence number.

  • AFTER_SEQUENCE_NUMBER - Start reading right after the specified sequence number.

  • LATEST - Start reading just after the most recent record in the shard, so that you always read the most recent data.

stream_arn instance-attribute

stream_arn: StreamArn

The Amazon Resource Name (ARN) of the stream for which to get the shard iterator. The ARN uniquely identifies the stream within Amazon Keyspaces.