describeExportTasks method

Future<ExportTasksMessage> describeExportTasks({
  1. String? exportTaskIdentifier,
  2. List<Filter>? filters,
  3. String? marker,
  4. int? maxRecords,
  5. String? sourceArn,
})

Returns information about a snapshot export to Amazon S3. This API operation supports pagination.

May throw ExportTaskNotFoundFault.

Parameter exportTaskIdentifier : The identifier of the snapshot export task to be described.

Parameter filters : Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.

Supported filters include the following:

  • export-task-identifier - An identifier for the snapshot export task.
  • s3-bucket - The Amazon S3 bucket the snapshot is exported to.
  • source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3
  • status - The status of the export task. Must be lowercase, for example, complete.

Parameter marker : An optional pagination token provided by a previous DescribeExportTasks request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

Parameter maxRecords : The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later DescribeExportTasks request to retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Parameter sourceArn : The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

Implementation

Future<ExportTasksMessage> describeExportTasks({
  String? exportTaskIdentifier,
  List<Filter>? filters,
  String? marker,
  int? maxRecords,
  String? sourceArn,
}) async {
  _s.validateNumRange(
    'maxRecords',
    maxRecords,
    20,
    100,
  );
  final $request = <String, dynamic>{};
  exportTaskIdentifier?.also((arg) => $request['ExportTaskIdentifier'] = arg);
  filters?.also((arg) => $request['Filters'] = arg);
  marker?.also((arg) => $request['Marker'] = arg);
  maxRecords?.also((arg) => $request['MaxRecords'] = arg);
  sourceArn?.also((arg) => $request['SourceArn'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeExportTasks',
    version: '2014-10-31',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeExportTasksMessage'],
    shapes: shapes,
    resultWrapper: 'DescribeExportTasksResult',
  );
  return ExportTasksMessage.fromXml($result);
}