Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Network.AWS.Kinesis.DescribeStreamSummary
Description
Provides a summarized description of the specified Kinesis data stream without the shard list.
The information returned includes the stream name, Amazon Resource Name (ARN), status, record retention period, approximate creation time, monitoring, encryption details, and open shard count.
- describeStreamSummary :: Text -> DescribeStreamSummary
- data DescribeStreamSummary
- dssStreamName :: Lens' DescribeStreamSummary Text
- describeStreamSummaryResponse :: Int -> StreamDescriptionSummary -> DescribeStreamSummaryResponse
- data DescribeStreamSummaryResponse
- dssrsResponseStatus :: Lens' DescribeStreamSummaryResponse Int
- dssrsStreamDescriptionSummary :: Lens' DescribeStreamSummaryResponse StreamDescriptionSummary
Creating a Request
Arguments
:: Text | |
-> DescribeStreamSummary |
Creates a value of DescribeStreamSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dssStreamName
- The name of the stream to describe.
data DescribeStreamSummary #
See: describeStreamSummary
smart constructor.
Instances
Request Lenses
dssStreamName :: Lens' DescribeStreamSummary Text #
The name of the stream to describe.
Destructuring the Response
describeStreamSummaryResponse #
Arguments
:: Int | |
-> StreamDescriptionSummary | |
-> DescribeStreamSummaryResponse |
Creates a value of DescribeStreamSummaryResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dssrsResponseStatus
- -- | The response status code.dssrsStreamDescriptionSummary
- AStreamDescriptionSummary
containing information about the stream.
data DescribeStreamSummaryResponse #
See: describeStreamSummaryResponse
smart constructor.
Response Lenses
dssrsResponseStatus :: Lens' DescribeStreamSummaryResponse Int #
- - | The response status code.
dssrsStreamDescriptionSummary :: Lens' DescribeStreamSummaryResponse StreamDescriptionSummary #
A StreamDescriptionSummary
containing information about the stream.