kinesis_get_shard_iterator {paws.analytics} | R Documentation |
Gets an Amazon Kinesis shard iterator
Description
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
)
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:
|
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,
|
StreamARN |
The ARN of the stream. |