Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . qldb ]



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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--ledger-name <value>
--stream-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--ledger-name (string)

The name of the ledger.

--stream-id (string)

The UUID (represented in Base62-encoded text) of the QLDB journal stream to be canceled.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


To cancel a journal stream

The following cancel-journal-kinesis-stream example cancels the specified journal stream from a ledger.

aws qldb cancel-journal-kinesis-stream \
    --ledger-name myExampleLedger \
    --stream-id 7ISCkqwe4y25YyHLzYUFAf


    "StreamId": "7ISCkqwe4y25YyHLzYUFAf"

For more information, see Streaming journal data from Amazon QLDB in the Amazon QLDB Developer Guide.


StreamId -> (string)

The UUID (Base62-encoded text) of the canceled QLDB journal stream.