cancel_journal_kinesis_stream

cancel_journal_kinesis_stream(**kwargs)

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

Request Syntax

response = client.cancel_journal_kinesis_stream(
    LedgerName='string',
    StreamId='string'
)

Parameters

• LedgerName (string) --

  [REQUIRED]

  The name of the ledger.

• StreamId (string) --

  [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'StreamId': 'string'
}

Response Structure

• (dict) --

  • StreamId (string) --

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

Exceptions

• QLDB.Client.exceptions.InvalidParameterException
• QLDB.Client.exceptions.ResourceNotFoundException
• QLDB.Client.exceptions.ResourcePreconditionNotMetException