listJournalKinesisStreamsForLedger method

Future<ListJournalKinesisStreamsForLedgerResponse> listJournalKinesisStreamsForLedger({ required String ledgerName, int? maxResults, String? nextToken, })

Returns an array of all Amazon QLDB journal stream descriptors for a given ledger. The output of each stream descriptor includes the same details that are returned by DescribeJournalKinesisStream.

This action returns a maximum of MaxResults items. It is paginated so that you can retrieve all the items by calling ListJournalKinesisStreamsForLedger multiple times.

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

Parameter ledgerName : The name of the ledger.

Parameter maxResults : The maximum number of results to return in a single ListJournalKinesisStreamsForLedger request. (The actual number of results returned might be fewer.)

Parameter nextToken : A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken in the response from a previous ListJournalKinesisStreamsForLedger call, you should use that value as input here.

Implementation

Future<ListJournalKinesisStreamsForLedgerResponse>
    listJournalKinesisStreamsForLedger({
  required String ledgerName,
  int? maxResults,
  String? nextToken,
}) async {
  ArgumentError.checkNotNull(ledgerName, 'ledgerName');
  _s.validateStringLength(
    'ledgerName',
    ledgerName,
    1,
    32,
    isRequired: true,
  );
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  _s.validateStringLength(
    'nextToken',
    nextToken,
    4,
    1024,
  );
  final $query = <String, List<String>>{
    if (maxResults != null) 'max_results': [maxResults.toString()],
    if (nextToken != null) 'next_token': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/ledgers/${Uri.encodeComponent(ledgerName)}/journal-kinesis-streams',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListJournalKinesisStreamsForLedgerResponse.fromJson(response);
}