You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DynamoDBStreams::Types::GetShardIteratorInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetShardIteratorInput as input to an Aws::Client method, you can use a vanilla 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",
}

Represents the input of a GetShardIterator operation.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#sequence_number ⇒ String

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

Returns:

  • (String) —

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

#shard_id ⇒ String

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

Returns:

  • (String) —

    The identifier of the shard.

#shard_iterator_type ⇒ String

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.

    Possible values:

    • TRIM_HORIZON
    • LATEST
    • AT_SEQUENCE_NUMBER
    • AFTER_SEQUENCE_NUMBER

Returns:

  • (String) —

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

#stream_arn ⇒ String

The Amazon Resource Name (ARN) for the stream.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) for the stream.