Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.DescribeStreamAsync C# (CSharp) Method

AmazonDynamoDBStreamsClient Class Documentation Show file Open project: aws/aws-sdk-net

DescribeStreamAsync() public method

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.

/// An error occurred on the server side. /// /// The operation tried to access a nonexistent stream. ///

public DescribeStreamAsync ( string streamArn, System cancellationToken = default(CancellationToken) ) : Task
streamArn	string	The Amazon Resource Name (ARN) for the stream.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
return	Task

        public Task<DescribeStreamResponse> DescribeStreamAsync(string streamArn, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
        {
            var request = new DescribeStreamRequest();
            request.StreamArn = streamArn;
            return DescribeStreamAsync(request, cancellationToken);
        }