Skip to content

/AWS1/CL_TNBTRANSCRIPTIONJOB

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.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_transcriptionjobname TYPE /AWS1/TNBTRANSCRIPTIONJOBNAME /AWS1/TNBTRANSCRIPTIONJOBNAME

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

iv_transcriptionjobstatus TYPE /AWS1/TNBTRANSCRIPTIONJOBSTAT /AWS1/TNBTRANSCRIPTIONJOBSTAT

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.

iv_languagecode TYPE /AWS1/TNBLANGUAGECODE /AWS1/TNBLANGUAGECODE

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.

iv_mediasampleratehertz TYPE /AWS1/TNBMEDIASAMPLERATEHERTZ /AWS1/TNBMEDIASAMPLERATEHERTZ

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

iv_mediaformat TYPE /AWS1/TNBMEDIAFORMAT /AWS1/TNBMEDIAFORMAT

The format of the input media file.

io_media TYPE REF TO /AWS1/CL_TNBMEDIA /AWS1/CL_TNBMEDIA

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

io_transcript TYPE REF TO /AWS1/CL_TNBTRANSCRIPT /AWS1/CL_TNBTRANSCRIPT

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

iv_starttime TYPE /AWS1/TNBDATETIME /AWS1/TNBDATETIME

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.

iv_creationtime TYPE /AWS1/TNBDATETIME /AWS1/TNBDATETIME

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.

iv_completiontime TYPE /AWS1/TNBDATETIME /AWS1/TNBDATETIME

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.

iv_failurereason TYPE /AWS1/TNBFAILUREREASON /AWS1/TNBFAILUREREASON

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 refer to the MediaFormat parameter 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 Service 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 Service quotas.

io_settings TYPE REF TO /AWS1/CL_TNBSETTINGS /AWS1/CL_TNBSETTINGS

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

io_modelsettings TYPE REF TO /AWS1/CL_TNBMODELSETTINGS /AWS1/CL_TNBMODELSETTINGS

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

io_jobexecutionsettings TYPE REF TO /AWS1/CL_TNBJOBEXECSETTINGS /AWS1/CL_TNBJOBEXECSETTINGS

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

io_contentredaction TYPE REF TO /AWS1/CL_TNBCONTENTREDACTION /AWS1/CL_TNBCONTENTREDACTION

Indicates whether redaction was enabled in your transcript.

iv_identifylanguage TYPE /AWS1/TNBBOOLEAN /AWS1/TNBBOOLEAN

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

iv_identifymultiplelanguages TYPE /AWS1/TNBBOOLEAN /AWS1/TNBBOOLEAN

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

it_languageoptions TYPE /AWS1/CL_TNBLANGUAGEOPTIONS_W=>TT_LANGUAGEOPTIONS TT_LANGUAGEOPTIONS

Provides the language codes you specified in your request.

iv_identifiedlanguagescore TYPE /AWS1/RT_FLOAT_AS_STRING /AWS1/RT_FLOAT_AS_STRING

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.

it_languagecodes TYPE /AWS1/CL_TNBLANGUAGECODEITEM=>TT_LANGUAGECODELIST TT_LANGUAGECODELIST

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.

it_tags TYPE /AWS1/CL_TNBTAG=>TT_TAGLIST TT_TAGLIST

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

io_subtitles TYPE REF TO /AWS1/CL_TNBSUBTITLESOUTPUT /AWS1/CL_TNBSUBTITLESOUTPUT

Indicates whether subtitles were generated with your transcription.

it_languageidsettings TYPE /AWS1/CL_TNBLANGUAGEIDSETTINGS=>TT_LANGUAGEIDSETTINGSMAP TT_LANGUAGEIDSETTINGSMAP

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

it_toxicitydetection TYPE /AWS1/CL_TNBTOXICITYDETECTSTGS=>TT_TOXICITYDETECTION TT_TOXICITYDETECTION

Provides information about the toxicity detection settings applied to your transcription.

Queryable Attributes

TranscriptionJobName

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

Accessible with the following methods

Method Description
GET_TRANSCRIPTIONJOBNAME() Getter for TRANSCRIPTIONJOBNAME, with configurable default
ASK_TRANSCRIPTIONJOBNAME() Getter for TRANSCRIPTIONJOBNAME w/ exceptions if field has n
HAS_TRANSCRIPTIONJOBNAME() Determine if TRANSCRIPTIONJOBNAME has a value

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.

Accessible with the following methods

Method Description
GET_TRANSCRIPTIONJOBSTATUS() Getter for TRANSCRIPTIONJOBSTATUS, with configurable default
ASK_TRANSCRIPTIONJOBSTATUS() Getter for TRANSCRIPTIONJOBSTATUS w/ exceptions if field has
HAS_TRANSCRIPTIONJOBSTATUS() Determine if TRANSCRIPTIONJOBSTATUS has a value

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.

Accessible with the following methods

Method Description
GET_LANGUAGECODE() Getter for LANGUAGECODE, with configurable default
ASK_LANGUAGECODE() Getter for LANGUAGECODE w/ exceptions if field has no value
HAS_LANGUAGECODE() Determine if LANGUAGECODE has a value

MediaSampleRateHertz

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

Accessible with the following methods

Method Description
GET_MEDIASAMPLERATEHERTZ() Getter for MEDIASAMPLERATEHERTZ, with configurable default
ASK_MEDIASAMPLERATEHERTZ() Getter for MEDIASAMPLERATEHERTZ w/ exceptions if field has n
HAS_MEDIASAMPLERATEHERTZ() Determine if MEDIASAMPLERATEHERTZ has a value

MediaFormat

The format of the input media file.

Accessible with the following methods

Method Description
GET_MEDIAFORMAT() Getter for MEDIAFORMAT, with configurable default
ASK_MEDIAFORMAT() Getter for MEDIAFORMAT w/ exceptions if field has no value
HAS_MEDIAFORMAT() Determine if MEDIAFORMAT has a value

Media

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

Accessible with the following methods

Method Description
GET_MEDIA() Getter for MEDIA

Transcript

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

Accessible with the following methods

Method Description
GET_TRANSCRIPT() Getter for TRANSCRIPT

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.

Accessible with the following methods

Method Description
GET_STARTTIME() Getter for STARTTIME, with configurable default
ASK_STARTTIME() Getter for STARTTIME w/ exceptions if field has no value
HAS_STARTTIME() Determine if STARTTIME has a value

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.

Accessible with the following methods

Method Description
GET_CREATIONTIME() Getter for CREATIONTIME, with configurable default
ASK_CREATIONTIME() Getter for CREATIONTIME w/ exceptions if field has no value
HAS_CREATIONTIME() Determine if CREATIONTIME has a value

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.

Accessible with the following methods

Method Description
GET_COMPLETIONTIME() Getter for COMPLETIONTIME, with configurable default
ASK_COMPLETIONTIME() Getter for COMPLETIONTIME w/ exceptions if field has no valu
HAS_COMPLETIONTIME() Determine if COMPLETIONTIME has a value

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 refer to the MediaFormat parameter 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 Service 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 Service quotas.

Accessible with the following methods

Method Description
GET_FAILUREREASON() Getter for FAILUREREASON, with configurable default
ASK_FAILUREREASON() Getter for FAILUREREASON w/ exceptions if field has no value
HAS_FAILUREREASON() Determine if FAILUREREASON has a value

Settings

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

Accessible with the following methods

Method Description
GET_SETTINGS() Getter for SETTINGS

ModelSettings

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

Accessible with the following methods

Method Description
GET_MODELSETTINGS() Getter for MODELSETTINGS

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.

Accessible with the following methods

Method Description
GET_JOBEXECUTIONSETTINGS() Getter for JOBEXECUTIONSETTINGS

ContentRedaction

Indicates whether redaction was enabled in your transcript.

Accessible with the following methods

Method Description
GET_CONTENTREDACTION() Getter for CONTENTREDACTION

IdentifyLanguage

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

Accessible with the following methods

Method Description
GET_IDENTIFYLANGUAGE() Getter for IDENTIFYLANGUAGE, with configurable default
ASK_IDENTIFYLANGUAGE() Getter for IDENTIFYLANGUAGE w/ exceptions if field has no va
HAS_IDENTIFYLANGUAGE() Determine if IDENTIFYLANGUAGE has a value

IdentifyMultipleLanguages

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

Accessible with the following methods

Method Description
GET_IDENTIFYMULTIPLELANGUA00() Getter for IDENTIFYMULTIPLELANGUAGES, with configurable defa
ASK_IDENTIFYMULTIPLELANGUA00() Getter for IDENTIFYMULTIPLELANGUAGES w/ exceptions if field
HAS_IDENTIFYMULTIPLELANGUA00() Determine if IDENTIFYMULTIPLELANGUAGES has a value

LanguageOptions

Provides the language codes you specified in your request.

Accessible with the following methods

Method Description
GET_LANGUAGEOPTIONS() Getter for LANGUAGEOPTIONS, with configurable default
ASK_LANGUAGEOPTIONS() Getter for LANGUAGEOPTIONS w/ exceptions if field has no val
HAS_LANGUAGEOPTIONS() Determine if LANGUAGEOPTIONS has a value

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.

Accessible with the following methods

Method Description
GET_IDENTIFIEDLANGUAGESCORE() Getter for IDENTIFIEDLANGUAGESCORE, with configurable defaul
ASK_IDENTIFIEDLANGUAGESCORE() Getter for IDENTIFIEDLANGUAGESCORE w/ exceptions if field ha
STR_IDENTIFIEDLANGUAGESCORE() String format for IDENTIFIEDLANGUAGESCORE, with configurable
HAS_IDENTIFIEDLANGUAGESCORE() Determine if IDENTIFIEDLANGUAGESCORE has a value

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.

Accessible with the following methods

Method Description
GET_LANGUAGECODES() Getter for LANGUAGECODES, with configurable default
ASK_LANGUAGECODES() Getter for LANGUAGECODES w/ exceptions if field has no value
HAS_LANGUAGECODES() Determine if LANGUAGECODES has a value

Tags

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

Accessible with the following methods

Method Description
GET_TAGS() Getter for TAGS, with configurable default
ASK_TAGS() Getter for TAGS w/ exceptions if field has no value
HAS_TAGS() Determine if TAGS has a value

Subtitles

Indicates whether subtitles were generated with your transcription.

Accessible with the following methods

Method Description
GET_SUBTITLES() Getter for SUBTITLES

LanguageIdSettings

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

Accessible with the following methods

Method Description
GET_LANGUAGEIDSETTINGS() Getter for LANGUAGEIDSETTINGS, with configurable default
ASK_LANGUAGEIDSETTINGS() Getter for LANGUAGEIDSETTINGS w/ exceptions if field has no
HAS_LANGUAGEIDSETTINGS() Determine if LANGUAGEIDSETTINGS has a value

ToxicityDetection

Provides information about the toxicity detection settings applied to your transcription.

Accessible with the following methods

Method Description
GET_TOXICITYDETECTION() Getter for TOXICITYDETECTION, with configurable default
ASK_TOXICITYDETECTION() Getter for TOXICITYDETECTION w/ exceptions if field has no v
HAS_TOXICITYDETECTION() Determine if TOXICITYDETECTION has a value