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.
The information about the stream includes its current status, its Amazon Resource Name (ARN), and an array of shard objects. For each shard object, there is information about the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. A sequence number is the identifier associated with every record ingested in the Amazon Kinesis stream. The sequence number is assigned when a record is put into the stream.
You can limit the number of returned shards using the Limit
parameter.
The number of shards in a stream may be too large to return from a single call to
DescribeStream
. You can detect this by using the HasMoreShards
flag in the returned output. HasMoreShards
is set to true
when there is more data available.
DescribeStream
is a paginated operation. If there are more shards available,
you can request them using the shard ID of the last shard returned. Specify this ID
in the ExclusiveStartShardId
parameter in a subsequent request to DescribeStream
.
DescribeStream has a limit of 10 transactions per second per account.
Namespace: Amazon.Kinesis.Model
Assembly: AWSSDK.dll
Version: (assembly version)
public class DescribeStreamRequest : AmazonKinesisRequest IRequestEvents
The DescribeStreamRequest type exposes the following members
Name | Description | |
---|---|---|
DescribeStreamRequest() |
Name | Type | Description | |
---|---|---|---|
ExclusiveStartShardId | System.String |
Gets and sets the property ExclusiveStartShardId.
The shard ID of the shard to start with. |
|
Limit | System.Int32 |
Gets and sets the property Limit.
The maximum number of shards to return. |
|
StreamName | System.String |
Gets and sets the property StreamName.
The name of the stream to describe. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8
.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8