describeJournalS3Export method

Future<DescribeJournalS3ExportResponse> describeJournalS3Export({ required String exportId, required String name, })

Returns information about a journal export job, including the ledger name, export ID, when it was created, current status, and its start and end time export parameters.

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

If the export job with the given ExportId doesn't exist, then throws ResourceNotFoundException.

If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException.

May throw ResourceNotFoundException.

Parameter exportId : The unique ID of the journal export job that you want to describe.

Parameter name : The name of the ledger.

Implementation

Future<DescribeJournalS3ExportResponse> describeJournalS3Export({
  required String exportId,
  required String name,
}) async {
  ArgumentError.checkNotNull(exportId, 'exportId');
  _s.validateStringLength(
    'exportId',
    exportId,
    22,
    22,
    isRequired: true,
  );
  ArgumentError.checkNotNull(name, 'name');
  _s.validateStringLength(
    'name',
    name,
    1,
    32,
    isRequired: true,
  );
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/ledgers/${Uri.encodeComponent(name)}/journal-s3-exports/${Uri.encodeComponent(exportId)}',
    exceptionFnMap: _exceptionFns,
  );
  return DescribeJournalS3ExportResponse.fromJson(response);
}