class Aws::DynamoDBStreams::Types::GetShardIteratorInput
Represents the input of a `GetShardIterator` operation.
@note When making an API call, you may pass GetShardIteratorInput
data as a hash: { stream_arn: "StreamArn", # required shard_id: "ShardId", # required shard_iterator_type: "TRIM_HORIZON", # required, accepts TRIM_HORIZON, LATEST, AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER sequence_number: "SequenceNumber", }
@!attribute [rw] stream_arn
The Amazon Resource Name (ARN) for the stream. @return [String]
@!attribute [rw] shard_id
The identifier of the shard. The iterator will be returned for this shard ID. @return [String]
@!attribute [rw] shard_iterator_type
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. @return [String]
@!attribute [rw] sequence_number
The sequence number of a stream record in the shard from which to start reading. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/GetShardIteratorInput AWS API Documentation
Constants
- SENSITIVE