| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Kinesis.DescribeStreamSummary
Description
Provides a summarized description of the specified Kinesis data stream without the shard list.
When invoking this API, it is recommended you use the StreamARN input
parameter rather than the StreamName input parameter.
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 has a limit of 20 transactions per second per account.
Synopsis
- data DescribeStreamSummary = DescribeStreamSummary' {}
- newDescribeStreamSummary :: DescribeStreamSummary
- describeStreamSummary_streamARN :: Lens' DescribeStreamSummary (Maybe Text)
- describeStreamSummary_streamName :: Lens' DescribeStreamSummary (Maybe Text)
- data DescribeStreamSummaryResponse = DescribeStreamSummaryResponse' {}
- newDescribeStreamSummaryResponse :: Int -> StreamDescriptionSummary -> DescribeStreamSummaryResponse
- describeStreamSummaryResponse_httpStatus :: Lens' DescribeStreamSummaryResponse Int
- describeStreamSummaryResponse_streamDescriptionSummary :: Lens' DescribeStreamSummaryResponse StreamDescriptionSummary
Creating a Request
data DescribeStreamSummary Source #
See: newDescribeStreamSummary smart constructor.
Constructors
| DescribeStreamSummary' | |
Instances
newDescribeStreamSummary :: DescribeStreamSummary Source #
Create a value of DescribeStreamSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeStreamSummary, describeStreamSummary_streamARN - The ARN of the stream.
DescribeStreamSummary, describeStreamSummary_streamName - The name of the stream to describe.
Request Lenses
describeStreamSummary_streamARN :: Lens' DescribeStreamSummary (Maybe Text) Source #
The ARN of the stream.
describeStreamSummary_streamName :: Lens' DescribeStreamSummary (Maybe Text) Source #
The name of the stream to describe.
Destructuring the Response
data DescribeStreamSummaryResponse Source #
See: newDescribeStreamSummaryResponse smart constructor.
Constructors
| DescribeStreamSummaryResponse' | |
Fields
| |
Instances
newDescribeStreamSummaryResponse Source #
Arguments
| :: Int | |
| -> StreamDescriptionSummary |
|
| -> DescribeStreamSummaryResponse |
Create a value of DescribeStreamSummaryResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeStreamSummaryResponse', describeStreamSummaryResponse_httpStatus - The response's http status code.
$sel:streamDescriptionSummary:DescribeStreamSummaryResponse', describeStreamSummaryResponse_streamDescriptionSummary - A StreamDescriptionSummary containing information about the stream.
Response Lenses
describeStreamSummaryResponse_httpStatus :: Lens' DescribeStreamSummaryResponse Int Source #
The response's http status code.
describeStreamSummaryResponse_streamDescriptionSummary :: Lens' DescribeStreamSummaryResponse StreamDescriptionSummary Source #
A StreamDescriptionSummary containing information about the stream.