Skip to contents

Gets an Amazon Kinesis shard iterator

Source: R/kinesis_operations.R
kinesis_get_shard_iterator.Rd

Gets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after it is returned to the requester.

See https://www.paws-r-sdk.com/docs/kinesis_get_shard_iterator/ for full documentation.

Usage

kinesis_get_shard_iterator(
  StreamName = NULL,
  ShardId,
  ShardIteratorType,
  StartingSequenceNumber = NULL,
  Timestamp = NULL,
  StreamARN = NULL,
  StreamId = NULL
)

Arguments

StreamName

The name of the Amazon Kinesis data stream.

ShardId

[required] The shard ID of the Kinesis Data Streams shard to get the iterator for.

ShardIteratorType

[required] 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 time stamp, 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.

StartingSequenceNumber

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.

Timestamp

The time stamp of the data record from which to start reading. Used with shard iterator 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, the iterator returned is for the next (later) record. If the time stamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).

StreamARN

The ARN of the stream.

StreamId

Not Implemented. Reserved for future use.