TranscriptionJob - Transcribe

TranscriptionJob

Provides detailed information about a transcription job.

To view the status of the specified transcription job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished and 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.

Contents

CompletionTime

The date and time the specified transcription job finished processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.

Type: Timestamp

Required: No

ContentRedaction

Indicates whether redaction was enabled in your transcript.

Type: ContentRedaction object

Required: No

CreationTime

The date and time the specified transcription job request was made.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

Type: Timestamp

Required: No

FailureReason

If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed.

The FailureReason field contains one of the following values:

  • Unsupported media format.

    The media format specified in MediaFormat isn't valid. Refer to MediaFormat for a list of supported formats.

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

    The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.

  • Invalid sample rate for audio file.

    The sample rate specified in MediaSampleRateHertz 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 specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

  • Invalid file size: file size too large.

    The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and quotas.

  • Invalid number of channels: number of channels too large.

    Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Guidelines and quotas.

Type: String

Required: No

IdentifiedLanguageScore

The confidence score associated with the language identified in your media file.

Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.

Type: Float

Required: No

IdentifyLanguage

Indicates whether automatic language identification was enabled (TRUE) for the specified transcription job.

Type: Boolean

Required: No

IdentifyMultipleLanguages

Indicates whether automatic multi-language identification was enabled (TRUE) for the specified transcription job.

Type: Boolean

Required: No

JobExecutionSettings

Provides information about how your transcription job was processed. This parameter shows if your request was queued and what data access role was used.

Type: JobExecutionSettings object

Required: No

LanguageCode

The language code used to create your transcription job. This parameter is used with single-language identification. For multi-language identification requests, refer to the plural version of this parameter, LanguageCodes.

Type: String

Valid Values: af-ZA | ar-AE | ar-SA | da-DK | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fa-IR | fr-CA | fr-FR | he-IL | hi-IN | id-ID | it-IT | ja-JP | ko-KR | ms-MY | nl-NL | pt-BR | pt-PT | ru-RU | ta-IN | te-IN | tr-TR | zh-CN | zh-TW | th-TH | en-ZA | en-NZ

Required: No

LanguageCodes

The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification requests, refer to the singular version of this parameter, LanguageCode.

Type: Array of LanguageCodeItem objects

Required: No

LanguageIdSettings

Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary filters that you included in your request.

Type: String to LanguageIdSettings object map

Map Entries: Maximum number of 5 items.

Valid Keys: af-ZA | ar-AE | ar-SA | da-DK | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fa-IR | fr-CA | fr-FR | he-IL | hi-IN | id-ID | it-IT | ja-JP | ko-KR | ms-MY | nl-NL | pt-BR | pt-PT | ru-RU | ta-IN | te-IN | tr-TR | zh-CN | zh-TW | th-TH | en-ZA | en-NZ

Required: No

LanguageOptions

Provides the language codes you specified in your request.

Type: Array of strings

Array Members: Minimum number of 1 item.

Valid Values: af-ZA | ar-AE | ar-SA | da-DK | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fa-IR | fr-CA | fr-FR | he-IL | hi-IN | id-ID | it-IT | ja-JP | ko-KR | ms-MY | nl-NL | pt-BR | pt-PT | ru-RU | ta-IN | te-IN | tr-TR | zh-CN | zh-TW | th-TH | en-ZA | en-NZ

Required: No

Media

Provides the Amazon S3 location of the media file you used in your request.

Type: Media object

Required: No

MediaFormat

The format of the input media file.

Type: String

Valid Values: mp3 | mp4 | wav | flac | ogg | amr | webm

Required: No

MediaSampleRateHertz

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

Type: Integer

Valid Range: Minimum value of 8000. Maximum value of 48000.

Required: No

ModelSettings

Provides information on the custom language model you included in your request.

Type: ModelSettings object

Required: No

Settings

Provides information on any additional settings that were included in your request. Additional settings include channel identification, alternative transcriptions, speaker labeling, custom vocabularies, and custom vocabulary filters.

Type: Settings object

Required: No

StartTime

The date and time the specified transcription job began processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

Type: Timestamp

Required: No

Subtitles

Indicates whether subtitles were generated with your transcription.

Type: SubtitlesOutput object

Required: No

Tags

The tags, each in the form of a key:value pair, assigned to the specified transcription job.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 200 items.

Required: No

Transcript

Provides you with the Amazon S3 URI you can use to access your transcript.

Type: Transcript object

Required: No

TranscriptionJobName

The name of the transcription job. Job names are case sensitive and must be unique within an AWS account.

Type: String

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

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

Required: No

TranscriptionJobStatus

Provides the status of the specified transcription job.

If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

Type: String

Valid Values: QUEUED | IN_PROGRESS | FAILED | COMPLETED

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: