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.
For PCL and Unity this operation is only available in asynchronous form. Please refer to GetShardIteratorAsync.
public abstract GetShardIteratorResponse GetShardIterator( GetShardIteratorRequest request )
Container for the necessary parameters to execute the GetShardIterator service method.
|InvalidArgumentException||A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.|
|ProvisionedThroughputExceededException||The request rate for the stream is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Streams Limits in the Amazon Kinesis Streams Developer Guide, and Error Retries and Exponential Backoff in AWS in the AWS General Reference.|
|ResourceNotFoundException||The requested resource could not be found. The stream might not be specified correctly.|
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