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

Class: Aws::Kinesis::Types::GetShardIteratorInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb

Overview

Note:

When making an API call, you may pass GetShardIteratorInput data as a hash:

{
  stream_name: "StreamName", # required
  shard_id: "ShardId", # required
  shard_iterator_type: "AT_SEQUENCE_NUMBER", # required, accepts AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER, TRIM_HORIZON, LATEST, AT_TIMESTAMP
  starting_sequence_number: "SequenceNumber",
  timestamp: Time.now,
}

Represents the input for GetShardIterator.

Instance Attribute Summary collapse

Instance Attribute Details

#shard_idString

The shard ID of the Amazon Kinesis shard to get the iterator for.

Returns:

  • (String)


486
487
488
489
490
491
492
493
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 486

class GetShardIteratorInput < Struct.new(
  :stream_name,
  :shard_id,
  :shard_iterator_type,
  :starting_sequence_number,
  :timestamp)
  include Aws::Structure
end

#shard_iterator_typeString

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

The following are the valid Amazon Kinesis shard iterator types:

  • AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

  • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

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

  • TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard.

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

Returns:

  • (String)


486
487
488
489
490
491
492
493
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 486

class GetShardIteratorInput < Struct.new(
  :stream_name,
  :shard_id,
  :shard_iterator_type,
  :starting_sequence_number,
  :timestamp)
  include Aws::Structure
end

#starting_sequence_numberString

The sequence number of the data record in the shard from which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.

Returns:

  • (String)


486
487
488
489
490
491
492
493
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 486

class GetShardIteratorInput < Struct.new(
  :stream_name,
  :shard_id,
  :shard_iterator_type,
  :starting_sequence_number,
  :timestamp)
  include Aws::Structure
end

#stream_nameString

The name of the Amazon Kinesis stream.

Returns:

  • (String)


486
487
488
489
490
491
492
493
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 486

class GetShardIteratorInput < Struct.new(
  :stream_name,
  :shard_id,
  :shard_iterator_type,
  :starting_sequence_number,
  :timestamp)
  include Aws::Structure
end

#timestampTime

The timestamp of the data 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, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. If a record with this exact timestamp does not exist, the iterator returned is for the next (later) record. If the timestamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).

Returns:

  • (Time)


486
487
488
489
490
491
492
493
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 486

class GetShardIteratorInput < Struct.new(
  :stream_name,
  :shard_id,
  :shard_iterator_type,
  :starting_sequence_number,
  :timestamp)
  include Aws::Structure
end