Documentation

Provides a summary of information about a transcription job.

See: newTranscriptionJobSummary smart constructor.

Create a value of TranscriptionJobSummary 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:TranscriptionJobSummary', transcriptionJobSummary_creationTime - A timestamp that shows when the job was created.

$sel:failureReason:TranscriptionJobSummary', transcriptionJobSummary_failureReason - If the TranscriptionJobStatus field is FAILED, a description of the error.

$sel:contentRedaction:TranscriptionJobSummary', transcriptionJobSummary_contentRedaction - The content redaction settings of the transcription job.

$sel:identifiedLanguageScore:TranscriptionJobSummary', transcriptionJobSummary_identifiedLanguageScore - A value between zero and one that Amazon Transcribe assigned to the language it identified in the source audio. A higher score indicates that Amazon Transcribe is more confident in the language it identified.

$sel:languageCode:TranscriptionJobSummary', transcriptionJobSummary_languageCode - The language code for the input speech.

$sel:outputLocationType:TranscriptionJobSummary', transcriptionJobSummary_outputLocationType - Indicates the location of the output of the transcription job.

If the value is CUSTOMER_BUCKET then the location is the S3 bucket specified in the outputBucketName field when the transcription job was started with the StartTranscriptionJob operation.

If the value is SERVICE_BUCKET then the output is stored by Amazon Transcribe and can be retrieved using the URI in the GetTranscriptionJob response's TranscriptFileUri field.

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

$sel:completionTime:TranscriptionJobSummary', transcriptionJobSummary_completionTime - A timestamp that shows when the job was completed.

$sel:modelSettings:TranscriptionJobSummary', transcriptionJobSummary_modelSettings - Undocumented member.

$sel:transcriptionJobStatus:TranscriptionJobSummary', transcriptionJobSummary_transcriptionJobStatus - The status of the transcription job. When the status is COMPLETED, use the GetTranscriptionJob operation to get the results of the transcription.

$sel:transcriptionJobName:TranscriptionJobSummary', transcriptionJobSummary_transcriptionJobName - The name of the transcription job.

$sel:identifyLanguage:TranscriptionJobSummary', transcriptionJobSummary_identifyLanguage - Whether automatic language identification was enabled for a transcription job.

A timestamp that shows when the job was created.

If the TranscriptionJobStatus field is FAILED, a description of the error.

The content redaction settings of the transcription job.

A value between zero and one that Amazon Transcribe assigned to the language it identified in the source audio. A higher score indicates that Amazon Transcribe is more confident in the language it identified.

The language code for the input speech.

Indicates the location of the output of the transcription job.

If the value is CUSTOMER_BUCKET then the location is the S3 bucket specified in the outputBucketName field when the transcription job was started with the StartTranscriptionJob operation.

If the value is SERVICE_BUCKET then the output is stored by Amazon Transcribe and can be retrieved using the URI in the GetTranscriptionJob response's TranscriptFileUri field.

A timestamp that shows when the job started processing.

A timestamp that shows when the job was completed.

Undocumented member.

The status of the transcription job. When the status is COMPLETED, use the GetTranscriptionJob operation to get the results of the transcription.

The name of the transcription job.

Whether automatic language identification was enabled for a transcription job.