TranscriptionJobSummary - Amazon Transcribe
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

TranscriptionJobSummary

Provides detailed information about a specific transcription job.

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

The content redaction settings of the transcription job.

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 failed. See also: Common Errors.

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

LanguageCode

The language code used to create your transcription.

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 | vi-VN | sv-SE

Required: No

LanguageCodes

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

Type: Array of LanguageCodeItem objects

Required: No

ModelSettings

Provides the name of the custom language model that was included in the specified transcription job.

Only use ModelSettings with the LanguageModelName sub-parameter if you're not using automatic language identification ( LanguageIdSettings ). If using LanguageIdSettings in your request, this parameter contains a LanguageModelName sub-parameter.

Type: ModelSettings object

Required: No

OutputLocationType

Indicates where the specified transcription output is stored.

If the value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket you specified using the OutputBucketName parameter in your StartTranscriptionJob request. If you also included OutputKey in your request, your output is located in the path you specified in your request.

If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the URI shown in the TranscriptFileUri or RedactedTranscriptFileUri field.

Type: String

Valid Values: CUSTOMER_BUCKET | SERVICE_BUCKET

Required: No

StartTime

The date and time your 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

ToxicityDetection

Indicates whether toxicity detection was enabled for the specified transcription job.

Type: Array of ToxicityDetectionSettings objects

Array Members: Fixed number of 1 item.

Required: No

TranscriptionJobName

The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services 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 your 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 Amazon SDKs, see the following: