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 information about a stream, including the current status of the stream, its
Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB
table.
You can call DescribeStream
at a maximum rate of 10 times per second.
Each shard in the stream has a SequenceNumberRange
associated with it. If the
SequenceNumberRange
has a StartingSequenceNumber
but no EndingSequenceNumber
,
then the shard is still open (able to receive more stream records). If both StartingSequenceNumber
and EndingSequenceNumber
are present, then that shard is closed and can no
longer receive more data.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDescribeStream and EndDescribeStream.
Namespace: Amazon.DynamoDBv2
Assembly: AWSSDK.DynamoDBv2.dll
Version: 3.x.y.z
public abstract Task<DescribeStreamResponse> DescribeStreamAsync( DescribeStreamRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the DescribeStream service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Exception | Condition |
---|---|
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. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer