Cancel Journal Kinesis Stream

qldb_cancel_journal_kinesis_stream

R Documentation

Ends a given Amazon QLDB journal stream¶

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.

Usage¶

qldb_cancel_journal_kinesis_stream(LedgerName, StreamId)

Arguments¶

LedgerName

[required] The name of the ledger.

StreamId

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

Value¶

A list with the following syntax:

list(
  StreamId = "string"
)

Request syntax¶

svc$cancel_journal_kinesis_stream(
  LedgerName = "string",
  StreamId = "string"
)