| Copyright | (c) 2013-2021 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 |
Amazonka.QLDB.DescribeJournalKinesisStream
Description
Returns detailed information about a given Amazon QLDB journal stream. The output includes the Amazon Resource Name (ARN), stream name, current status, creation time, and the parameters of the original stream creation request.
This action does not return any expired journal streams. For more information, see Expiration for terminal streams in the Amazon QLDB Developer Guide.
Synopsis
- data DescribeJournalKinesisStream = DescribeJournalKinesisStream' {
- ledgerName :: Text
- streamId :: Text
- newDescribeJournalKinesisStream :: Text -> Text -> DescribeJournalKinesisStream
- describeJournalKinesisStream_ledgerName :: Lens' DescribeJournalKinesisStream Text
- describeJournalKinesisStream_streamId :: Lens' DescribeJournalKinesisStream Text
- data DescribeJournalKinesisStreamResponse = DescribeJournalKinesisStreamResponse' {}
- newDescribeJournalKinesisStreamResponse :: Int -> DescribeJournalKinesisStreamResponse
- describeJournalKinesisStreamResponse_stream :: Lens' DescribeJournalKinesisStreamResponse (Maybe JournalKinesisStreamDescription)
- describeJournalKinesisStreamResponse_httpStatus :: Lens' DescribeJournalKinesisStreamResponse Int
Creating a Request
data DescribeJournalKinesisStream Source #
See: newDescribeJournalKinesisStream smart constructor.
Constructors
| DescribeJournalKinesisStream' | |
Fields
| |
Instances
newDescribeJournalKinesisStream Source #
Arguments
| :: Text | |
| -> Text | |
| -> DescribeJournalKinesisStream |
Create a value of DescribeJournalKinesisStream 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:ledgerName:DescribeJournalKinesisStream', describeJournalKinesisStream_ledgerName - The name of the ledger.
$sel:streamId:DescribeJournalKinesisStream', describeJournalKinesisStream_streamId - The UUID (represented in Base62-encoded text) of the QLDB journal stream
to describe.
Request Lenses
describeJournalKinesisStream_ledgerName :: Lens' DescribeJournalKinesisStream Text Source #
The name of the ledger.
describeJournalKinesisStream_streamId :: Lens' DescribeJournalKinesisStream Text Source #
The UUID (represented in Base62-encoded text) of the QLDB journal stream to describe.
Destructuring the Response
data DescribeJournalKinesisStreamResponse Source #
See: newDescribeJournalKinesisStreamResponse smart constructor.
Constructors
| DescribeJournalKinesisStreamResponse' | |
Fields
| |
Instances
newDescribeJournalKinesisStreamResponse Source #
Arguments
| :: Int | |
| -> DescribeJournalKinesisStreamResponse |
Create a value of DescribeJournalKinesisStreamResponse 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:stream:DescribeJournalKinesisStreamResponse', describeJournalKinesisStreamResponse_stream - Information about the QLDB journal stream returned by a
DescribeJournalS3Export request.
$sel:httpStatus:DescribeJournalKinesisStreamResponse', describeJournalKinesisStreamResponse_httpStatus - The response's http status code.
Response Lenses
describeJournalKinesisStreamResponse_stream :: Lens' DescribeJournalKinesisStreamResponse (Maybe JournalKinesisStreamDescription) Source #
Information about the QLDB journal stream returned by a
DescribeJournalS3Export request.
describeJournalKinesisStreamResponse_httpStatus :: Lens' DescribeJournalKinesisStreamResponse Int Source #
The response's http status code.