String vocabularyName
The name of the vocabulary. The name must be unique within an AWS account. The name is case-sensitive.
Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+
String languageCode
The language code of the vocabulary entries.
Constraints:
Allowed Values: en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR,
fr-FR, it-IT, ko-KR, es-ES, en-IN, hi-IN, ar-SA, ru-RU, zh-CN
List<E> phrases
An array of strings that contains the vocabulary entries.
String vocabularyFileUri
The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is
https://s3-<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
For example:
https://s3-us-east-1.amazonaws.com/examplebucket/vocab.txt
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
For more information about custom vocabularies, see Custom Vocabularies.
Constraints:
Length: 1 - 2000
String vocabularyName
The name of the vocabulary.
Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+
String languageCode
The language code of the vocabulary entries.
Constraints:
Allowed Values: en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR,
fr-FR, it-IT, ko-KR, es-ES, en-IN, hi-IN, ar-SA, ru-RU, zh-CN
String vocabularyState
The processing state of the vocabulary. When the
VocabularyState field contains READY the
vocabulary is ready to be used in a StartTranscriptionJob
request.
Constraints:
Allowed Values: PENDING, READY, FAILED
Date lastModifiedTime
The date and time that the vocabulary was created.
String failureReason
If the VocabularyState field is FAILED, this
field contains information about why the job failed.
String transcriptionJobName
The name of the transcription job to be deleted.
Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+
String vocabularyName
The name of the vocabulary to delete.
Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+
String transcriptionJobName
The name of the job.
Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+
TranscriptionJob transcriptionJob
An object that contains the results of the transcription job.
String vocabularyName
The name of the vocabulary to return information about. The name is case-sensitive.
Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+
String vocabularyName
The name of the vocabulary to return.
Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+
String languageCode
The language code of the vocabulary entries.
Constraints:
Allowed Values: en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR,
fr-FR, it-IT, ko-KR, es-ES, en-IN, hi-IN, ar-SA, ru-RU, zh-CN
String vocabularyState
The processing state of the vocabulary.
Constraints:
Allowed Values: PENDING, READY, FAILED
Date lastModifiedTime
The date and time that the vocabulary was last modified.
String failureReason
If the VocabularyState field is FAILED, this
field contains information about why the job failed.
String downloadUri
The S3 location where the vocabulary is stored. Use this URI to get the contents of the vocabulary. The URI is available for a limited time.
Constraints:
Length: 1 - 2000
String status
When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.
Constraints:
Allowed Values: IN_PROGRESS, FAILED, COMPLETED
String jobNameContains
When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+
String nextToken
If the result of the previous request to
ListTranscriptionJobs was truncated, include the
NextToken to fetch the next set of jobs.
Constraints:
Length: - 8192
Integer maxResults
The maximum number of jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.
Constraints:
Range: 1 - 100
String status
The requested status of the jobs returned.
Constraints:
Allowed Values: IN_PROGRESS, FAILED, COMPLETED
String nextToken
The ListTranscriptionJobs operation returns a page of jobs
at a time. The maximum size of the page is set by the
MaxResults parameter. If there are more jobs in the list
than the page size, Amazon Transcribe returns the NextPage
token. Include the token in the next request to the
ListTranscriptionJobs operation to return in the next page
of jobs.
Constraints:
Length: - 8192
List<E> transcriptionJobSummaries
A list of objects containing summary information for a transcription job.
String nextToken
If the result of the previous request to ListVocabularies
was truncated, include the NextToken to fetch the next set
of jobs.
Constraints:
Length: - 8192
Integer maxResults
The maximum number of vocabularies to return in the response. If there are fewer results in the list, this response contains only the actual results.
Constraints:
Range: 1 - 100
String stateEquals
When specified, only returns vocabularies with the
VocabularyState field equal to the specified state.
Constraints:
Allowed Values: PENDING, READY, FAILED
String nameContains
When specified, the vocabularies returned in the list are limited to
vocabularies whose name contains the specified string. The search is
case-insensitive, ListVocabularies will return both
"vocabularyname" and "VocabularyName" in the response list.
Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+
String status
The requested vocabulary state.
Constraints:
Allowed Values: IN_PROGRESS, FAILED, COMPLETED
String nextToken
The ListVocabularies operation returns a page of
vocabularies at a time. The maximum size of the page is set by the
MaxResults parameter. If there are more jobs in the list
than the page size, Amazon Transcribe returns the NextPage
token. Include the token in the next request to the
ListVocabularies operation to return in the next page of
jobs.
Constraints:
Length: - 8192
List<E> vocabularies
A list of objects that describe the vocabularies that match the search criteria in the request.
String mediaFileUri
The S3 location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:
https://s3-<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
For example:
https://s3-us-east-1.amazonaws.com/examplebucket/example.mp4
https://s3-us-east-1.amazonaws.com/examplebucket/mediadocs/example.mp4
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
Constraints:
Length: 1 - 2000
String vocabularyName
The name of a vocabulary to use when processing the transcription job.
Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+
Boolean showSpeakerLabels
Determines whether the transcription job uses speaker recognition to
identify different speakers in the input audio. Speaker recognition
labels individual speakers in the audio file. If you set the
ShowSpeakerLabels field to true, you must also set the
maximum number of speaker labels MaxSpeakerLabels field.
You can't set both ShowSpeakerLabels and
ChannelIdentification in the same request. If you set both,
your request returns a BadRequestException.
Integer maxSpeakerLabels
The maximum number of speakers to identify in the input audio. If there
are more speakers in the audio than this number, multiple speakers will
be identified as a single speaker. If you specify the
MaxSpeakerLabels field, you must set the
ShowSpeakerLabels field to true.
Constraints:
Range: 2 - 10
Boolean channelIdentification
Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.
You can't set both ShowSpeakerLabels and
ChannelIdentification in the same request. If you set both,
your request returns a BadRequestException.
String transcriptionJobName
The name of the job. Note that you can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an AWS account.
Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+
String languageCode
The language code for the language used in the input media file.
Constraints:
Allowed Values: en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR,
fr-FR, it-IT, ko-KR, es-ES, en-IN, hi-IN, ar-SA, ru-RU, zh-CN
Integer mediaSampleRateHertz
The sample rate of the audio track in the input media file in Hertz.
If you do not specify the media sample rate, Amazon Transcribe determines
the sample rate. If you specify the sample rate, it must match the sample
rate detected by Amazon Transcribe. In most cases, you should leave the
MediaSampleRateHertz field blank and let Amazon Transcribe
determine the sample rate.
Constraints:
Range: 8000 - 48000
String mediaFormat
The format of the input media file.
If you do not specify the format of the media file, Amazon Transcribe
determines the format. If the format is not recognized, Amazon Transcribe
returns an InternalFailureException exception. If you
specify the format, it must match the format detected by Amazon
Transcribe, otherwise you get an InternalFailureException
exception.
Constraints:
Allowed Values: mp3, mp4, wav, flac
Media media
An object that describes the input media for a transcription job.
String outputBucketName
The location where the transcription is stored.
If you set the OutputBucketName, Amazon Transcribe puts the
transcription in the specified S3 bucket. When you call the
GetTranscriptionJob operation, the operation returns this location
in the TranscriptFileUri field. The S3 bucket must have
permissions that allow Amazon Transcribe to put files in the bucket. For
more information, see Permissions Required for IAM User Roles.
Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket. You can't specify your own encryption key.
If you don't set the OutputBucketName, Amazon Transcribe
generates a pre-signed URL, a shareable URL that provides secure access
to your transcription, and returns it in the
TranscriptFileUri field. Use this URL to download the
transcription.
Constraints:
Pattern: [a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]
Settings settings
A Settings object that provides optional settings for a
transcription job.
TranscriptionJob transcriptionJob
An object containing details of the asynchronous transcription job.
String transcriptFileUri
The location where the transcription is stored.
Use this URI to access the transcription. If you specified an S3 bucket
in the OutputBucketName field when you created the job, this
is the URI of that bucket. If you chose to store the transcription in
Amazon Transcribe, this is a shareable URL that provides secure access to
that location.
Constraints:
Length: 1 - 2000
String transcriptionJobName
The name of the transcription job.
Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+
String transcriptionJobStatus
The status of the transcription job.
Constraints:
Allowed Values: IN_PROGRESS, FAILED, COMPLETED
String languageCode
The language code for the input speech.
Constraints:
Allowed Values: en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR,
fr-FR, it-IT, ko-KR, es-ES, en-IN, hi-IN, ar-SA, ru-RU, zh-CN
Integer mediaSampleRateHertz
The sample rate, in Hertz, of the audio track in the input media file.
Constraints:
Range: 8000 - 48000
String mediaFormat
The format of the input media file.
Constraints:
Allowed Values: mp3, mp4, wav, flac
Media media
An object that describes the input media for the transcription job.
Transcript transcript
An object that describes the output of the transcription job.
Date creationTime
A timestamp that shows when the job was created.
Date completionTime
A timestamp that shows when the job was completed.
String failureReason
If the TranscriptionJobStatus field is FAILED,
this field contains information about why the job failed.
The FailureReason field can contain one of the following
values:
Unsupported media format - The media format specified in the
MediaFormat field of the request isn't valid. See the
description of the MediaFormat field for a list of valid
values.
The media format provided does not match the detected media format
- The media format of the audio file doesn't match the format specified
in the MediaFormat field in the request. Check the media
format of your media file and make sure that the two values match.
Invalid sample rate for audio file - The sample rate
specified in the MediaSampleRateHertz of the request isn't
valid. The sample rate must be between 8000 and 48000 Hertz.
The sample rate provided does not match the detected sample rate
- The sample rate in the audio file doesn't match the sample rate
specified in the MediaSampleRateHertz field in the request.
Check the sample rate of your media file and make sure that the two
values match.
Invalid file size: file size too large - The size of your
audio file is larger than Amazon Transcribe can process. For more
information, see Limits in the Amazon Transcribe Developer Guide.
Invalid number of channels: number of channels too large -
Your audio contains more channels than Amazon Transcribe is configured to
process. To request additional channels, see Amazon Transcribe Limits in the Amazon Web Services General
Reference.
Settings settings
Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.
String transcriptionJobName
The name of the transcription job.
Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+
Date creationTime
A timestamp that shows when the job was created.
Date completionTime
A timestamp that shows when the job was completed.
String languageCode
The language code for the input speech.
Constraints:
Allowed Values: en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR,
fr-FR, it-IT, ko-KR, es-ES, en-IN, hi-IN, ar-SA, ru-RU, zh-CN
String transcriptionJobStatus
The status of the transcription job. When the status is
COMPLETED, use the GetTranscriptionJob
operation to get the results of the transcription.
Constraints:
Allowed Values: IN_PROGRESS, FAILED, COMPLETED
String failureReason
If the TranscriptionJobStatus field is FAILED,
a description of the error.
String outputLocationType
Indicates the location of the output of the transcription job.
If the value is CUSTOMER_BUCKET then the location is the S3
bucket specified in the outputBucketName field when the
transcription job was started with the StartTranscriptionJob
operation.
If the value is SERVICE_BUCKET then the output is stored by
Amazon Transcribe and can be retrieved using the URI in the
GetTranscriptionJob response's
TranscriptFileUri field.
Constraints:
Allowed Values: CUSTOMER_BUCKET, SERVICE_BUCKET
String vocabularyName
The name of the vocabulary to update. The name is case-sensitive.
Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+
String languageCode
The language code of the vocabulary entries.
Constraints:
Allowed Values: en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR,
fr-FR, it-IT, ko-KR, es-ES, en-IN, hi-IN, ar-SA, ru-RU, zh-CN
List<E> phrases
An array of strings containing the vocabulary entries.
String vocabularyFileUri
The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is
https://s3-<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
For example:
https://s3-us-east-1.amazonaws.com/examplebucket/vocab.txt
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
For more information about custom vocabularies, see Custom Vocabularies.
Constraints:
Length: 1 - 2000
String vocabularyName
The name of the vocabulary that was updated.
Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+
String languageCode
The language code of the vocabulary entries.
Constraints:
Allowed Values: en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR,
fr-FR, it-IT, ko-KR, es-ES, en-IN, hi-IN, ar-SA, ru-RU, zh-CN
Date lastModifiedTime
The date and time that the vocabulary was updated.
String vocabularyState
The processing state of the vocabulary. When the
VocabularyState field contains READY the
vocabulary is ready to be used in a StartTranscriptionJob
request.
Constraints:
Allowed Values: PENDING, READY, FAILED
String vocabularyName
The name of the vocabulary.
Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+
String languageCode
The language code of the vocabulary entries.
Constraints:
Allowed Values: en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR,
fr-FR, it-IT, ko-KR, es-ES, en-IN, hi-IN, ar-SA, ru-RU, zh-CN
Date lastModifiedTime
The date and time that the vocabulary was last modified.
String vocabularyState
The processing state of the vocabulary. If the state is
READY you can use the vocabulary in a
StartTranscriptionJob request.
Constraints:
Allowed Values: PENDING, READY, FAILED
Copyright © 2019. All rights reserved.