Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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, the that shared is closed and can no
longer receive more data.
See: AWS API Reference for DescribeStream.
- describeStream :: Text -> DescribeStream
- data DescribeStream
- dsExclusiveStartShardId :: Lens' DescribeStream (Maybe Text)
- dsLimit :: Lens' DescribeStream (Maybe Natural)
- dsStreamARN :: Lens' DescribeStream Text
- describeStreamResponse :: Int -> DescribeStreamResponse
- data DescribeStreamResponse
- dsrsStreamDescription :: Lens' DescribeStreamResponse (Maybe StreamDescription)
- dsrsResponseStatus :: Lens' DescribeStreamResponse Int
Creating a Request
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:
data DescribeStream Source
Represents the input of a DescribeStream operation.
See: describeStream
smart constructor.
Request Lenses
dsExclusiveStartShardId :: Lens' DescribeStream (Maybe Text) Source
The shard ID of the first item that this operation will evaluate. Use
the value that was returned for LastEvaluatedShardId
in the previous
operation.
dsLimit :: Lens' DescribeStream (Maybe Natural) Source
The maximum number of shard objects to return. The upper limit is 100.
dsStreamARN :: Lens' DescribeStream Text Source
The Amazon Resource Name (ARN) for the stream.
Destructuring the Response
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:
data DescribeStreamResponse Source
Represents the output of a DescribeStream operation.
See: describeStreamResponse
smart constructor.
Response Lenses
dsrsStreamDescription :: Lens' DescribeStreamResponse (Maybe StreamDescription) Source
A complete description of the stream, including its creation date and time, the DynamoDB table associated with the stream, the shard IDs within the stream, and the beginning and ending sequence numbers of stream records within the shards.
dsrsResponseStatus :: Lens' DescribeStreamResponse Int Source
The response status code.