aws kinesis get-shard-iterator

Gets an Amazon Kinesis shard iterator. AWS CLI reference

1 example 8 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To obtain a shard iterator

The following get-shard-iterator example uses the AT_SEQUENCE_NUMBER shard iterator type and generates a shard iterator to start reading data records exactly from the position denoted by the specified sequence number.

aws kinesis get-shard-iterator --stream-name samplestream --shard-id shardId-000000000001 --shard-iterator-type LATESTIdentify

--stream-nameThe name of the Amazon Kinesis data stream.

--shard-idThe shard ID of the Kinesis Data Streams shard to get the iterator for.

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

Its output

{
    "ShardIterator": "AAAAAAAAAAFEvJjIYI+3jw/4aqgH9FifJ+n48XWTh/IFIsbILP6o5eDueD39NXNBfpZ10WL5K6ADXk8w+5H+Qhd9cFA9k268CPXCz/kebq1TGYI7Vy+lUkA9BuN3xvATxMBGxRY3zYK05gqgvaIRn94O8SqeEqwhigwZxNWxID3Ej7YYYcxQi8Q/fIrCjGAy/n2r5Z9G864YpWDfN9upNNQAR/iiOWKs"
}

For more information, see Developing Consumers Using the Kinesis Data Streams API with the AWS SDK for Java in the Amazon Kinesis Data Streams Developer Guide.

Options

8 in the AWS CLI reference

--dry-runChecks if your request will succeed.

--shard-idThe shard ID of the Kinesis Data Streams shard to get the iterator for.

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

--starting-sequence-numberThe sequence number of the data record in the shard from which to start reading.

--stream-arnThe ARN of the stream.

--stream-idNot Implemented.

--stream-nameThe name of the Amazon Kinesis data stream.

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