GetTranscriptionJob
Provides information about the specified transcription job.
To view the status of the specified 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.
If you enabled content redaction, the redacted transcript can be found at the location
specified in RedactedTranscriptFileUri
.
To get a list of your transcription jobs, use the ListTranscriptionJobs operation.
Request Syntax
{
"TranscriptionJobName": "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.
- TranscriptionJobName
-
The name of the 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
{
"TranscriptionJob": {
"CompletionTime": number,
"ContentRedaction": {
"PiiEntityTypes": [ "string" ],
"RedactionOutput": "string",
"RedactionType": "string"
},
"CreationTime": number,
"FailureReason": "string",
"IdentifiedLanguageScore": number,
"IdentifyLanguage": boolean,
"IdentifyMultipleLanguages": boolean,
"JobExecutionSettings": {
"AllowDeferredExecution": boolean,
"DataAccessRoleArn": "string"
},
"LanguageCode": "string",
"LanguageCodes": [
{
"DurationInSeconds": number,
"LanguageCode": "string"
}
],
"LanguageIdSettings": {
"string" : {
"LanguageModelName": "string",
"VocabularyFilterName": "string",
"VocabularyName": "string"
}
},
"LanguageOptions": [ "string" ],
"Media": {
"MediaFileUri": "string",
"RedactedMediaFileUri": "string"
},
"MediaFormat": "string",
"MediaSampleRateHertz": number,
"ModelSettings": {
"LanguageModelName": "string"
},
"Settings": {
"ChannelIdentification": boolean,
"MaxAlternatives": number,
"MaxSpeakerLabels": number,
"ShowAlternatives": boolean,
"ShowSpeakerLabels": boolean,
"VocabularyFilterMethod": "string",
"VocabularyFilterName": "string",
"VocabularyName": "string"
},
"StartTime": number,
"Subtitles": {
"Formats": [ "string" ],
"OutputStartIndex": number,
"SubtitleFileUris": [ "string" ]
},
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"ToxicityDetection": [
{
"ToxicityCategories": [ "string" ]
}
],
"Transcript": {
"RedactedTranscriptFileUri": "string",
"TranscriptFileUri": "string"
},
"TranscriptionJobName": "string",
"TranscriptionJobStatus": "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.
- TranscriptionJob
-
Provides detailed information about the specified transcription job, including job status and, if applicable, failure reason.
Type: TranscriptionJob object
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. This can occur 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.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: