AWS SDK for .NET Documentation
DescribeStreamRequest Class
AmazonAmazon.Kinesis.ModelDescribeStreamRequest Did this page help you?   Yes   No    Tell us about it...
Container for the parameters to the DescribeStream operation.

This operation returns the following information about the stream: the current status of the stream, the stream Amazon Resource Name (ARN), and an array of shard objects that comprise the stream. 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 a MergeShards or SplitShard operation that created the shard. A sequence number is the identifier associated with every record ingested in the Amazon Kinesis stream. The sequence number is assigned by the Amazon Kinesis service 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.

If there are more shards available, you can request more shards by using the shard ID of the last shard returned by the DescribeStream request, in the ExclusiveStartShardId parameter in a subsequent request to DescribeStream . DescribeStream is a paginated operation.

DescribeStream has a limit of 10 transactions per second per account.

Declaration Syntax
C#
public class DescribeStreamRequest : AmazonWebServiceRequest
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
DescribeStreamRequest()()()()
Initializes a new instance of the DescribeStreamRequest class

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
ExclusiveStartShardId
The shard ID of the shard to start with for the stream description.

Constraints:

Length
1 - 128
Pattern
[a-zA-Z0-9_.-]+


GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
Limit
The maximum number of shards to return.

Constraints:

Range
1 - 10000


StreamName
The name of the stream to describe.

Constraints:

Length
1 - 128
Pattern
[a-zA-Z0-9_.-]+


ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
WithExclusiveStartShardId(String) Obsolete.
Sets the ExclusiveStartShardId property

WithLimit(Int32) Obsolete.
Sets the Limit property

WithStreamName(String) Obsolete.
Sets the StreamName property

Inheritance Hierarchy
Object
AmazonWebServiceRequest
 DescribeStreamRequest
See Also

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)