Start Transcription Job
transcribeservice_start_transcription_job | R Documentation |
Transcribes the audio from a media file and applies any additional Request Parameters you choose to include in your request¶
Description¶
Transcribes the audio from a media file and applies any additional Request Parameters you choose to include in your request.
To make a start_transcription_job
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
start_transcription_job
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
, orIdentifyMultipleLanguages
: If you know the language of your media file, specify it using theLanguageCode
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 eitherIdentifyLanguage
orIdentifyMultipleLanguages
and let Amazon Transcribe identify the languages for you.
Usage¶
transcribeservice_start_transcription_job(TranscriptionJobName,
LanguageCode, MediaSampleRateHertz, MediaFormat, Media,
OutputBucketName, OutputKey, OutputEncryptionKMSKeyId,
KMSEncryptionContext, Settings, ModelSettings, JobExecutionSettings,
ContentRedaction, IdentifyLanguage, IdentifyMultipleLanguages,
LanguageOptions, Subtitles, Tags, LanguageIdSettings, ToxicityDetection)
Arguments¶
TranscriptionJobName |
[required] A unique name, chosen by you, for your transcription
job. The name that you specify is also used as the default name of your
transcription output file. If you want to specify a different name for
your transcription output, use the This name is case sensitive, cannot contain spaces, and must be
unique within an Amazon Web Services account. If you try to create a new
job with the same name as an existing job, you get a
|
LanguageCode |
The language code that represents the language spoken in the input media file. If you're unsure of the language spoken in your media file, consider
using Note that you must include one of For a list of supported languages and their associated language codes, refer to the Supported languages table. To transcribe speech in Modern Standard Arabic ( |
MediaSampleRateHertz |
The sample rate, in hertz, of the audio track in your input media file. If you do not specify the media sample rate, Amazon Transcribe
determines it for you. If you specify the sample rate, it must match the
rate detected by Amazon Transcribe. If there's a mismatch between the
value that you specify and the value detected, your job fails. In most
cases, you can omit |
MediaFormat |
Specify the format of your input media file. |
Media |
[required] Describes the Amazon S3 location of the media file you want to use in your request. |
OutputBucketName |
The name of the Amazon S3 bucket where you want your
transcription output stored. Do not include the If you want your output to go to a sub-folder of this bucket, specify
it using the For example, if you want your output stored in Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles. If you do not specify |
OutputKey |
Use in combination with Here are some examples of how you can use
If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you. |
OutputEncryptionKMSKeyId |
The KMS key you want to use to encrypt your transcription output. If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
If you do not specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3). If you specify a KMS key to encrypt your output, you must also
specify an output location using the Note that the role making the request must have permission to use the specified KMS key. |
KMSEncryptionContext |
A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS. |
Settings |
Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker partitioning. You can use that to apply custom vocabularies and vocabulary filters. If you want to include a custom vocabulary or a custom vocabulary
filter (or both) with your request but do not want to
use automatic language identification, use If you're using automatic language identification with your request
and want to include a custom language model, a custom vocabulary, or a
custom vocabulary filter, use instead the “ parameter with the
|
ModelSettings |
Specify the custom language model you want to include with your
transcription job. If you include For more information, see Custom language models. |
JobExecutionSettings |
Makes it possible to control how your transcription job is
processed. Currently, the only If you include |
ContentRedaction |
Makes it possible to redact or flag specified personally
identifiable information (PII) in your transcript. If you use
|
IdentifyLanguage |
Enables automatic language identification in your transcription
job request. Use this parameter if your media file contains only one
language. If your media contains multiple languages, use
If you include If you want to apply a custom language model, a custom vocabulary, or
a custom vocabulary filter to your automatic language identification
request, include Note that you must include one of |
IdentifyMultipleLanguages |
Enables automatic multi-language identification in your
transcription job request. Use this parameter if your media file
contains more than one language. If your media contains only one
language, use If you include If you want to apply a custom vocabulary or a custom vocabulary
filter to your automatic language identification request, include
Note that you must include one of |
LanguageOptions |
You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter. If you include For more information, refer to Supported languages. To transcribe speech in Modern Standard Arabic ( |
Subtitles |
Produces subtitle files for your input media. You can specify WebVTT (.vtt) and SubRip (.srt) formats. |
Tags |
Adds one or more custom tags, each in the form of a key:value pair, to a new transcription job at the time you start this new job. To learn more about using tags with Amazon Transcribe, refer to Tagging resources. |
LanguageIdSettings |
If using automatic language identification in your request and
you want to apply a custom language model, a custom vocabulary, or a
custom vocabulary filter, include
It's recommended that you include If you want to include a custom language model with your request but
do not want to use automatic language identification,
use instead the |
ToxicityDetection |
Enables toxic speech detection in your transcript. If you include
For information on the types of toxic speech Amazon Transcribe can detect, see Detecting toxic speech. |
Value¶
A list with the following syntax:
list(
TranscriptionJob = list(
TranscriptionJobName = "string",
TranscriptionJobStatus = "QUEUED"|"IN_PROGRESS"|"FAILED"|"COMPLETED",
LanguageCode = "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"|"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-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"|"or-IN"|"pa-IN"|"pl-PL"|"ps-AF"|"ro-RO"|"rw-RW"|"si-LK"|"sk-SK"|"sl-SI"|"so-SO"|"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"|"zu-ZA",
MediaSampleRateHertz = 123,
MediaFormat = "mp3"|"mp4"|"wav"|"flac"|"ogg"|"amr"|"webm"|"m4a",
Media = list(
MediaFileUri = "string",
RedactedMediaFileUri = "string"
),
Transcript = list(
TranscriptFileUri = "string",
RedactedTranscriptFileUri = "string"
),
StartTime = as.POSIXct(
"2015-01-01"
),
CreationTime = as.POSIXct(
"2015-01-01"
),
CompletionTime = as.POSIXct(
"2015-01-01"
),
FailureReason = "string",
Settings = list(
VocabularyName = "string",
ShowSpeakerLabels = TRUE|FALSE,
MaxSpeakerLabels = 123,
ChannelIdentification = TRUE|FALSE,
ShowAlternatives = TRUE|FALSE,
MaxAlternatives = 123,
VocabularyFilterName = "string",
VocabularyFilterMethod = "remove"|"mask"|"tag"
),
ModelSettings = list(
LanguageModelName = "string"
),
JobExecutionSettings = list(
AllowDeferredExecution = TRUE|FALSE,
DataAccessRoleArn = "string"
),
ContentRedaction = list(
RedactionType = "PII",
RedactionOutput = "redacted"|"redacted_and_unredacted",
PiiEntityTypes = list(
"BANK_ACCOUNT_NUMBER"|"BANK_ROUTING"|"CREDIT_DEBIT_NUMBER"|"CREDIT_DEBIT_CVV"|"CREDIT_DEBIT_EXPIRY"|"PIN"|"EMAIL"|"ADDRESS"|"NAME"|"PHONE"|"SSN"|"ALL"
)
),
IdentifyLanguage = TRUE|FALSE,
IdentifyMultipleLanguages = TRUE|FALSE,
LanguageOptions = list(
"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"|"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-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"|"or-IN"|"pa-IN"|"pl-PL"|"ps-AF"|"ro-RO"|"rw-RW"|"si-LK"|"sk-SK"|"sl-SI"|"so-SO"|"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"|"zu-ZA"
),
IdentifiedLanguageScore = 123.0,
LanguageCodes = list(
list(
LanguageCode = "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"|"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-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"|"or-IN"|"pa-IN"|"pl-PL"|"ps-AF"|"ro-RO"|"rw-RW"|"si-LK"|"sk-SK"|"sl-SI"|"so-SO"|"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"|"zu-ZA",
DurationInSeconds = 123.0
)
),
Tags = list(
list(
Key = "string",
Value = "string"
)
),
Subtitles = list(
Formats = list(
"vtt"|"srt"
),
SubtitleFileUris = list(
"string"
),
OutputStartIndex = 123
),
LanguageIdSettings = list(
list(
VocabularyName = "string",
VocabularyFilterName = "string",
LanguageModelName = "string"
)
),
ToxicityDetection = list(
list(
ToxicityCategories = list(
"ALL"
)
)
)
)
)
Request syntax¶
svc$start_transcription_job(
TranscriptionJobName = "string",
LanguageCode = "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"|"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-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"|"or-IN"|"pa-IN"|"pl-PL"|"ps-AF"|"ro-RO"|"rw-RW"|"si-LK"|"sk-SK"|"sl-SI"|"so-SO"|"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"|"zu-ZA",
MediaSampleRateHertz = 123,
MediaFormat = "mp3"|"mp4"|"wav"|"flac"|"ogg"|"amr"|"webm"|"m4a",
Media = list(
MediaFileUri = "string",
RedactedMediaFileUri = "string"
),
OutputBucketName = "string",
OutputKey = "string",
OutputEncryptionKMSKeyId = "string",
KMSEncryptionContext = list(
"string"
),
Settings = list(
VocabularyName = "string",
ShowSpeakerLabels = TRUE|FALSE,
MaxSpeakerLabels = 123,
ChannelIdentification = TRUE|FALSE,
ShowAlternatives = TRUE|FALSE,
MaxAlternatives = 123,
VocabularyFilterName = "string",
VocabularyFilterMethod = "remove"|"mask"|"tag"
),
ModelSettings = list(
LanguageModelName = "string"
),
JobExecutionSettings = list(
AllowDeferredExecution = TRUE|FALSE,
DataAccessRoleArn = "string"
),
ContentRedaction = list(
RedactionType = "PII",
RedactionOutput = "redacted"|"redacted_and_unredacted",
PiiEntityTypes = list(
"BANK_ACCOUNT_NUMBER"|"BANK_ROUTING"|"CREDIT_DEBIT_NUMBER"|"CREDIT_DEBIT_CVV"|"CREDIT_DEBIT_EXPIRY"|"PIN"|"EMAIL"|"ADDRESS"|"NAME"|"PHONE"|"SSN"|"ALL"
)
),
IdentifyLanguage = TRUE|FALSE,
IdentifyMultipleLanguages = TRUE|FALSE,
LanguageOptions = list(
"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"|"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-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"|"or-IN"|"pa-IN"|"pl-PL"|"ps-AF"|"ro-RO"|"rw-RW"|"si-LK"|"sk-SK"|"sl-SI"|"so-SO"|"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"|"zu-ZA"
),
Subtitles = list(
Formats = list(
"vtt"|"srt"
),
OutputStartIndex = 123
),
Tags = list(
list(
Key = "string",
Value = "string"
)
),
LanguageIdSettings = list(
list(
VocabularyName = "string",
VocabularyFilterName = "string",
LanguageModelName = "string"
)
),
ToxicityDetection = list(
list(
ToxicityCategories = list(
"ALL"
)
)
)
)