listJournalS3ExportsForLedger method

Future<ListJournalS3ExportsForLedgerResponse> listJournalS3ExportsForLedger({ required String name, int? maxResults, String? nextToken, })

Returns an array of journal export job descriptions for a specified ledger.

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

This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer Guide.

Parameter name : The name of the ledger.

Parameter maxResults : The maximum number of results to return in a single ListJournalS3ExportsForLedger 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 ListJournalS3ExportsForLedger call, then you should use that value as input here.

Implementation

Future<ListJournalS3ExportsForLedgerResponse> listJournalS3ExportsForLedger({
  required String name,
  int? maxResults,
  String? nextToken,
}) async {
  ArgumentError.checkNotNull(name, 'name');
  _s.validateStringLength(
    'name',
    name,
    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(name)}/journal-s3-exports',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListJournalS3ExportsForLedgerResponse.fromJson(response);
}