AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.DynamoDBv2.AmazonDynamoDBStreamsRequest
      Amazon.DynamoDBv2.Model.GetShardIteratorRequest

Namespace: Amazon.DynamoDBv2.Model
Assembly: AWSSDK.DynamoDBv2.dll
Version: 3.x.y.z

Syntax

C# 
public class GetShardIteratorRequest : AmazonDynamoDBStreamsRequest
         IAmazonWebServiceRequest

The GetShardIteratorRequest type exposes the following members

Constructors

NameDescription
Public Method GetShardIteratorRequest()

Properties

NameTypeDescription
Public Property SequenceNumber System.String

Gets and sets the property SequenceNumber.

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

Public Property ShardId System.String

Gets and sets the property ShardId.

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

Public Property ShardIteratorType Amazon.DynamoDBv2.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 Property StreamArn System.String

Gets and sets the property StreamArn.

The Amazon Resource Name (ARN) for the stream.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5