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

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 StartingPosition data as a hash:

{
  type: "AT_SEQUENCE_NUMBER", # required, accepts AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER, TRIM_HORIZON, LATEST, AT_TIMESTAMP
  sequence_number: "SequenceNumber",
  timestamp: Time.now,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#sequence_numberString

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)


2012
2013
2014
2015
2016
2017
2018
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2012

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

#timestampTime

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)


2012
2013
2014
2015
2016
2017
2018
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2012

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

#typeString

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)


2012
2013
2014
2015
2016
2017
2018
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2012

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