Container for the parameters to the GetShardIterator operation. Gets an Amazon Kinesis shard iterator. A shard iterator expires five minutes after it is returned to the requester.
A shard iterator specifies the shard position from which to start reading data records sequentially. The position is specified using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the stream, and is assigned when a record is put into the stream. Each stream has one or more shards.
You must specify the shard iterator type. For example, you can set the
parameter to read exactly from the position denoted by a specific sequence number
by using the
AT_SEQUENCE_NUMBER shard iterator type, or right after the
sequence number by using the
AFTER_SEQUENCE_NUMBER shard iterator type,
using sequence numbers returned by earlier calls to PutRecord, PutRecords,
GetRecords, or DescribeStream. In the request, you can specify the shard
AT_TIMESTAMP to read records from an arbitrary point in
TRIM_HORIZON to cause
ShardIterator to point to the
last untrimmed record in the shard in the system (the oldest data record in the shard),
LATEST so that you always read the most recent data in the shard.
When you read repeatedly from a stream, use a GetShardIterator request to get
the first shard iterator for use in your first GetRecords request and for subsequent
reads use the shard iterator returned by the GetRecords request in
A new shard iterator is returned by every GetRecords request in
which you use in the
ShardIterator parameter of the next GetRecords
If a GetShardIterator request is made too often, you receive a
For more information about throughput limits, see GetRecords, and Streams
Limits in the Amazon Kinesis Streams Developer Guide.
GetShardIterator has a limit of 5 transactions per second per account per open shard.
public class GetShardIteratorRequest : AmazonKinesisRequest IAmazonWebServiceRequest
The GetShardIteratorRequest type exposes the following members
Gets and sets the property ShardId.
The shard ID of the Amazon Kinesis shard to get the iterator for.
Gets and sets the property ShardIteratorType.
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:
Gets and sets the property 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.
Gets and sets the property StreamName.
The name of the Amazon Kinesis stream.
Gets and sets the property Timestamp.
The timestamp of the data record from which to start reading. Used with shard iterator
type AT_TIMESTAMP. A timestamp is the Unix epoch date with precision in milliseconds.
Supported in: 1.3
Supported in: 4.5, 4.0, 3.5
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone