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.
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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.DynamoDBv2.AmazonDynamoDBStreamsRequest
Amazon.DynamoDBv2.Model.DescribeStreamRequest
Namespace: Amazon.DynamoDBv2.Model
Assembly: AWSSDK.DynamoDBv2.dll
Version: 3.x.y.z
Syntax
public class DescribeStreamRequest : AmazonDynamoDBStreamsRequest IAmazonWebServiceRequest
The DescribeStreamRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
DescribeStreamRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
ExclusiveStartShardId | System.String |
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 |
|
|
Limit | System.Int32 |
Gets and sets the property Limit. The maximum number of shard objects to return. The upper limit is 100. |
|
|
StreamArn | System.String |
Gets and sets the property StreamArn. The Amazon Resource Name (ARN) for the stream. |
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5