Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListMedicalTranscriptionJobs

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

Request Syntax


{
   "JobNameContains": "string",
   "MaxResults": number,
   "NextToken": "string",
   "Status": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

JobNameContains

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: ^[0-9a-zA-Z._-]+

Required: No

MaxResults

The maximum number of medical transcription jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

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

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .+

Required: No

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.

Type: String

Valid Values: QUEUED | IN_PROGRESS | FAILED | COMPLETED

Required: No

Response Syntax


{
   "MedicalTranscriptionJobSummaries": [ 
      { 
         "CompletionTime": number,
         "ContentIdentificationType": "string",
         "CreationTime": number,
         "FailureReason": "string",
         "LanguageCode": "string",
         "MedicalTranscriptionJobName": "string",
         "OutputLocationType": "string",
         "Specialty": "string",
         "StartTime": number,
         "TranscriptionJobStatus": "string",
         "Type": "string"
      }
   ],
   "NextToken": "string",
   "Status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

MedicalTranscriptionJobSummaries

A list of objects containing summary information for a transcription job.

Type: Array of MedicalTranscriptionJobSummary objects

NextToken

The ListMedicalTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If the number of jobs exceeds what can fit on a page, Amazon Transcribe Medical returns the NextPage token. Include the token in the next request to the ListMedicalTranscriptionJobs operation to return in the next page of jobs.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .+

Status

The requested status of the medical transcription jobs returned.

Type: String

Valid Values: QUEUED | IN_PROGRESS | FAILED | COMPLETED

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

HTTP Status Code: 400

InternalFailureException

There was an internal error. Check the error message and try your request again.

HTTP Status Code: 500

LimitExceededException

Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

HTTP Status Code: 400