| 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.CancelJournalKinesisStream
Description
Ends a given Amazon QLDB journal stream. Before a stream can be
canceled, its current status must be ACTIVE.
You can't restart a stream after you cancel it. Canceled QLDB stream resources are subject to a 7-day retention period, so they are automatically deleted after this limit expires.
Synopsis
- data CancelJournalKinesisStream = CancelJournalKinesisStream' {
- ledgerName :: Text
- streamId :: Text
- newCancelJournalKinesisStream :: Text -> Text -> CancelJournalKinesisStream
- cancelJournalKinesisStream_ledgerName :: Lens' CancelJournalKinesisStream Text
- cancelJournalKinesisStream_streamId :: Lens' CancelJournalKinesisStream Text
- data CancelJournalKinesisStreamResponse = CancelJournalKinesisStreamResponse' {
- streamId :: Maybe Text
- httpStatus :: Int
- newCancelJournalKinesisStreamResponse :: Int -> CancelJournalKinesisStreamResponse
- cancelJournalKinesisStreamResponse_streamId :: Lens' CancelJournalKinesisStreamResponse (Maybe Text)
- cancelJournalKinesisStreamResponse_httpStatus :: Lens' CancelJournalKinesisStreamResponse Int
Creating a Request
data CancelJournalKinesisStream Source #
See: newCancelJournalKinesisStream smart constructor.
Constructors
| CancelJournalKinesisStream' | |
Fields
| |
Instances
newCancelJournalKinesisStream Source #
Arguments
| :: Text | |
| -> Text | |
| -> CancelJournalKinesisStream |
Create a value of CancelJournalKinesisStream 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:CancelJournalKinesisStream', cancelJournalKinesisStream_ledgerName - The name of the ledger.
$sel:streamId:CancelJournalKinesisStream', cancelJournalKinesisStream_streamId - The UUID (represented in Base62-encoded text) of the QLDB journal stream
to be canceled.
Request Lenses
cancelJournalKinesisStream_ledgerName :: Lens' CancelJournalKinesisStream Text Source #
The name of the ledger.
cancelJournalKinesisStream_streamId :: Lens' CancelJournalKinesisStream Text Source #
The UUID (represented in Base62-encoded text) of the QLDB journal stream to be canceled.
Destructuring the Response
data CancelJournalKinesisStreamResponse Source #
See: newCancelJournalKinesisStreamResponse smart constructor.
Constructors
| CancelJournalKinesisStreamResponse' | |
Fields
| |
Instances
newCancelJournalKinesisStreamResponse Source #
Arguments
| :: Int | |
| -> CancelJournalKinesisStreamResponse |
Create a value of CancelJournalKinesisStreamResponse 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:streamId:CancelJournalKinesisStream', cancelJournalKinesisStreamResponse_streamId - The UUID (Base62-encoded text) of the canceled QLDB journal stream.
$sel:httpStatus:CancelJournalKinesisStreamResponse', cancelJournalKinesisStreamResponse_httpStatus - The response's http status code.
Response Lenses
cancelJournalKinesisStreamResponse_streamId :: Lens' CancelJournalKinesisStreamResponse (Maybe Text) Source #
The UUID (Base62-encoded text) of the canceled QLDB journal stream.
cancelJournalKinesisStreamResponse_httpStatus :: Lens' CancelJournalKinesisStreamResponse Int Source #
The response's http status code.