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 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.

Note:

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

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

Syntax

C#
public virtual DescribeStreamResponse DescribeStream(
         String streamArn
)

Parameters

streamArn
Type: System.String

The Amazon Resource Name (ARN) for the stream.

Return Value


The response from the DescribeStream 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.

Version Information

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

See Also