Class: Aws::Kinesis::Types::StartingPosition

Inherits:

Struct

• Object
• Struct
• Aws::Kinesis::Types::StartingPosition

Defined in:

gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb

Overview

The starting position in the data stream from which to start streaming.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #sequence_number ⇒ String

  The sequence number of the data record in the shard from which to start streaming.

• #timestamp ⇒ Time

  The time stamp of the data record from which to start reading.

• #type ⇒ String

  You can set the starting position to one of the following values:.

Instance Attribute Details

#sequence_number ⇒ String

The sequence number of the data record in the shard from which to start streaming. To specify a sequence number, set StartingPosition to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER.

Returns:

• (String)

# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 3195

class StartingPosition < Struct.new(
  :type,
  :sequence_number,
  :timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#timestamp ⇒ Time

The time stamp of the data record from which to start reading. To specify a time stamp, set StartingPosition to Type AT_TIMESTAMP. A time stamp 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 time stamp does not exist, records will be streamed from the next (later) record. If the time stamp is older than the current trim horizon, records will be streamed from the oldest untrimmed data record (TRIM_HORIZON).

Returns:

• (Time)

# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 3195

class StartingPosition < Struct.new(
  :type,
  :sequence_number,
  :timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

You can set the starting position to one of the following values:

AT_SEQUENCE_NUMBER: Start streaming from the position denoted by the sequence number specified in the SequenceNumber field.

AFTER_SEQUENCE_NUMBER: Start streaming right after the position denoted by the sequence number specified in the SequenceNumber field.

AT_TIMESTAMP: Start streaming from the position denoted by the time stamp specified in the Timestamp field.

TRIM_HORIZON: Start streaming at the last untrimmed record in the shard, which is the oldest data record in the shard.

LATEST: Start streaming just after the most recent record in the shard, so that you always read the most recent data in the shard.

Returns:

• (String)

# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 3195

class StartingPosition < Struct.new(
  :type,
  :sequence_number,
  :timestamp)
  SENSITIVE = []
  include Aws::Structure
end