cancelJournalKinesisStream method

Future<CancelJournalKinesisStreamResponse> cancelJournalKinesisStream({ required String ledgerName, required String streamId, })

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.

May throw InvalidParameterException. May throw ResourceNotFoundException. May throw ResourcePreconditionNotMetException.

Parameter ledgerName : The name of the ledger.

Parameter streamId : The unique ID that QLDB assigns to each QLDB journal stream.

Implementation

Future<CancelJournalKinesisStreamResponse> cancelJournalKinesisStream({
  required String ledgerName,
  required String streamId,
}) async {
  ArgumentError.checkNotNull(ledgerName, 'ledgerName');
  _s.validateStringLength(
    'ledgerName',
    ledgerName,
    1,
    32,
    isRequired: true,
  );
  ArgumentError.checkNotNull(streamId, 'streamId');
  _s.validateStringLength(
    'streamId',
    streamId,
    22,
    22,
    isRequired: true,
  );
  final response = await _protocol.send(
    payload: null,
    method: 'DELETE',
    requestUri:
        '/ledgers/${Uri.encodeComponent(ledgerName)}/journal-kinesis-streams/${Uri.encodeComponent(streamId)}',
    exceptionFnMap: _exceptionFns,
  );
  return CancelJournalKinesisStreamResponse.fromJson(response);
}