Skip to main content

transcription_jobs

Creates, updates, deletes, gets or lists a transcription_jobs resource.

Overview​

Nametranscription_jobs
TypeResource
Idaws.transcribe.transcription_jobs

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
completion_timestring (date-time)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.
content_redactionobjectMakes it possible to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: RedactionOutput and RedactionType. You can optionally include PiiEntityTypes to choose which types of PII you want to redact.
creation_timestring (date-time)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.
failure_reasonstringIf 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.
identified_language_scorenumber (float)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.
identify_languagebooleanIndicates whether automatic language identification was enabled (TRUE) for the specified transcription job.
identify_multiple_languagesbooleanIndicates whether automatic multi-language identification was enabled (TRUE) for the specified transcription job.
job_execution_settingsobjectProvides information about how your transcription job was processed. This parameter shows if your request was queued and what data access role was used.
language_codestringThe 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. (af-ZA, ar-AE, ar-SA, am-ET, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-MX, es-US, fa-AF, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, ht-HT, id-ID, it-IT, ja-JP, jv-ID, km-KH, ko-KR, my-MM, 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, ab-GE, ast-ES, az-AZ, ba-RU, be-BY, bg-BG, bn-IN, bs-BA, ca-ES, ckb-IQ, ckb-IR, cs-CZ, cy-WL, el-GR, et-EE, et-ET, eu-ES, fi-FI, gl-ES, gu-IN, ha-NG, hr-HR, hu-HU, hy-AM, is-IS, ka-GE, kab-DZ, kk-KZ, kn-IN, ky-KG, lg-IN, lt-LT, lv-LV, mhr-RU, mi-NZ, mk-MK, ml-IN, mn-MN, mr-IN, mt-MT, no-NO, ne-NP, or-IN, pa-IN, pl-PL, ps-AF, ro-RO, rw-RW, si-LK, sk-SK, sl-SI, so-SO, sq-AL, sr-RS, su-ID, sw-BI, sw-KE, sw-RW, sw-TZ, sw-UG, tl-PH, tt-RU, ug-CN, uk-UA, uz-UZ, wo-SN, zh-HK, zu-ZA)
language_codesarrayThe 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.
language_id_settingsobjectProvides the name and language of all custom language models, custom vocabularies, and custom vocabulary filters that you included in your request.
language_optionsarrayProvides the language codes you specified in your request.
mediaobjectDescribes the Amazon S3 location of the media file you want to use in your request. For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide.
media_formatstringThe format of the input media file. (mp3, mp4, wav, flac, ogg, amr, webm, m4a)
media_sample_rate_hertzintegerThe sample rate, in hertz, of the audio track in your input media file.
model_settingsobjectProvides information on the custom language model you included in your request.
settingsobjectProvides 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.
start_timestring (date-time)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.
subtitlesobjectIndicates whether subtitles were generated with your transcription.
tagsarrayThe tags, each in the form of a key:value pair, assigned to the specified transcription job.
toxicity_detectionarrayProvides information about the toxicity detection settings applied to your transcription.
transcriptobjectProvides you with the Amazon S3 URI you can use to access your transcript.
transcription_job_namestringThe name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account. (pattern: <code>^[0-9a-zA-Z._-]+</code>)
transcription_job_statusstringProvides 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. (QUEUED, IN_PROGRESS, FAILED, COMPLETED)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_transcription_jobselectregionProvides information about the specified transcription job. To view the status of the specified transcription job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. 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. To get a list of your transcription jobs, use the operation.
list_transcription_jobsselectregionProvides a list of transcription jobs that match the specified criteria. If no criteria are specified, all transcription jobs are returned. To get detailed information about a specific transcription job, use the operation.
delete_transcription_jobdeleteregionDeletes a transcription job. To use this operation, specify the name of the job you want to delete using TranscriptionJobName. Job names are case sensitive.
start_transcription_jobexecregion, TranscriptionJobName, MediaTranscribes the audio from a media file and applies any additional Request Parameters you choose to include in your request. To make a StartTranscriptionJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter. You must include the following parameters in your StartTranscriptionJob request: region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas. TranscriptionJobName: A custom name you create for your transcription job that is unique within your Amazon Web Services account. Media (MediaFileUri): The Amazon S3 location of your media file. One of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages: If you know the language of your media file, specify it using the LanguageCode parameter; you can find all valid language codes in the Supported languages table. If you do not know the languages spoken in your media, use either IdentifyLanguage or IdentifyMultipleLanguages and let Amazon Transcribe identify the languages for you.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples​

Provides information about the specified transcription job. To view the status of the specified transcription job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. 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. To get a list of your transcription jobs, use the operation.

SELECT
completion_time,
content_redaction,
creation_time,
failure_reason,
identified_language_score,
identify_language,
identify_multiple_languages,
job_execution_settings,
language_code,
language_codes,
language_id_settings,
language_options,
media,
media_format,
media_sample_rate_hertz,
model_settings,
settings,
start_time,
subtitles,
tags,
toxicity_detection,
transcript,
transcription_job_name,
transcription_job_status
FROM aws.transcribe.transcription_jobs
WHERE region = '{{ region }}' -- required
;

DELETE examples​

Deletes a transcription job. To use this operation, specify the name of the job you want to delete using TranscriptionJobName. Job names are case sensitive.

DELETE FROM aws.transcribe.transcription_jobs
WHERE region = '{{ region }}' --required
;

Lifecycle Methods​

Transcribes the audio from a media file and applies any additional Request Parameters you choose to include in your request. To make a StartTranscriptionJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter. You must include the following parameters in your StartTranscriptionJob request: region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas. TranscriptionJobName: A custom name you create for your transcription job that is unique within your Amazon Web Services account. Media (MediaFileUri): The Amazon S3 location of your media file. One of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages: If you know the language of your media file, specify it using the LanguageCode parameter; you can find all valid language codes in the Supported languages table. If you do not know the languages spoken in your media, use either IdentifyLanguage or IdentifyMultipleLanguages and let Amazon Transcribe identify the languages for you.

EXEC aws.transcribe.transcription_jobs.start_transcription_job 
@region='{{ region }}' --required 
@@json=
'{
"TranscriptionJobName": "{{ TranscriptionJobName }}", 
"LanguageCode": "{{ LanguageCode }}", 
"MediaSampleRateHertz": {{ MediaSampleRateHertz }}, 
"MediaFormat": "{{ MediaFormat }}", 
"Media": "{{ Media }}", 
"OutputBucketName": "{{ OutputBucketName }}", 
"OutputKey": "{{ OutputKey }}", 
"OutputEncryptionKMSKeyId": "{{ OutputEncryptionKMSKeyId }}", 
"KMSEncryptionContext": "{{ KMSEncryptionContext }}", 
"Settings": "{{ Settings }}", 
"ModelSettings": "{{ ModelSettings }}", 
"JobExecutionSettings": "{{ JobExecutionSettings }}", 
"ContentRedaction": "{{ ContentRedaction }}", 
"IdentifyLanguage": {{ IdentifyLanguage }}, 
"IdentifyMultipleLanguages": {{ IdentifyMultipleLanguages }}, 
"LanguageOptions": "{{ LanguageOptions }}", 
"Subtitles": "{{ Subtitles }}", 
"Tags": "{{ Tags }}", 
"LanguageIdSettings": "{{ LanguageIdSettings }}", 
"ToxicityDetection": "{{ ToxicityDetection }}"
}'
;
Last updated on