amazonka-kinesis-1.3.3: Amazon Kinesis SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <>
Portabilitynon-portable (GHC extensions)
Safe HaskellNone




Describes the specified stream.

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.

See: AWS API Reference for DescribeStream.

This operation returns paginated results.


Creating a Request

describeStream Source

Creates a value of DescribeStream with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Request Lenses

dExclusiveStartShardId :: Lens' DescribeStream (Maybe Text) Source

The shard ID of the shard to start with.

dLimit :: Lens' DescribeStream (Maybe Natural) Source

The maximum number of shards to return.

dStreamName :: Lens' DescribeStream Text Source

The name of the stream to describe.

Destructuring the Response

describeStreamResponse Source

Creates a value of DescribeStreamResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Response Lenses

dsrsStreamDescription :: Lens' DescribeStreamResponse StreamDescription Source

The current status of the stream, the stream ARN, an array of shard objects that comprise the stream, and states whether there are more shards available.