listJobsByStatus method

Future<ListJobsByStatusResponse> listJobsByStatus({ required String status, String? ascending, String? pageToken, })

The ListJobsByStatus operation gets a list of jobs that have a specified status. The response body contains one element for each job that satisfies the search criteria.

May throw ValidationException. May throw IncompatibleVersionException. May throw ResourceNotFoundException. May throw AccessDeniedException. May throw InternalServiceException.

Parameter status : To get information about all of the jobs associated with the current AWS account that have a given status, specify the following status: Submitted, Progressing, Complete, Canceled, or Error.

Parameter ascending : To list jobs in chronological order by the date and time that they were submitted, enter true. To list jobs in reverse chronological order, enter false.

Parameter pageToken : When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

Implementation

Future<ListJobsByStatusResponse> listJobsByStatus({
  required String status,
  String? ascending,
  String? pageToken,
}) async {
  ArgumentError.checkNotNull(status, 'status');
  final $query = <String, List<String>>{
    if (ascending != null) 'Ascending': [ascending],
    if (pageToken != null) 'PageToken': [pageToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/2012-09-25/jobsByStatus/${Uri.encodeComponent(status)}',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListJobsByStatusResponse.fromJson(response);
}