Class DescribeStreamRequest

Namespace

Amazon.DynamoDBv2.Model

Assembly

AWSSDK.DynamoDBv2.dll

Container for the parameters to the DescribeStream operation. 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.

note

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.

public class DescribeStreamRequest : AmazonDynamoDBStreamsRequest

Inheritance

object

AmazonDynamoDBStreamsRequest

DescribeStreamRequest

Constructors

DescribeStreamRequest()

public DescribeStreamRequest()

Properties

ExclusiveStartShardId

Gets and sets the property ExclusiveStartShardId.

The shard ID of the first item that this operation will evaluate. Use the value that was returned for

LastEvaluatedShardId

in the previous operation.

public string ExclusiveStartShardId { get; set; }

Property Value

string

Limit

Gets and sets the property Limit.

The maximum number of shard objects to return. The upper limit is 100.

public int Limit { get; set; }

Property Value

int

StreamArn

Gets and sets the property StreamArn.

The Amazon Resource Name (ARN) for the stream.

public string StreamArn { get; set; }

Property Value

string