AWS SDK for .NET Documentation
GetShardIteratorRequest Class
AmazonAmazon.Kinesis.ModelGetShardIteratorRequest Did this page help you?   Yes   No    Tell us about it...
Container for the parameters to the GetShardIterator operation.

This operation returns a shard iterator in ShardIterator . The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. A shard iterator specifies this position using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the Amazon Kinesis stream. The sequence number is assigned by the Amazon Kinesis service when a record is put into the stream.

You must specify the shard iterator type in the GetShardIterator request. For example, you can set the ShardIteratorType 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 PutRecord, GetRecords or DescribeStream requests. You can specify the shard iterator type TRIM_HORIZON in the request to cause ShardIterator to point to the last untrimmed record in the shard in the system, which is the oldest data record in the shard. Or you can point to just after the most recent record in the shard, by using the shard iterator type LATEST, so that you always read the most recent data in the shard.

Note: Each shard iterator expires five minutes after it is returned to the requester.

When you repeatedly read from an Amazon Kinesis stream use a GetShardIterator request to get the first shard iterator to to use in your first GetRecords request and then use the shard iterator returned by the GetRecords request in NextShardIterator for subsequent reads. A new shard iterator is returned by every GetRecords request in NextShardIterator , which you use in the ShardIterator parameter of the next GetRecords request.

If a GetShardIterator request is made too often, you will receive a ProvisionedThroughputExceededException . For more information about throughput limits, see the Amazon Kinesis Developer Guide .

GetShardIterator can return null for its ShardIterator to indicate that the shard has been closed and that the requested iterator will return no more data. A shard can be closed by a SplitShard or MergeShards operation.

GetShardIterator has a limit of 5 transactions per second per account per open shard.

Declaration Syntax
C#
public class GetShardIteratorRequest : AmazonWebServiceRequest
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
GetShardIteratorRequest()()()()
Initializes a new instance of the GetShardIteratorRequest class

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
ShardId
The shard ID of the shard to get the iterator for.

Constraints:

Length
1 - 128
Pattern
[a-zA-Z0-9_.-]+


ShardIteratorType
Determines how the shard iterator is used to start reading data records from the shard. The following are the valid shard iterator types:
  • AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.
  • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.
  • 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.

Constraints:

Allowed Values
AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER, TRIM_HORIZON, LATEST


StartingSequenceNumber
The sequence number of the data record in the shard from which to start reading from.

Constraints:

Pattern
0|([1-9]\d{0,128})


StreamName
The name of the stream.

Constraints:

Length
1 - 128
Pattern
[a-zA-Z0-9_.-]+


ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
WithShardId(String) Obsolete.
Sets the ShardId property

WithShardIteratorType(String) Obsolete.
Sets the ShardIteratorType property

WithStartingSequenceNumber(String) Obsolete.
Sets the StartingSequenceNumber property

WithStreamName(String) Obsolete.
Sets the StreamName property

Inheritance Hierarchy
Object
AmazonWebServiceRequest
 GetShardIteratorRequest
See Also

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)