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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-dynamodbstreams/types.rb

Overview

Represents the input of a ‘GetShardIterator` operation.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

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) 


255
256
257
258
259
260
261
262
 
# File 'lib/aws-sdk-dynamodbstreams/types.rb', line 255

class GetShardIteratorInput < Struct.new(
  :stream_arn,
  :shard_id,
  :shard_iterator_type,
  :sequence_number)
  SENSITIVE = []
  include Aws::Structure
end

#shard_id ⇒ String

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

Returns:

  • (String) 


255
256
257
258
259
260
261
262
 
# File 'lib/aws-sdk-dynamodbstreams/types.rb', line 255

class GetShardIteratorInput < Struct.new(
  :stream_arn,
  :shard_id,
  :shard_iterator_type,
  :sequence_number)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

  • (String) 


255
256
257
258
259
260
261
262
 
# File 'lib/aws-sdk-dynamodbstreams/types.rb', line 255

class GetShardIteratorInput < Struct.new(
  :stream_arn,
  :shard_id,
  :shard_iterator_type,
  :sequence_number)
  SENSITIVE = []
  include Aws::Structure
end

#stream_arn ⇒ String

The Amazon Resource Name (ARN) for the stream.

Returns:

  • (String) 


255
256
257
258
259
260
261
262
 
# File 'lib/aws-sdk-dynamodbstreams/types.rb', line 255

class GetShardIteratorInput < Struct.new(
  :stream_arn,
  :shard_id,
  :shard_iterator_type,
  :sequence_number)
  SENSITIVE = []
  include Aws::Structure
end