Documentation

Describes an asynchronous transcription job that was created with the StartTranscriptionJob operation.

See: newTranscriptionJob smart constructor.

Create a value of TranscriptionJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:creationTime:TranscriptionJob', transcriptionJob_creationTime - A timestamp that shows when the job was created.

$sel:failureReason:TranscriptionJob', transcriptionJob_failureReason - If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.

The FailureReason field can contain one of the following values:

• Unsupported media format - The media format specified in the MediaFormat field of the request isn't valid. See the description of the MediaFormat field for a list of valid values.

• The media format provided does not match the detected media format

• The media format of the audio file doesn't match the format specified in the MediaFormat field in the request. Check the media format of your media file and make sure that the two values match.
• Invalid sample rate for audio file - The sample rate specified in the MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8,000 and 48,000 Hertz.
• The sample rate provided does not match the detected sample rate - The sample rate in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match.
• Invalid file size: file size too large - The size of your audio file is larger than Amazon Transcribe can process. For more information, see Limits in the Amazon Transcribe Developer Guide.
• Invalid number of channels: number of channels too large - Your audio contains more channels than Amazon Transcribe is configured to process. To request additional channels, see Amazon Transcribe Limits in the Amazon Web Services General Reference.

$sel:contentRedaction:TranscriptionJob', transcriptionJob_contentRedaction - An object that describes content redaction settings for the transcription job.

$sel:identifiedLanguageScore:TranscriptionJob', transcriptionJob_identifiedLanguageScore - A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio. Larger values indicate that Amazon Transcribe has higher confidence in the language it identified.

$sel:subtitles:TranscriptionJob', transcriptionJob_subtitles - Generate subtitles for your batch transcription job.

$sel:languageCode:TranscriptionJob', transcriptionJob_languageCode - The language code for the input speech.

$sel:languageOptions:TranscriptionJob', transcriptionJob_languageOptions - An object that shows the optional array of languages inputted for transcription jobs with automatic language identification enabled.

$sel:settings:TranscriptionJob', transcriptionJob_settings - Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.

$sel:startTime:TranscriptionJob', transcriptionJob_startTime - A timestamp that shows when the job started processing.

$sel:completionTime:TranscriptionJob', transcriptionJob_completionTime - A timestamp that shows when the job completed.

$sel:media:TranscriptionJob', transcriptionJob_media - An object that describes the input media for the transcription job.

$sel:mediaFormat:TranscriptionJob', transcriptionJob_mediaFormat - The format of the input media file.

$sel:modelSettings:TranscriptionJob', transcriptionJob_modelSettings - An object containing the details of your custom language model.

$sel:transcriptionJobStatus:TranscriptionJob', transcriptionJob_transcriptionJobStatus - The status of the transcription job.

$sel:jobExecutionSettings:TranscriptionJob', transcriptionJob_jobExecutionSettings - Provides information about how a transcription job is executed.

$sel:transcriptionJobName:TranscriptionJob', transcriptionJob_transcriptionJobName - The name of the transcription job.

$sel:identifyLanguage:TranscriptionJob', transcriptionJob_identifyLanguage - A value that shows if automatic language identification was enabled for a transcription job.

$sel:transcript:TranscriptionJob', transcriptionJob_transcript - An object that describes the output of the transcription job.

$sel:tags:TranscriptionJob', transcriptionJob_tags - A key:value pair assigned to a given transcription job.

$sel:mediaSampleRateHertz:TranscriptionJob', transcriptionJob_mediaSampleRateHertz - The sample rate, in Hertz, of the audio track in the input media file.

A timestamp that shows when the job was created.

If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.

The FailureReason field can contain one of the following values:

• Unsupported media format - The media format specified in the MediaFormat field of the request isn't valid. See the description of the MediaFormat field for a list of valid values.

• The media format provided does not match the detected media format

• The media format of the audio file doesn't match the format specified in the MediaFormat field in the request. Check the media format of your media file and make sure that the two values match.
• Invalid sample rate for audio file - The sample rate specified in the MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8,000 and 48,000 Hertz.
• The sample rate provided does not match the detected sample rate - The sample rate in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match.
• Invalid file size: file size too large - The size of your audio file is larger than Amazon Transcribe can process. For more information, see Limits in the Amazon Transcribe Developer Guide.
• Invalid number of channels: number of channels too large - Your audio contains more channels than Amazon Transcribe is configured to process. To request additional channels, see Amazon Transcribe Limits in the Amazon Web Services General Reference.

An object that describes content redaction settings for the transcription job.

A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio. Larger values indicate that Amazon Transcribe has higher confidence in the language it identified.

Generate subtitles for your batch transcription job.

The language code for the input speech.

An object that shows the optional array of languages inputted for transcription jobs with automatic language identification enabled.

Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.

A timestamp that shows when the job started processing.

A timestamp that shows when the job completed.

An object that describes the input media for the transcription job.

The format of the input media file.

An object containing the details of your custom language model.

The status of the transcription job.

Provides information about how a transcription job is executed.

The name of the transcription job.

A value that shows if automatic language identification was enabled for a transcription job.

An object that describes the output of the transcription job.

A key:value pair assigned to a given transcription job.

The sample rate, in Hertz, of the audio track in the input media file.