Table of Contents

Class GetShardIteratorRequest

Namespace
Amazon.DynamoDBv2.Model
Assembly
AWSSDK.DynamoDBv2.dll

Container for the parameters to the GetShardIterator operation. Returns a shard iterator. A shard iterator provides information about how to retrieve the stream records from within a shard. Use the shard iterator in a subsequent 

GetRecords
request to read the stream records from the shard.
note

A shard iterator expires 15 minutes after it is returned to the requester. 

public class GetShardIteratorRequest : AmazonDynamoDBStreamsRequest
Inheritance
GetShardIteratorRequest

Constructors

GetShardIteratorRequest() 

public GetShardIteratorRequest()

Properties

SequenceNumber

Gets and sets the property SequenceNumber.

The sequence number of a stream record in the shard from which to start reading. 

public string SequenceNumber { get; set; }

Property Value

string

ShardId

Gets and sets the property ShardId.

The identifier of the shard. The iterator will be returned for this shard ID. 

public string ShardId { get; set; }

Property Value

string

ShardIteratorType

Gets and sets the property ShardIteratorType.

Determines how the shard iterator is used to start reading stream records from the shard: 

  • 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) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. 

  • LATEST
    - Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard. 
public ShardIteratorType ShardIteratorType { get; set; }

Property Value

ShardIteratorType

StreamArn

Gets and sets the property StreamArn.

The Amazon Resource Name (ARN) for the stream. 

public string StreamArn { get; set; }

Property Value

string