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
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
flag in the returned output.
HasMoreShards is set to
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
ExclusiveStartShardId parameter in a subsequent request to
DescribeStream has a limit of 10 transactions per second per account.
Version: (assembly version)
public virtual DescribeStreamResponse DescribeStream( DescribeStreamRequest request )
Container for the necessary parameters to execute the DescribeStream service method.
|LimitExceededException||The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5).|
|ResourceNotFoundException||The requested resource could not be found. The stream might not be specified correctly, or it might not be in the ACTIVE state if the operation requires it.|
Supported in: 4.5, 4.0, 3.5