GetMedicalTranscriptionJob
Provides information about the specified medical transcription job.
To view the status of the specified medical transcription job, check the
TranscriptionJobStatus field. If the status is COMPLETED,
the job is finished. You can find the results at the location specified in
TranscriptFileUri. If the status is FAILED,
FailureReason provides details on why your transcription job
failed.
To get a list of your medical transcription jobs, use the ListMedicalTranscriptionJobs operation.
Request Syntax
{
"MedicalTranscriptionJobName": "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.
- MedicalTranscriptionJobName
-
The name of the medical transcription job you want information about. Job names are case sensitive.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[0-9a-zA-Z._-]+Required: Yes
Response Syntax
{
"MedicalTranscriptionJob": {
"CompletionTime": number,
"ContentIdentificationType": "string",
"CreationTime": number,
"FailureReason": "string",
"LanguageCode": "string",
"Media": {
"MediaFileUri": "string",
"RedactedMediaFileUri": "string"
},
"MediaFormat": "string",
"MediaSampleRateHertz": number,
"MedicalTranscriptionJobName": "string",
"Settings": {
"ChannelIdentification": boolean,
"MaxAlternatives": number,
"MaxSpeakerLabels": number,
"ShowAlternatives": boolean,
"ShowSpeakerLabels": boolean,
"VocabularyName": "string"
},
"Specialty": "string",
"StartTime": number,
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"Transcript": {
"TranscriptFileUri": "string"
},
"TranscriptionJobStatus": "string",
"Type": "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.
- MedicalTranscriptionJob
-
Provides detailed information about the specified medical transcription job, including job status and, if applicable, failure reason.
Type: MedicalTranscriptionJob object
Errors
For information about the errors that are common to all actions, see Common Error Types.
- BadRequestException
-
Your request didn't pass one or more validation tests. This can occur when a parameter has an invalid value, when you combine parameters in a way that isn't supported, when the entity you're trying to delete doesn't exist, or if it's in a non-terminal state (such as
IN PROGRESS). See the exception message field for more information.- Reason
-
A code that identifies why the audio in your request was rejected. Currently,
TranscribeAudioreturns this field, and only for problems with your audio. It isn't returned for other validation errors.Possible values:
-
audioTooLong: The audio is longer than the maximum duration of 1 hour. -
audioTooShort: The audio is shorter than 0.5 seconds. -
audioFileTooLarge: The audio is larger than the maximum size. -
unsupportedAudioFormat: The media format isn't supported. -
unsupportedChannelCount: You enabledChannelIdentificationand the audio has more than two channels. -
invalidAudio: Amazon Transcribe couldn't decode the audio. -
mediaDownloadFailed: Amazon Transcribe couldn't download the audio at yourMediaFileUri.
-
HTTP Status Code: 400
- InternalFailureException
-
There was an internal error. Check the error message, correct the issue, and try your request again.
HTTP Status Code: 500
- LimitExceededException
-
You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
HTTP Status Code: 400
- NotFoundException
-
We can't find the requested resource. Check that the specified name is correct and try your request again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: