describeJournalKinesisStream method

Future<DescribeJournalKinesisStreamResponse> describeJournalKinesisStream({
  1. required String ledgerName,
  2. required String streamId,
})

Returns detailed information about a given Amazon QLDB journal stream. The output includes the Amazon Resource Name (ARN), stream name, current status, creation time, and the parameters of your original stream creation request.

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<DescribeJournalKinesisStreamResponse> describeJournalKinesisStream({
  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: 'GET',
    requestUri:
        '/ledgers/${Uri.encodeComponent(ledgerName)}/journal-kinesis-streams/${Uri.encodeComponent(streamId)}',
    exceptionFnMap: _exceptionFns,
  );
  return DescribeJournalKinesisStreamResponse.fromJson(response);
}