listMedicalTranscriptionJobs method

Future<ListMedicalTranscriptionJobsResponse> listMedicalTranscriptionJobs({ String? jobNameContains, int? maxResults, String? nextToken, TranscriptionJobStatus? status, })

Lists medical transcription jobs with a specified status or substring that matches their names.

May throw BadRequestException. May throw LimitExceededException. May throw InternalFailureException.

Parameter jobNameContains : When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.

Parameter maxResults : The maximum number of medical transcription jobs to return in the response. IF there are fewer results in the list, this response contains only the actual results.

Parameter nextToken : If you a receive a truncated result in the previous request of ListMedicalTranscriptionJobs, include NextToken to fetch the next set of jobs.

Parameter status : When specified, returns only medical transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don't specify a status, Amazon Transcribe Medical returns all transcription jobs ordered by creation date.

Implementation

Future<ListMedicalTranscriptionJobsResponse> listMedicalTranscriptionJobs({
  String? jobNameContains,
  int? maxResults,
  String? nextToken,
  TranscriptionJobStatus? status,
}) async {
  _s.validateStringLength(
    'jobNameContains',
    jobNameContains,
    1,
    200,
  );
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  _s.validateStringLength(
    'nextToken',
    nextToken,
    0,
    8192,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'Transcribe.ListMedicalTranscriptionJobs'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (jobNameContains != null) 'JobNameContains': jobNameContains,
      if (maxResults != null) 'MaxResults': maxResults,
      if (nextToken != null) 'NextToken': nextToken,
      if (status != null) 'Status': status.toValue(),
    },
  );

  return ListMedicalTranscriptionJobsResponse.fromJson(jsonResponse.body);
}