Long startTime
The time, in milliseconds, when Amazon Transcribe starts searching for the specified criteria in your audio. If
you include StartTime in your request, you must also include EndTime.
Long endTime
The time, in milliseconds, when Amazon Transcribe stops searching for the specified criteria in your audio. If
you include EndTime in your request, you must also include StartTime.
Long first
The time, in milliseconds, from the start of your media file until the value you specify in which Amazon Transcribe searches for your specified criteria.
Long last
The time, in milliseconds, from the value you specify until the end of your media file in which Amazon Transcribe searches for your specified criteria.
String callAnalyticsJobName
The name of the Call Analytics job. Job names are case sensitive and must be unique within an Amazon Web Services account.
String callAnalyticsJobStatus
Provides the status of the specified Call Analytics 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.
String languageCode
The language code used to create your Call Analytics job. For a list of supported languages and their associated language codes, refer to the Supported languages table.
If you don't know the language spoken in your media file, you can omit this field and let Amazon Transcribe automatically identify the language of your media. To improve the accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.
Integer mediaSampleRateHertz
The sample rate, in Hertz, of the audio track in your input media file.
String mediaFormat
The format of the input media file.
Media media
Transcript transcript
Date startTime
The date and time the specified Call Analytics 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.
Date creationTime
The date and time the specified Call Analytics 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.
Date completionTime
The date and time the specified Call Analytics 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.
String failureReason
If CallAnalyticsJobStatus is FAILED, FailureReason contains information
about why the Call Analytics 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 MediaFormat 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 Guidelines and 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 Guidelines and quotas.
String dataAccessRoleArn
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.
IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example:
arn:aws:iam::111122223333:role/Admin.
For more information, see IAM ARNs.
Float 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.
CallAnalyticsJobSettings settings
Allows additional optional settings in your request, including content redaction; allows you to apply custom language models, vocabulary filters, and custom vocabularies to your Call Analytics job.
List<E> channelDefinitions
Allows you to specify which speaker is on which channel in your Call Analytics job request. For example, if your
agent is the first participant to speak, you would set ChannelId to 0 (to indicate the
first channel) and ParticipantRole to AGENT (to indicate that it's the agent speaking).
String vocabularyName
The name of the custom vocabulary you want to include in your Call Analytics transcription request. Vocabulary names are case sensitive.
String vocabularyFilterName
The name of the custom vocabulary filter you want to include in your Call Analytics transcription request. Vocabulary filter names are case sensitive.
Note that if you include VocabularyFilterName in your request, you must also include
VocabularyFilterMethod.
String vocabularyFilterMethod
Specify how you want your vocabulary filter applied to your transcript.
To replace words with ***, choose mask.
To delete words, choose remove.
To flag words without changing them, choose tag.
String languageModelName
The name of the custom language model you want to use when processing your Call Analytics job. Note that language model names are case sensitive.
The language of the specified language model must match the language code you specify in your transcription request. If the languages don't match, the language model isn't applied. There are no errors or warnings associated with a language mismatch.
ContentRedaction contentRedaction
List<E> 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.
Including language options can improve the accuracy of language identification.
For a list of languages supported with Call Analytics, refer to the Supported languages table.
Map<K,V> languageIdSettings
If using automatic language identification (IdentifyLanguage) in your request and you want to apply
a custom language model, a custom vocabulary, or a custom vocabulary filter, include
LanguageIdSettings with the relevant sub-parameters (VocabularyName,
LanguageModelName, and VocabularyFilterName).
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. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters.
To include language options using IdentifyLanguage without including a custom language model,
a custom vocabulary, or a custom vocabulary filter, use LanguageOptions instead of
LanguageIdSettings. Including language options can improve the accuracy of automatic language
identification.
If you want to include a custom language model with your request but do not want to use automatic language
identification, use instead the parameter with the LanguageModelName sub-parameter.
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 instead the
parameter with the VocabularyName or VocabularyFilterName (or both)
sub-parameter.
String callAnalyticsJobName
The name of the Call Analytics job. Job names are case sensitive and must be unique within an Amazon Web Services account.
Date creationTime
The date and time the specified Call Analytics 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.
Date startTime
The date and time your Call Analytics 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.
Date completionTime
The date and time the specified Call Analytics 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.
String languageCode
The language code used to create your Call Analytics transcription.
String callAnalyticsJobStatus
Provides the status of your Call Analytics 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.
String failureReason
If CallAnalyticsJobStatus is FAILED, FailureReason contains information
about why the Call Analytics job failed. See also: Common Errors.
String categoryName
The name of the Call Analytics category. Category names are case sensitive and must be unique within an Amazon Web Services account.
List<E> rules
The rules used to define a Call Analytics category. Each category can have between 1 and 20 rules.
Date createTime
The date and time the specified Call Analytics category was created.
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 12:32 PM UTC-7 on May 4, 2022.
Date lastUpdateTime
The date and time the specified Call Analytics category was last updated.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
2022-05-05T12:45:32.691000-07:00 represents 12:45 PM UTC-7 on May 5, 2022.
String redactionType
Specify the category of information you want to redact; PII (personally identifiable information) is
the only valid value. You can use PiiEntityTypes to choose which types of PII you want to redact.
String redactionOutput
Specify if you want only a redacted transcript, or if you want a redacted and an unredacted transcript.
When you choose redacted Amazon Transcribe creates only a redacted transcript.
When you choose redacted_and_unredacted Amazon Transcribe creates a redacted and an unredacted
transcript (as two separate files).
List<E> piiEntityTypes
Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can
include as many types as you'd like, or you can select ALL.
String categoryName
A unique name, chosen by you, for your Call Analytics category. It's helpful to use a detailed naming system that
will make sense to you in the future. For example, it's better to use
sentiment-positive-last30seconds for a category over a generic name like test-category.
Category names are case sensitive.
List<E> rules
Rules define a Call Analytics category. When creating a new Call Analytics category, you must create between 1 and 20 rules for that category. For each rule, you specify a filter you want applied to the attributes of a call. For example, you can choose a sentiment filter that detects if a customer's sentiment was positive during the last 30 seconds of the call.
CategoryProperties categoryProperties
Provides you with the properties of your new category, including its associated rules.
String languageCode
The language code that represents the language of your model. Each language model must contain terms in only one language, and the language you select for your model must match the language of your training and tuning data.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
Note that U.S. English (en-US) is the only language supported with Amazon Transcribe Medical.
A custom language model can only be used to transcribe files in the same language as the model. For example, if
you create a language model using US English (en-US), you can only apply this model to files that
contain English audio.
String baseModelName
The Amazon Transcribe standard language model, or base model, used to create your custom language model. Amazon Transcribe offers two options for base models: Wideband and Narrowband.
If the audio you want to transcribe has a sample rate of 16,000 Hz or greater, choose WideBand. To
transcribe audio with a sample rate less than 16,000 Hz, choose NarrowBand.
String modelName
A unique name, chosen by you, for your custom language model.
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 language model with the same name as an existing language model, you get a
ConflictException error.
InputDataConfig inputDataConfig
Contains the Amazon S3 location of the training data you want to use to create a new custom language model, and permissions to access this location.
When using InputDataConfig, you must include these sub-parameters: S3Uri, which is the
Amazon S3 location of your training data, and DataAccessRoleArn, which is the Amazon Resource Name
(ARN) of the role that has permission to access your specified Amazon S3 location. You can optionally include
TuningDataS3Uri, which is the Amazon S3 location of your tuning data. If you specify different
Amazon S3 locations for training and tuning data, the ARN you use must have permissions to access both locations.
List<E> tags
Adds one or more custom tags, each in the form of a key:value pair, to a new custom language model at the time you create this new model.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
String languageCode
The language code you selected for your custom language model.
String baseModelName
The Amazon Transcribe standard language model, or base model, you specified when creating your custom language model.
String modelName
The name of your custom language model.
InputDataConfig inputDataConfig
Lists your data access role ARN (Amazon Resource Name) and the Amazon S3 locations you provided for your training
(S3Uri) and tuning (TuningDataS3Uri) data.
String modelStatus
The status of your custom language model. When the status displays as COMPLETED, your model is ready
to use.
String vocabularyName
A unique name, chosen by you, for your new custom medical vocabulary.
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 medical vocabulary with the same name as an existing medical vocabulary, you get a
ConflictException error.
String languageCode
The language code that represents the language of the entries in your custom vocabulary. US English (
en-US) is the only language supported with Amazon Transcribe Medical.
String vocabularyFileUri
The Amazon S3 location (URI) of the text file that contains your custom medical vocabulary. The URI must be in the same Amazon Web Services Region as the resource you're calling.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt
List<E> tags
Adds one or more custom tags, each in the form of a key:value pair, to a new medical vocabulary at the time you create this new vocabulary.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
String vocabularyName
The name you chose for your custom medical vocabulary.
String languageCode
The language code you selected for your medical vocabulary. US English (en-US) is the only language
supported with Amazon Transcribe Medical.
String vocabularyState
The processing state of your custom medical vocabulary. If the state is READY, you can use the
vocabulary in a StartMedicalTranscriptionJob request.
Date lastModifiedTime
The date and time you created your custom medical vocabulary.
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 12:32 PM UTC-7 on May 4, 2022.
String failureReason
If VocabularyState is FAILED, FailureReason contains information about why
the medical transcription job request failed. See also: Common Errors.
String vocabularyFilterName
A unique name, chosen by you, for your new custom vocabulary filter.
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 vocabulary filter with the same name as an existing vocabulary filter, you get a
ConflictException error.
String languageCode
The language code that represents the language of the entries in your vocabulary filter. Each vocabulary filter must contain terms in only one language.
A vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you
create a vocabulary filter using US English (en-US), you can only apply this filter to files that
contain English audio.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
List<E> words
Use this parameter if you want to create your vocabulary filter by including all desired terms, as
comma-separated values, within your request. The other option for creating your vocabulary filter is to save your
entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the
VocabularyFilterFileUri parameter.
Note that if you include Words in your request, you cannot use VocabularyFilterFileUri;
you must choose one or the other.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
String vocabularyFilterFileUri
The Amazon S3 location of the text file that contains your custom vocabulary filter terms. The URI must be located in the same Amazon Web Services Region as the resource you're calling.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt
Note that if you include VocabularyFilterFileUri in your request, you cannot use Words;
you must choose one or the other.
List<E> tags
Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary filter at the time you create this new filter.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
String vocabularyFilterName
The name you chose for your custom vocabulary filter.
String languageCode
The language code you selected for your vocabulary filter.
Date lastModifiedTime
The date and time you created your vocabulary filter.
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 12:32 PM UTC-7 on May 4, 2022.
String vocabularyName
A unique name, chosen by you, for your new custom vocabulary.
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 vocabulary with the same name as an existing vocabulary, you get a
ConflictException error.
String languageCode
The language code that represents the language of the entries in your custom vocabulary. Each vocabulary must contain terms in only one language.
A custom vocabulary can only be used to transcribe files in the same language as the vocabulary. For example, if
you create a vocabulary using US English (en-US), you can only apply this vocabulary to files that
contain English audio.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
List<E> phrases
Use this parameter if you want to create your vocabulary by including all desired terms, as comma-separated
values, within your request. The other option for creating your vocabulary is to save your entries in a text file
and upload them to an Amazon S3 bucket, then specify the location of your file using the
VocabularyFileUri parameter.
Note that if you include Phrases in your request, you cannot use VocabularyFileUri; you
must choose one or the other.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
String vocabularyFileUri
The Amazon S3 location of the text file that contains your custom vocabulary. The URI must be located in the same Amazon Web Services Region as the resource you're calling.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt
Note that if you include VocabularyFileUri in your request, you cannot use the Phrases
flag; you must choose one or the other.
List<E> tags
Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary at the time you create this new vocabulary.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
String vocabularyName
The name you chose for your custom vocabulary.
String languageCode
The language code you selected for your custom vocabulary.
String vocabularyState
The processing state of your custom vocabulary. If the state is READY, you can use the vocabulary in
a StartTranscriptionJob request.
Date lastModifiedTime
The date and time you created your custom vocabulary.
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 12:32 PM UTC-7 on May 4, 2022.
String failureReason
If VocabularyState is FAILED, FailureReason contains information about why
the vocabulary request failed. See also: Common Errors.
String categoryName
The name of the Call Analytics category you want to delete. Category names are case sensitive.
String callAnalyticsJobName
The name of the Call Analytics job you want to delete. Job names are case sensitive.
String modelName
The name of the custom language model you want to delete. Model names are case sensitive.
String medicalTranscriptionJobName
The name of the medical transcription job you want to delete. Job names are case sensitive.
String vocabularyName
The name of the custom medical vocabulary you want to delete. Vocabulary names are case sensitive.
String transcriptionJobName
The name of the transcription job you want to delete. Job names are case sensitive.
String vocabularyFilterName
The name of the custom vocabulary filter you want to delete. Vocabulary filter names are case sensitive.
String vocabularyName
The name of the custom vocabulary you want to delete. Vocabulary names are case sensitive.
String modelName
The name of the custom language model you want information about. Model names are case sensitive.
LanguageModel languageModel
Provides information about the specified custom language model.
This parameter also shows if the base language model you used to create your custom language model has been updated. If Amazon Transcribe has updated the base model, you can create a new custom language model using the updated base model.
If you tried to create a new custom language model and the request wasn't successful, you can use this
DescribeLanguageModel to help identify the reason for this failure.
String categoryName
The name of the Call Analytics category you want information about. Category names are case sensitive.
CategoryProperties categoryProperties
Provides you with the properties of the Call Analytics category you specified in your
GetCallAnalyticsCategory request.
String callAnalyticsJobName
The name of the Call Analytics job you want information about. Job names are case sensitive.
CallAnalyticsJob callAnalyticsJob
Provides detailed information about the specified Call Analytics job, including job status and, if applicable, failure reason.
String medicalTranscriptionJobName
The name of the medical transcription job you want information about. Job names are case sensitive.
MedicalTranscriptionJob medicalTranscriptionJob
Provides detailed information about the specified medical transcription job, including job status and, if applicable, failure reason.
String vocabularyName
The name of the custom medical vocabulary you want information about. Vocabulary names are case sensitive.
String vocabularyName
The name of the custom medical vocabulary you requested information about.
String languageCode
The language code you selected for your medical vocabulary. US English (en-US) is the only language
supported with Amazon Transcribe Medical.
String vocabularyState
The processing state of your custom medical vocabulary. If the state is READY, you can use the
vocabulary in a StartMedicalTranscriptionJob request.
Date lastModifiedTime
The date and time the specified custom medical vocabulary was last modified.
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 12:32 PM UTC-7 on May 4, 2022.
String failureReason
If VocabularyState is FAILED, FailureReason contains information about why
the medical vocabulary request failed. See also: Common Errors.
String downloadUri
The S3 location where the specified medical vocabulary is stored; use this URI to view or download the vocabulary.
String transcriptionJobName
The name of the transcription job you want information about. Job names are case sensitive.
TranscriptionJob transcriptionJob
Provides detailed information about the specified transcription job, including job status and, if applicable, failure reason.
String vocabularyFilterName
The name of the custom vocabulary filter you want information about. Vocabulary filter names are case sensitive.
String vocabularyFilterName
The name of the custom vocabulary filter you requested information about.
String languageCode
The language code you selected for your vocabulary filter.
Date lastModifiedTime
The date and time the specified vocabulary filter was last modified.
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 12:32 PM UTC-7 on May 4, 2022.
String downloadUri
The Amazon S3 location where the vocabulary filter is stored; use this URI to view or download the vocabulary filter.
String vocabularyName
The name of the custom vocabulary you want information about. Vocabulary names are case sensitive.
String vocabularyName
The name of the custom vocabulary you requested information about.
String languageCode
The language code you selected for your custom vocabulary.
String vocabularyState
The processing state of your custom vocabulary. If the state is READY, you can use the vocabulary in
a StartTranscriptionJob request.
Date lastModifiedTime
The date and time the specified vocabulary was last modified.
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 12:32 PM UTC-7 on May 4, 2022.
String failureReason
If VocabularyState is FAILED, FailureReason contains information about why
the vocabulary request failed. See also: Common Errors.
String downloadUri
The S3 location where the vocabulary is stored; use this URI to view or download the vocabulary.
String s3Uri
The Amazon S3 location (URI) of the text files you want to use to train your custom language model.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-training-data/
String tuningDataS3Uri
The Amazon S3 location (URI) of the text files you want to use to tune your custom language model.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/
String dataAccessRoleArn
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.
IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example:
arn:aws:iam::111122223333:role/Admin.
For more information, see IAM ARNs.
Long threshold
Specify the duration of the interruptions in milliseconds. For example, you can flag speech that contains more than 10000 milliseconds of interruptions.
String participantRole
Specify the interrupter you want to flag. Omitting this parameter is equivalent to specifying both participants.
AbsoluteTimeRange absoluteTimeRange
Allows you to specify a time range (in milliseconds) in your audio, during which you want to search for an interruption. See for more detail.
RelativeTimeRange relativeTimeRange
Allows you to specify a time range (in percentage) in your media file, during which you want to search for an interruption. See for more detail.
Boolean negate
Set to TRUE to flag speech that does not contain interruptions. Set to FALSE to flag
speech that contains interruptions.
Boolean allowDeferredExecution
Allows you to enable job queuing when your concurrent request limit is exceeded. When
AllowDeferredExecution is set to true, transcription job requests are placed in a queue
until the number of jobs falls below the concurrent request limit. If AllowDeferredExecution is set
to false and the number of transcription job requests exceed the concurrent request limit, you get a
LimitExceededException error.
Note that job queuing is enabled by default for Call Analytics jobs.
If you include AllowDeferredExecution in your request, you must also include
DataAccessRoleArn.
String dataAccessRoleArn
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.
IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example:
arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs.
Note that if you include DataAccessRoleArn in your request, you must also include
AllowDeferredExecution.
String vocabularyName
The name of the custom vocabulary you want to use when processing your transcription job. Vocabulary names are case sensitive.
The language of the specified vocabulary must match the language code you specify in your transcription request. If the languages don't match, the vocabulary isn't applied. There are no errors or warnings associated with a language mismatch.
String vocabularyFilterName
The name of the custom vocabulary filter you want to use when processing your transcription job. Vocabulary filter names are case sensitive.
The language of the specified vocabulary filter must match the language code you specify in your transcription request. If the languages don't match, the vocabulary filter isn't applied. There are no errors or warnings associated with a language mismatch.
Note that if you include VocabularyFilterName in your request, you must also include
VocabularyFilterMethod.
String languageModelName
The name of the custom language model you want to use when processing your transcription job. Note that language model names are case sensitive.
The language of the specified language model must match the language code you specify in your transcription request. If the languages don't match, the language model isn't applied. There are no errors or warnings associated with a language mismatch.
String modelName
A unique name, chosen by you, for your custom language model.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.
Date createTime
The date and time the specified custom language model was created.
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 12:32 PM UTC-7 on May 4, 2022.
Date lastModifiedTime
The date and time the specified language model was last modified.
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 12:32 PM UTC-7 on May 4, 2022.
String languageCode
The language code used to create your custom language model. Each language model must contain terms in only one language, and the language you select for your model must match the language of your training and tuning data.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
Note that U.S. English (en-US) is the only language supported with Amazon Transcribe Medical.
String baseModelName
The Amazon Transcribe standard language model, or base model, used to create your custom language model.
String modelStatus
The status of the specified custom language model. When the status displays as COMPLETED the model
is ready for use.
Boolean upgradeAvailability
Shows if a more current base model is available for use with the specified custom language model.
If false, your language model is using the most up-to-date base model.
If true, there is a newer base model available than the one your language model is using.
Note that to update a base model, you must recreate the custom language model using the new base model. Base model upgrades for existing custom language models are not supported.
String failureReason
If ModelStatus is FAILED, FailureReason contains information about why the
custom language model request failed. See also: Common Errors.
InputDataConfig inputDataConfig
The Amazon S3 location of the input files used to train and tune your custom language model, in addition to the data access role ARN (Amazon Resource Name) that has permissions to access these data.
String nextToken
If your ListCallAnalyticsCategories request returns more results than can be displayed,
NextToken is displayed in the response with an associated string. To get the next page of results,
copy this string and repeat your request, including NextToken with the value of the copied string.
Repeat as needed to view all your results.
Integer maxResults
The maximum number of Call Analytics categories to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.
String nextToken
If NextToken is present in your response, it indicates that not all results are displayed. To view
the next set of results, copy the string associated with the NextToken parameter in your results
output, then run your request again including NextToken with the value of the copied string. Repeat
as needed to view all your results.
List<E> categories
Provides detailed information about your Call Analytics categories, including all the rules associated with each category.
String status
Returns only Call Analytics jobs with the specified status. Jobs are ordered by creation date, with the newest
job first. If you don't include Status, all Call Analytics jobs are returned.
String jobNameContains
Returns only the Call Analytics jobs that contain the specified string. The search is not case sensitive.
String nextToken
If your ListCallAnalyticsJobs request returns more results than can be displayed,
NextToken is displayed in the response with an associated string. To get the next page of results,
copy this string and repeat your request, including NextToken with the value of the copied string.
Repeat as needed to view all your results.
Integer maxResults
The maximum number of Call Analytics jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.
String status
Lists all Call Analytics jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first.
String nextToken
If NextToken is present in your response, it indicates that not all results are displayed. To view
the next set of results, copy the string associated with the NextToken parameter in your results
output, then run your request again including NextToken with the value of the copied string. Repeat
as needed to view all your results.
List<E> callAnalyticsJobSummaries
Provides a summary of information about each result.
String statusEquals
Returns only custom language models with the specified status. Language models are ordered by creation date, with
the newest model first. If you don't include StatusEquals, all custom language models are returned.
String nameContains
Returns only the custom language models that contain the specified string. The search is not case sensitive.
String nextToken
If your ListLanguageModels request returns more results than can be displayed,
NextToken is displayed in the response with an associated string. To get the next page of results,
copy this string and repeat your request, including NextToken with the value of the copied string.
Repeat as needed to view all your results.
Integer maxResults
The maximum number of custom language models to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.
String nextToken
If NextToken is present in your response, it indicates that not all results are displayed. To view
the next set of results, copy the string associated with the NextToken parameter in your results
output, then run your request again including NextToken with the value of the copied string. Repeat
as needed to view all your results.
List<E> models
Provides information about the custom language models that match the criteria specified in your request.
String status
Returns only medical transcription jobs with the specified status. Jobs are ordered by creation date, with the
newest job first. If you don't include Status, all medical transcription jobs are returned.
String jobNameContains
Returns only the medical transcription jobs that contain the specified string. The search is not case sensitive.
String nextToken
If your ListMedicalTranscriptionJobs request returns more results than can be displayed,
NextToken is displayed in the response with an associated string. To get the next page of results,
copy this string and repeat your request, including NextToken with the value of the copied string.
Repeat as needed to view all your results.
Integer maxResults
The maximum number of medical transcription jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.
String status
Lists all medical transcription jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first.
String nextToken
If NextToken is present in your response, it indicates that not all results are displayed. To view
the next set of results, copy the string associated with the NextToken parameter in your results
output, then run your request again including NextToken with the value of the copied string. Repeat
as needed to view all your results.
List<E> medicalTranscriptionJobSummaries
Provides a summary of information about each result.
String nextToken
If your ListMedicalVocabularies request returns more results than can be displayed,
NextToken is displayed in the response with an associated string. To get the next page of results,
copy this string and repeat your request, including NextToken with the value of the copied string.
Repeat as needed to view all your results.
Integer maxResults
The maximum number of custom medical vocabularies to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.
String stateEquals
Returns only custom medical vocabularies with the specified state. Vocabularies are ordered by creation date,
with the newest vocabulary first. If you don't include StateEquals, all custom medical vocabularies
are returned.
String nameContains
Returns only the custom medical vocabularies that contain the specified string. The search is not case sensitive.
String status
Lists all custom medical vocabularies that have the status specified in your request. Vocabularies are ordered by creation date, with the newest vocabulary first.
String nextToken
If NextToken is present in your response, it indicates that not all results are displayed. To view
the next set of results, copy the string associated with the NextToken parameter in your results
output, then run your request again including NextToken with the value of the copied string. Repeat
as needed to view all your results.
List<E> vocabularies
Provides information about the custom medical vocabularies that match the criteria specified in your request.
String resourceArn
Returns a list of all tags associated with the specified Amazon Resource Name (ARN). ARNs have the format
arn:partition:service:region:account-id:resource-type/resource-id.
For example, arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name.
Valid values for resource-type are: transcription-job,
medical-transcription-job, vocabulary, medical-vocabulary,
vocabulary-filter, and language-model.
String status
Returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest job
first. If you don't include Status, all transcription jobs are returned.
String jobNameContains
Returns only the transcription jobs that contain the specified string. The search is not case sensitive.
String nextToken
If your ListTranscriptionJobs request returns more results than can be displayed,
NextToken is displayed in the response with an associated string. To get the next page of results,
copy this string and repeat your request, including NextToken with the value of the copied string.
Repeat as needed to view all your results.
Integer maxResults
The maximum number of transcription jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.
String status
Lists all transcription jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first.
String nextToken
If NextToken is present in your response, it indicates that not all results are displayed. To view
the next set of results, copy the string associated with the NextToken parameter in your results
output, then run your request again including NextToken with the value of the copied string. Repeat
as needed to view all your results.
List<E> transcriptionJobSummaries
Provides a summary of information about each result.
String nextToken
If your ListVocabularies request returns more results than can be displayed, NextToken
is displayed in the response with an associated string. To get the next page of results, copy this string and
repeat your request, including NextToken with the value of the copied string. Repeat as needed to
view all your results.
Integer maxResults
The maximum number of custom vocabularies to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.
String stateEquals
Returns only custom vocabularies with the specified state. Vocabularies are ordered by creation date, with the
newest vocabulary first. If you don't include StateEquals, all custom medical vocabularies are
returned.
String nameContains
Returns only the custom vocabularies that contain the specified string. The search is not case sensitive.
String status
Lists all custom vocabularies that have the status specified in your request. Vocabularies are ordered by creation date, with the newest vocabulary first.
String nextToken
If NextToken is present in your response, it indicates that not all results are displayed. To view
the next set of results, copy the string associated with the NextToken parameter in your results
output, then run your request again including NextToken with the value of the copied string. Repeat
as needed to view all your results.
List<E> vocabularies
Provides information about the custom vocabularies that match the criteria specified in your request.
String nextToken
If your ListVocabularyFilters request returns more results than can be displayed,
NextToken is displayed in the response with an associated string. To get the next page of results,
copy this string and repeat your request, including NextToken with the value of the copied string.
Repeat as needed to view all your results.
Integer maxResults
The maximum number of custom vocabulary filters to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.
String nameContains
Returns only the custom vocabulary filters that contain the specified string. The search is not case sensitive.
String nextToken
If NextToken is present in your response, it indicates that not all results are displayed. To view
the next set of results, copy the string associated with the NextToken parameter in your results
output, then run your request again including NextToken with the value of the copied string. Repeat
as needed to view all your results.
List<E> vocabularyFilters
Provides information about the custom vocabulary filters that match the criteria specified in your request.
String mediaFileUri
The Amazon S3 location of the media file you want to transcribe. For example:
s3://DOC-EXAMPLE-BUCKET/my-media-file.flac
s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac
Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.
String redactedMediaFileUri
The Amazon S3 location of the media file you want to redact. For example:
s3://DOC-EXAMPLE-BUCKET/my-media-file.flac
s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac
Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.
RedactedMediaFileUri is only supported for Call Analytics (StartCallAnalyticsJob)
transcription requests.
String transcriptFileUri
The Amazon S3 location of your transcript. You can use this URI to access or download your transcript.
If you included OutputBucketName in your transcription job request, this is the URI of that bucket.
If you also included OutputKey in your request, your output is located in the path you specified in
your request.
If you didn't include OutputBucketName in your transcription job request, your transcript is stored
in a service-managed bucket, and TranscriptFileUri provides you with a temporary URI you can use for
secure access to your transcript.
Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 minutes. If you get an
AccesDenied error, you can get a new temporary URI by running a GetTranscriptionJob or
ListTranscriptionJob request.
String medicalTranscriptionJobName
The name of the medical transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.
String transcriptionJobStatus
Provides the status of the specified medical transcription job.
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.
String languageCode
The language code used to create your medical transcription job. US English (en-US) is the only
supported language for medical transcriptions.
Integer mediaSampleRateHertz
The sample rate, in Hertz, of the audio track in your input media file.
String mediaFormat
The format of the input media file.
Media media
MedicalTranscript transcript
Provides you with the Amazon S3 URI you can use to access your transcript.
Date startTime
The date and time the specified medical 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.
Date creationTime
The date and time the specified medical 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.
Date completionTime
The date and time the specified medical 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.
String 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 MediaFormat 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
16,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 Guidelines and 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 Guidelines and quotas.
MedicalTranscriptionSetting settings
Specify additional optional settings in your request, including channel identification, alternative transcriptions, and speaker labeling; allows you to apply custom vocabularies to your medical transcription job.
String contentIdentificationType
Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.
String specialty
Describes the medical specialty represented in your media.
String type
Indicates whether the input media is a dictation or a conversation, as specified in the
StartMedicalTranscriptionJob request.
List<E> tags
The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.
String medicalTranscriptionJobName
The name of the medical transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.
Date creationTime
The date and time the specified medical 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.
Date startTime
The date and time your medical 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.
Date completionTime
The date and time the specified medical 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.
String languageCode
The language code used to create your medical transcription. US English (en-US) is the only
supported language for medical transcriptions.
String transcriptionJobStatus
Provides the status of your medical transcription job.
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.
String failureReason
If TranscriptionJobStatus is FAILED, FailureReason contains information
about why the transcription job failed. See also: Common Errors.
String outputLocationType
Indicates where the specified medical 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 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 field.
String specialty
Provides the medical specialty represented in your media.
String contentIdentificationType
Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.
String type
Indicates whether the input media is a dictation or a conversation, as specified in the
StartMedicalTranscriptionJob request.
Boolean showSpeakerLabels
Enables speaker identification (diarization) in your transcription output. Speaker identification labels the speech from individual speakers in your media file.
If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels
.
You can't include both ShowSpeakerLabels and ChannelIdentification in the same request.
Including both parameters returns a BadRequestException.
For more information, see Identifying speakers (diarization).
Integer maxSpeakerLabels
Specify the maximum number of speakers you want to identify in your media.
Note that if your media contains more speakers than the specified number, multiple speakers will be identified as a single speaker.
If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to
true.
Boolean channelIdentification
Enables channel identification in multi-channel audio.
Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.
If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.
You can't include both ShowSpeakerLabels and ChannelIdentification in the same request.
Including both parameters returns a BadRequestException.
For more information, see Transcribing multi-channel audio.
Boolean showAlternatives
To include alternative transcriptions within your transcription output, include ShowAlternatives in
your transcription request.
If you include ShowAlternatives, you must also include MaxAlternatives, which is the
maximum number of alternative transcriptions you want Amazon Transcribe Medical to generate.
For more information, see Alternative transcriptions.
Integer maxAlternatives
Indicate the maximum number of alternative transcriptions you want Amazon Transcribe Medical to include in your transcript.
If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe Medical, only the actual number of alternative transcriptions are included.
If you include MaxAlternatives in your request, you must also include ShowAlternatives
with a value of true.
For more information, see Alternative transcriptions.
String vocabularyName
The name of the custom vocabulary you want to use when processing your medical transcription job. Vocabulary names are case sensitive.
The language of the specified vocabulary must match the language code you specify in your transcription request.
If the languages don't match, the vocabulary isn't applied. There are no errors or warnings associated with a
language mismatch. US English (en-US) is the only valid language for Amazon Transcribe Medical.
String languageModelName
The name of the custom language model you want to use when processing your transcription job. Note that language model names are case sensitive.
The language of the specified language model must match the language code you specify in your transcription request. If the languages don't match, the language model isn't applied. There are no errors or warnings associated with a language mismatch.
Long threshold
Specify the duration, in milliseconds, of the period of silence you want to flag. For example, you can flag a silent period that lasts 30000 milliseconds.
AbsoluteTimeRange absoluteTimeRange
Allows you to specify a time range (in milliseconds) in your audio, during which you want to search for a period of silence. See for more detail.
RelativeTimeRange relativeTimeRange
Allows you to specify a time range (in percentage) in your media file, during which you want to search for a period of silence. See for more detail.
Boolean negate
Set to TRUE to flag periods of speech. Set to FALSE to flag periods of silence
Integer startPercentage
The time, in percentage, when Amazon Transcribe starts searching for the specified criteria in your media file.
If you include StartPercentage in your request, you must also include EndPercentage.
Integer endPercentage
The time, in percentage, when Amazon Transcribe stops searching for the specified criteria in your media file. If
you include EndPercentage in your request, you must also include StartPercentage.
Integer first
The time, in percentage, from the start of your media file until the value you specify in which Amazon Transcribe searches for your specified criteria.
Integer last
The time, in percentage, from the value you specify until the end of your media file in which Amazon Transcribe searches for your specified criteria.
NonTalkTimeFilter nonTalkTimeFilter
Flag the presence or absence of periods of silence in your Call Analytics transcription output. Refer to for more detail.
InterruptionFilter interruptionFilter
Flag the presence or absence of interruptions in your Call Analytics transcription output. Refer to for more detail.
TranscriptFilter transcriptFilter
Flag the presence or absence of specific words or phrases in your Call Analytics transcription output. Refer to for more detail.
SentimentFilter sentimentFilter
Flag the presence or absence of specific sentiments in your Call Analytics transcription output. Refer to for more detail.
List<E> sentiments
Specify the sentiments you want to flag.
AbsoluteTimeRange absoluteTimeRange
Allows you to specify a time range (in milliseconds) in your audio, during which you want to search for the specified sentiments. See for more detail.
RelativeTimeRange relativeTimeRange
Allows you to specify a time range (in percentage) in your media file, during which you want to search for the specified sentiments. See for more detail.
String participantRole
Specify the participant you want to flag. Omitting this parameter is equivalent to specifying both participants.
Boolean negate
Set to TRUE to flag the sentiments you didn't include in your request. Set to FALSE to
flag the sentiments you specified in your request.
String vocabularyName
The name of the custom vocabulary you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.
Boolean showSpeakerLabels
Enables speaker identification (diarization) in your transcription output. Speaker identification labels the speech from individual speakers in your media file.
If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels
.
You can't include both ShowSpeakerLabels and ChannelIdentification in the same request.
Including both parameters returns a BadRequestException.
For more information, see Identifying speakers (diarization).
Integer maxSpeakerLabels
Specify the maximum number of speakers you want to identify in your media.
Note that if your media contains more speakers than the specified number, multiple speakers will be identified as a single speaker.
If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to
true.
Boolean channelIdentification
Enables channel identification in multi-channel audio.
Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.
You can't include both ShowSpeakerLabels and ChannelIdentification in the same request.
Including both parameters returns a BadRequestException.
For more information, see Transcribing multi-channel audio.
Boolean showAlternatives
To include alternative transcriptions within your transcription output, include ShowAlternatives in
your transcription request.
If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.
If you include ShowAlternatives, you must also include MaxAlternatives, which is the
maximum number of alternative transcriptions you want Amazon Transcribe to generate.
For more information, see Alternative transcriptions.
Integer maxAlternatives
Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.
If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe, only the actual number of alternative transcriptions are included.
If you include MaxAlternatives in your request, you must also include ShowAlternatives
with a value of true.
For more information, see Alternative transcriptions.
String vocabularyFilterName
The name of the custom vocabulary filter you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.
Note that if you include VocabularyFilterName in your request, you must also include
VocabularyFilterMethod.
String vocabularyFilterMethod
Specify how you want your vocabulary filter applied to your transcript.
To replace words with ***, choose mask.
To delete words, choose remove.
To flag words without changing them, choose tag.
String callAnalyticsJobName
A unique name, chosen by you, for your Call Analytics job.
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 ConflictException
error.
Media media
String outputLocation
The Amazon S3 location where you want your Call Analytics transcription output stored. You can use any of the following formats to specify the output location:
s3://DOC-EXAMPLE-BUCKET
s3://DOC-EXAMPLE-BUCKET/my-output-folder/
s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json
Unless you specify a file name (option 3), the name of your output file has a default value that matches the name
you specified for your transcription job using the CallAnalyticsJobName parameter.
You can specify a KMS key to encrypt your output using the OutputEncryptionKMSKeyId parameter. If
you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption.
If you don't specify OutputLocation, your transcript is placed in a service-managed Amazon S3 bucket
and you are provided with a URI to access your transcript.
String outputEncryptionKMSKeyId
The KMS key you want to use to encrypt your Call Analytics output.
If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Use an alias for the KMS key ID. For example, alias/ExampleAlias.
Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
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:
Use the ARN for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
If you don't 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
OutputLocation parameter.
Note that the user making the request must have permission to use the specified KMS key.
String dataAccessRoleArn
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.
IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example:
arn:aws:iam::111122223333:role/Admin.
For more information, see IAM ARNs.
CallAnalyticsJobSettings settings
Specify additional optional settings in your request, including content redaction; allows you to apply custom language models, vocabulary filters, and custom vocabularies to your Call Analytics job.
List<E> channelDefinitions
Allows you to specify which speaker is on which channel. For example, if your agent is the first participant to
speak, you would set ChannelId to 0 (to indicate the first channel) and
ParticipantRole to AGENT (to indicate that it's the agent speaking).
CallAnalyticsJob callAnalyticsJob
Provides detailed information about the current Call Analytics job, including job status and, if applicable, failure reason.
String medicalTranscriptionJobName
A unique name, chosen by you, for your medical transcription job. The name 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 OutputKey parameter.
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 ConflictException
error.
String languageCode
The language code that represents the language spoken in the input media file. US English (en-US) is
the only valid value for medical transcription jobs. Any other value you enter for language code results in a
BadRequestException error.
Integer mediaSampleRateHertz
The sample rate, in Hertz, of the audio track in your input media file.
If you don't specify the media sample rate, Amazon Transcribe Medical determines it for you. If you specify the
sample rate, it must match the rate detected by Amazon Transcribe Medical; if there's a mismatch between the
value you specify and the value detected, your job fails. Therefore, in most cases, it's advised to omit
MediaSampleRateHertz and let Amazon Transcribe Medical determine the sample rate.
String mediaFormat
Specify the format of your input media file.
Media media
String outputBucketName
The name of the Amazon S3 bucket where you want your medical transcription output stored. Do not include the
S3:// prefix of the specified bucket.
If you want your output to go to a sub-folder of this bucket, specify it using the OutputKey
parameter; OutputBucketName only accepts the name of a bucket.
For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set
OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output stored in
S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to
DOC-EXAMPLE-BUCKET and OutputKey to test-files/.
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 don't specify OutputBucketName, your transcript is placed in a service-managed Amazon S3
bucket and you are provided with a URI to access your transcript.
String outputKey
Use in combination with OutputBucketName to specify the output location of your transcript and,
optionally, a unique name for your output file. The default name for your transcription output is the same as the
name you specified for your medical transcription job (MedicalTranscriptionJobName).
Here are some examples of how you can use OutputKey:
If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json' as the
OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json
.
If you specify 'my-first-transcription' as the MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as
the OutputBucketName, and 'my-transcript' as the OutputKey, your transcription output
path is s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.
If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'test-files/my-transcript.json' as
the OutputKey, your transcription output path is
s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.
If you specify 'my-first-transcription' as the MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as
the OutputBucketName, and 'test-files/my-transcript' as the OutputKey, your
transcription output path is
s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.
If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.
String outputEncryptionKMSKeyId
The KMS key you want to use to encrypt your medical 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:
Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Use an alias for the KMS key ID. For example, alias/ExampleAlias.
Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
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:
Use the ARN for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
If you don't 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
OutputLocation parameter.
Note that the user making the request must have permission to use the specified KMS key.
Map<K,V> 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.
MedicalTranscriptionSetting settings
Specify additional optional settings in your request, including channel identification, alternative transcriptions, and speaker labeling; allows you to apply custom vocabularies to your transcription job.
String contentIdentificationType
Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.
String specialty
Specify the predominant medical specialty represented in your media. For batch transcriptions,
PRIMARYCARE is the only valid value. If you require additional specialties, refer to .
String type
Specify whether your input media contains only one person (DICTATION) or contains a conversation
between two people (CONVERSATION).
For example, DICTATION could be used for a medical professional wanting to transcribe voice memos;
CONVERSATION could be used for transcribing the doctor-patient dialogue during the patient's office
visit.
List<E> tags
Adds one or more custom tags, each in the form of a key:value pair, to a new medical transcription job at the time you start this new job.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
MedicalTranscriptionJob medicalTranscriptionJob
Provides detailed information about the current medical transcription job, including job status and, if applicable, failure reason.
String transcriptionJobName
A unique name, chosen by you, for your transcription job. The name 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
OutputKey parameter.
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 ConflictException
error.
String 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 IdentifyLanguage or
IdentifyMultipleLanguages to enable automatic language identification.
Note that you must include one of LanguageCode, IdentifyLanguage, or
IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your
transcription job fails.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample
rate of 16,000 Hz or higher.
Integer mediaSampleRateHertz
The sample rate, in Hertz, of the audio track in your input media file.
If you don't 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 you specify
and the value detected, your job fails. Therefore, in most cases, it's advised to omit
MediaSampleRateHertz and let Amazon Transcribe determine the sample rate.
String mediaFormat
Specify the format of your input media file.
Media media
Describes the Amazon S3 location of the media file you want to use in your request.
String outputBucketName
The name of the Amazon S3 bucket where you want your transcription output stored. Do not include the
S3:// prefix of the specified bucket.
If you want your output to go to a sub-folder of this bucket, specify it using the OutputKey
parameter; OutputBucketName only accepts the name of a bucket.
For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set
OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output stored in
S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to
DOC-EXAMPLE-BUCKET and OutputKey to test-files/.
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 don't specify OutputBucketName, your transcript is placed in a service-managed Amazon S3
bucket and you are provided with a URI to access your transcript.
String outputKey
Use in combination with OutputBucketName to specify the output location of your transcript and,
optionally, a unique name for your output file. The default name for your transcription output is the same as the
name you specified for your transcription job (TranscriptionJobName).
Here are some examples of how you can use OutputKey:
If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json' as the
OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json
.
If you specify 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the
OutputBucketName, and 'my-transcript' as the OutputKey, your transcription output path
is s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.
If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'test-files/my-transcript.json' as
the OutputKey, your transcription output path is
s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.
If you specify 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the
OutputBucketName, and 'test-files/my-transcript' as the OutputKey, your transcription
output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.
If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.
String 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:
Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Use an alias for the KMS key ID. For example, alias/ExampleAlias.
Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
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:
Use the ARN for the KMS key ID. For example,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
If you don't 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
OutputLocation parameter.
Note that the user making the request must have permission to use the specified KMS key.
Map<K,V> 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 settings
Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker labeling; allows you 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 Settings with the
VocabularyName or VocabularyFilterName (or both) sub-parameter.
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 LanguageModelName, VocabularyName or
VocabularyFilterName sub-parameters.
ModelSettings modelSettings
Specify the custom language model you want to include with your transcription job. If you include
ModelSettings in your request, you must include the LanguageModelName sub-parameter.
For more information, see Custom language models.
JobExecutionSettings jobExecutionSettings
Allows you to control how your transcription job is processed. Currently, the only
JobExecutionSettings modification you can choose is enabling job queueing using the
AllowDeferredExecution sub-parameter.
If you include JobExecutionSettings in your request, you must also include the sub-parameters:
AllowDeferredExecution and DataAccessRoleArn.
ContentRedaction contentRedaction
Allows you to redact or flag specified personally identifiable information (PII) in your transcript. If you use
ContentRedaction, you must also include the sub-parameters: PiiEntityTypes,
RedactionOutput, and RedactionType.
Boolean identifyLanguage
Enables automatic language identification in your transcription job request.
If you include IdentifyLanguage, you can optionally include a list of language codes, using
LanguageOptions, that you think may be present in your media file. Including language options can
improve transcription accuracy.
If you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter to your
automatic language identification request, include LanguageIdSettings with the relevant
sub-parameters (VocabularyName, LanguageModelName, and
VocabularyFilterName).
Note that you must include one of LanguageCode, IdentifyLanguage, or
IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your
transcription job fails.
Boolean identifyMultipleLanguages
Enables automatic multi-language identification in your transcription job request. Use this parameter if your media file contains more than one language.
If you include IdentifyMultipleLanguages, you can optionally include a list of language codes, using
LanguageOptions, that you think may be present in your media file. Including language options can
improve transcription accuracy.
If you want to apply a custom vocabulary or a custom vocabulary filter to your automatic language identification
request, include LanguageIdSettings with the relevant sub-parameters (VocabularyName
and VocabularyFilterName).
Note that you must include one of LanguageCode, IdentifyLanguage, or
IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your
transcription job fails.
List<E> 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 LanguageOptions in your request, you must also include IdentifyLanguage.
For more information, refer to Supported languages.
To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample
rate of 16,000 Hz or higher.
Subtitles subtitles
Produces subtitle files for your input media. You can specify WebVTT (*.vtt) and SubRip (*.srt) formats.
List<E> 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.
Map<K,V> languageIdSettings
If using automatic language identification (IdentifyLanguage) in your request and you want to apply
a custom language model, a custom vocabulary, or a custom vocabulary filter, include
LanguageIdSettings with the relevant sub-parameters (VocabularyName,
LanguageModelName, and VocabularyFilterName).
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. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters.
To include language options using IdentifyLanguage without including a custom language model,
a custom vocabulary, or a custom vocabulary filter, use LanguageOptions instead of
LanguageIdSettings. Including language options can improve the accuracy of automatic language
identification.
If you want to include a custom language model with your request but do not want to use automatic language
identification, use instead the parameter with the LanguageModelName sub-parameter.
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 instead the
parameter with the VocabularyName or VocabularyFilterName (or both)
sub-parameter.
TranscriptionJob transcriptionJob
Provides detailed information about the current transcription job, including job status and, if applicable, failure reason.
List<E> formats
Specify the output format for your subtitle file; if you select both WebVTT (vtt) and SubRip (
srt) formats, two output files are generated.
Integer outputStartIndex
Specify the starting value that is assigned to the first subtitle segment.
The default start index for Amazon Transcribe is 0, which differs from the more widely used standard
of 1. If you're uncertain which value to use, we recommend choosing 1, as this may
improve compatibility with other services.
List<E> formats
Provides the format of your subtitle files. If your request included both WebVTT (vtt) and SubRip (
srt) formats, both formats are shown.
List<E> subtitleFileUris
The Amazon S3 location of your transcript. You can use this URI to access or download your subtitle file. Your subtitle file is stored in the same location as your transcript. If you specified both WebVTT and SubRip subtitle formats, two URIs are provided.
If you included OutputBucketName in your transcription job request, this is the URI of that bucket.
If you also included OutputKey in your request, your output is located in the path you specified in
your request.
If you didn't include OutputBucketName in your transcription job request, your subtitle file is
stored in a service-managed bucket, and TranscriptFileUri provides you with a temporary URI you can
use for secure access to your subtitle file.
Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 minutes. If you get an
AccesDenied error, you can get a new temporary URI by running a GetTranscriptionJob or
ListTranscriptionJob request.
Integer outputStartIndex
Provides the start index value for your subtitle files. If you did not specify a value in your request, the
default value of 0 is used.
String key
The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag
Department:Sales, the key is 'Department'.
String value
The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag
Department:Sales, the value is 'Sales'.
Note that you can set the value of a tag to an empty string, but you can't set the value of a tag to null. Omitting the tag value is the same as using an empty string.
String resourceArn
The Amazon Resource Name (ARN) of the resource you want to tag. ARNs have the format
arn:partition:service:region:account-id:resource-type/resource-id.
For example, arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name.
Valid values for resource-type are: transcription-job,
medical-transcription-job, vocabulary, medical-vocabulary,
vocabulary-filter, and language-model.
List<E> tags
Adds one or more custom tags, each in the form of a key:value pair, to the specified resource.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
String transcriptFileUri
The Amazon S3 location of your transcript. You can use this URI to access or download your transcript.
If you included OutputBucketName in your transcription job request, this is the URI of that bucket.
If you also included OutputKey in your request, your output is located in the path you specified in
your request.
If you didn't include OutputBucketName in your transcription job request, your transcript is stored
in a service-managed bucket, and TranscriptFileUri provides you with a temporary URI you can use for
secure access to your transcript.
Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 minutes. If you get an
AccesDenied error, you can get a new temporary URI by running a GetTranscriptionJob or
ListTranscriptionJob request.
String redactedTranscriptFileUri
The Amazon S3 location of your redacted transcript. You can use this URI to access or download your transcript.
If you included OutputBucketName in your transcription job request, this is the URI of that bucket.
If you also included OutputKey in your request, your output is located in the path you specified in
your request.
If you didn't include OutputBucketName in your transcription job request, your transcript is stored
in a service-managed bucket, and RedactedTranscriptFileUri provides you with a temporary URI you can
use for secure access to your transcript.
Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 minutes. If you get an
AccesDenied error, you can get a new temporary URI by running a GetTranscriptionJob or
ListTranscriptionJob request.
String transcriptFilterType
Flag the presence or absence of an exact match to the phrases you specify. For example, if you specify the phrase
"speak to a manager" as your Targets value, only that exact phrase is flagged.
Note that semantic matching is not supported. For example, if your customer says "speak to the manager", instead of "speak to a manager", your content is not flagged.
AbsoluteTimeRange absoluteTimeRange
Allows you to specify a time range (in milliseconds) in your audio, during which you want to search for the specified key words or phrases. See for more detail.
RelativeTimeRange relativeTimeRange
Allows you to specify a time range (in percentage) in your media file, during which you want to search for the specified key words or phrases. See for more detail.
String participantRole
Specify the participant you want to flag. Omitting this parameter is equivalent to specifying both participants.
Boolean negate
Set to TRUE to flag the absence of the phrase you specified in your request. Set to
FALSE to flag the presence of the phrase you specified in your request.
List<E> targets
Specify the phrases you want to flag.
String transcriptionJobName
The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.
String 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.
String languageCode
The language code used to create your transcription job. For a list of supported languages and their associated language codes, refer to the Supported languages table.
Note that you must include one of LanguageCode, IdentifyLanguage, or
IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your
transcription job fails.
Integer mediaSampleRateHertz
The sample rate, in Hertz, of the audio track in your input media file.
String mediaFormat
The format of the input media file.
Media media
Describes the Amazon S3 location of the media file you want to use in your request.
Transcript transcript
Provides you with the Amazon S3 URI you can use to access your transcript.
Date 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.
Date 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.
Date 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.
String 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 MediaFormat 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 Guidelines and 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 Guidelines and quotas.
Settings settings
Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker labeling; allows you 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 Settings with the
VocabularyName or VocabularyFilterName (or both) sub-parameter.
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, do not use the Settings parameter; use instead
the parameter with the LanguageModelName, VocabularyName or
VocabularyFilterName sub-parameters.
ModelSettings modelSettings
The custom language model you want to include with your transcription job. If you include
ModelSettings in your request, you must include the LanguageModelName sub-parameter.
JobExecutionSettings jobExecutionSettings
Provides information about how your transcription job is being processed. This parameter shows if your request is queued and what data access role is being used.
ContentRedaction contentRedaction
Redacts or flags specified personally identifiable information (PII) in your transcript.
Boolean identifyLanguage
Indicates whether automatic language identification was enabled (TRUE) for the specified
transcription job.
Boolean identifyMultipleLanguages
Indicates whether automatic multi-language identification was enabled (TRUE) for the specified
transcription job.
List<E> 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 LanguageOptions in your request, you must also include IdentifyLanguage.
For more information, refer to Supported languages.
To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample
rate of 16,000 Hz or higher.
Float 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.
List<E> 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.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
List<E> 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.
SubtitlesOutput subtitles
Generate subtitles for your media file with your transcription request.
Map<K,V> languageIdSettings
If using automatic language identification (IdentifyLanguage) in your request and you want to apply
a custom language model, a custom vocabulary, or a custom vocabulary filter, include
LanguageIdSettings with the relevant sub-parameters (VocabularyName,
LanguageModelName, and VocabularyFilterName).
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. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters.
To include language options using IdentifyLanguage without including a custom language model,
a custom vocabulary, or a custom vocabulary filter, use LanguageOptions instead of
LanguageIdSettings. Including language options can improve the accuracy of automatic language
identification.
If you want to include a custom language model with your request but do not want to use automatic language
identification, use instead the parameter with the LanguageModelName sub-parameter.
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 instead the
parameter with the VocabularyName or VocabularyFilterName (or both)
sub-parameter.
String transcriptionJobName
The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.
Date 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.
Date 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.
Date 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.
String languageCode
The language code used to create your transcription.
String 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.
String failureReason
If TranscriptionJobStatus is FAILED, FailureReason contains information
about why the transcription job failed. See also: Common Errors.
String 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 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.
ContentRedaction contentRedaction
The content redaction settings of the transcription job.
ModelSettings modelSettings
Boolean identifyLanguage
Indicates whether automatic language identification was enabled (TRUE) for the specified
transcription job.
Boolean identifyMultipleLanguages
Indicates whether automatic multi-language identification was enabled (TRUE) for the specified
transcription job.
Float 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.
List<E> 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.
String resourceArn
The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to remove tags from. ARNs have the
format arn:partition:service:region:account-id:resource-type/resource-id.
For example, arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name.
Valid values for resource-type are: transcription-job,
medical-transcription-job, vocabulary, medical-vocabulary,
vocabulary-filter, and language-model.
List<E> tagKeys
Removes the specified tag keys from the specified Amazon Transcribe resource.
String categoryName
The name of the Call Analytics category you want to update. Category names are case sensitive.
List<E> rules
The rules used for the updated Call Analytics category. The rules you provide in this field replace the ones that are currently being used in the specified category.
CategoryProperties categoryProperties
Provides you with the properties of the Call Analytics category you specified in your
UpdateCallAnalyticsCategory request.
String vocabularyName
The name of the custom medical vocabulary you want to update. Vocabulary names are case sensitive.
String languageCode
The language code that represents the language of the entries in the custom vocabulary you want to update. US
English (en-US) is the only language supported with Amazon Transcribe Medical.
String vocabularyFileUri
The Amazon S3 location of the text file that contains your custom medical vocabulary. The URI must be located in the same Amazon Web Services Region as the resource you're calling.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt
String vocabularyName
The name of the updated custom medical vocabulary.
String languageCode
The language code you selected for your medical vocabulary. US English (en-US) is the only language
supported with Amazon Transcribe Medical.
Date lastModifiedTime
The date and time the specified custom medical vocabulary was last updated.
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 12:32 PM UTC-7 on May 4, 2022.
String vocabularyState
The processing state of your custom medical vocabulary. If the state is READY, you can use the
vocabulary in a StartMedicalTranscriptionJob request.
String vocabularyFilterName
The name of the custom vocabulary filter you want to update. Vocabulary filter names are case sensitive.
List<E> words
Use this parameter if you want to update your vocabulary filter by including all desired terms, as
comma-separated values, within your request. The other option for updating your vocabulary filter is to save your
entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the
VocabularyFilterFileUri parameter.
Note that if you include Words in your request, you cannot use VocabularyFilterFileUri;
you must choose one or the other.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
String vocabularyFilterFileUri
The Amazon S3 location of the text file that contains your custom vocabulary filter terms. The URI must be located in the same Amazon Web Services Region as the resource you're calling.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt
Note that if you include VocabularyFilterFileUri in your request, you cannot use Words;
you must choose one or the other.
String vocabularyFilterName
The name of the updated custom vocabulary filter.
String languageCode
The language code you selected for your vocabulary filter.
Date lastModifiedTime
The date and time the specified vocabulary filter was last updated.
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 12:32 PM UTC-7 on May 4, 2022.
String vocabularyName
The name of the custom vocabulary you want to update. Vocabulary names are case sensitive.
String languageCode
The language code that represents the language of the entries in the custom vocabulary you want to update. Each vocabulary must contain terms in only one language.
A custom vocabulary can only be used to transcribe files in the same language as the vocabulary. For example, if
you create a vocabulary using US English (en-US), you can only apply this vocabulary to files that
contain English audio.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
List<E> phrases
Use this parameter if you want to update your vocabulary by including all desired terms, as comma-separated
values, within your request. The other option for updating your vocabulary is to save your entries in a text file
and upload them to an Amazon S3 bucket, then specify the location of your file using the
VocabularyFileUri parameter.
Note that if you include Phrases in your request, you cannot use VocabularyFileUri; you
must choose one or the other.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
String vocabularyFileUri
The Amazon S3 location of the text file that contains your custom vocabulary. The URI must be located in the same Amazon Web Services Region as the resource you're calling.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt
Note that if you include VocabularyFileUri in your request, you cannot use the Phrases
flag; you must choose one or the other.
String vocabularyName
The name of the updated custom vocabulary.
String languageCode
The language code you selected for your custom vocabulary.
Date lastModifiedTime
The date and time the specified vocabulary was last updated.
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 12:32 PM UTC-7 on May 4, 2022.
String vocabularyState
The processing state of your custom vocabulary. If the state is READY, you can use the vocabulary in
a StartTranscriptionJob request.
String vocabularyFilterName
A unique name, chosen by you, for your custom vocabulary filter. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.
String languageCode
The language code that represents the language of the entries in your vocabulary filter. Each vocabulary filter must contain terms in only one language.
A vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you
create a vocabulary filter using US English (en-US), you can only apply this filter to files that
contain English audio.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
Date lastModifiedTime
The date and time the specified vocabulary filter was last modified.
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 12:32 PM UTC-7 on May 4, 2022.
String vocabularyName
A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.
String languageCode
The language code used to create your custom vocabulary. Each vocabulary must contain terms in only one language.
A custom vocabulary can only be used to transcribe files in the same language as the vocabulary. For example, if
you create a vocabulary using US English (en-US), you can only apply this vocabulary to files that
contain English audio.
Date lastModifiedTime
The date and time the specified vocabulary was last modified.
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 12:32 PM UTC-7 on May 4, 2022.
String vocabularyState
The processing state of your custom vocabulary. If the state is READY, you can use the vocabulary in
a StartTranscriptionJob request.
Copyright © 2022. All rights reserved.