Class: Aws::KeyspacesStreams::Types::GetShardIteratorInput

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#sequence_number ⇒ String

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.

Returns:

  • (String) 


119
120
121
122
123
124
125
126
 
# File 'lib/aws-sdk-keyspacesstreams/types.rb', line 119

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 within the stream. The shard ID uniquely identifies a subset of the stream’s data records that you want to access.

Returns:

  • (String) 


119
120
121
122
123
124
125
126
 
# File 'lib/aws-sdk-keyspacesstreams/types.rb', line 119

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

Returns:

  • (String) 


119
120
121
122
123
124
125
126
 
# File 'lib/aws-sdk-keyspacesstreams/types.rb', line 119

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) of the stream for which to get the shard iterator. The ARN uniquely identifies the stream within Amazon Keyspaces.

Returns:

  • (String) 


119
120
121
122
123
124
125
126
 
# File 'lib/aws-sdk-keyspacesstreams/types.rb', line 119

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