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.

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to GetShardIteratorAsync.

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

Syntax

C#
public virtual GetShardIteratorResponse GetShardIterator(
         GetShardIteratorRequest request
)

Parameters

request
Type: Amazon.DynamoDBv2.Model.GetShardIteratorRequest

Container for the necessary parameters to execute the GetShardIterator service method.

Return Value


The response from the GetShardIterator service method, as returned by DynamoDBStreams.

Exceptions

ExceptionCondition
InternalServerErrorException An error occurred on the server side.
ResourceNotFoundException The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
TrimmedDataAccessException The operation attempted to read past the oldest stream record in a 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. You might receive a TrimmedDataAccessException if: You request a shard iterator with a sequence number older than the trim point (24 hours). You obtain a shard iterator, but before you use the iterator in a GetRecords request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access a record that no longer exists.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

See Also