Skip to content

GetShardIteratorInput

Source code in docs_src/capo_dynamodb_streams/types/get_shard_iterator_input.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class GetShardIteratorInput(TypedDict, closed=True):
    stream_arn: "capo_dynamodb_streams.types.stream_arn.StreamArn"
    """<p>The Amazon Resource Name (ARN) for the stream.</p>"""
    shard_id: "capo_dynamodb_streams.types.shard_id.ShardId"
    """<p>The identifier of the shard. The iterator will be returned for this shard ID.</p>"""
    shard_iterator_type: (
        "capo_dynamodb_streams.types.shard_iterator_type.ShardIteratorType"
    )
    """<p>Determines how the shard iterator is used to start reading stream records from the shard:</p> <ul> <li> <p> <code>AT_SEQUENCE_NUMBER</code> - Start reading exactly from the position denoted by a specific sequence number.</p> </li> <li> <p> <code>AFTER_SEQUENCE_NUMBER</code> - Start reading right after the position denoted by a specific sequence number.</p> </li> <li> <p> <code>TRIM_HORIZON</code> - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream.</p> </li> <li> <p> <code>LATEST</code> - Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.</p> </li> <li> <p> <code>AT_TIMESTAMP</code> - Start reading from the position denoted by a specific timestamp, provided in the parameter <code>Timestamp</code>.</p> </li> </ul>"""
    sequence_number: NotRequired[
        "capo_dynamodb_streams.types.sequence_number.SequenceNumber"
    ]
    """<p>The sequence number of a stream record in the shard from which to start reading.</p>"""
    timestamp: NotRequired["capo_dynamodb_streams.types.timestamp.Timestamp"]
    """<p>The timestamp of the stream record from which to start reading. Used with shard iterator type <code>AT_TIMESTAMP</code>. A timestamp is the Unix epoch date with precision in milliseconds. For example, <code>1791316726.480</code>. The iterator points to the first stream record whose <code>ApproximateCreationDateTime</code> is at or after the specified timestamp. If no record with that exact timestamp exists, the iterator points to the next (later) record. If the timestamp is older than the current trim horizon, the iterator points to the oldest untrimmed stream record (<code>TRIM_HORIZON</code>). If the timestamp is in the future, the request returns a <code>ValidationException</code>.</p>"""

sequence_number instance-attribute 

sequence_number: NotRequired[SequenceNumber]

The sequence number of a stream record in the shard from which to start reading.

shard_id instance-attribute 

shard_id: ShardId

The identifier of the shard. The iterator will be returned for this shard ID.

shard_iterator_type instance-attribute 

shard_iterator_type: ShardIteratorType

Determines how the shard iterator is used to start reading stream records from the shard:

  • AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.

  • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.

  • TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream.

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

  • AT_TIMESTAMP - Start reading from the position denoted by a specific timestamp, provided in the parameter Timestamp.

stream_arn instance-attribute 

stream_arn: StreamArn

The Amazon Resource Name (ARN) for the stream.

timestamp instance-attribute 

timestamp: NotRequired[Timestamp]

The timestamp of the stream record from which to start reading. Used with shard iterator type AT_TIMESTAMP. A timestamp is the Unix epoch date with precision in milliseconds. For example, 1791316726.480. The iterator points to the first stream record whose ApproximateCreationDateTime is at or after the specified timestamp. If no record with that exact timestamp exists, the iterator points to the next (later) record. If the timestamp is older than the current trim horizon, the iterator points to the oldest untrimmed stream record (TRIM_HORIZON). If the timestamp is in the future, the request returns a ValidationException.