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
List<E> phrases
An array of strings that contains the vocabulary entries.
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
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 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
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.
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://<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 should use speaker recognition
to identify different speakers in the input audio. If you set the
ShowSpeakerLabels field to true, you must also set the
maximum number of speaker labels MaxSpeakerLabels field.
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
String transcriptionJobName
The name of the job. The name must 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
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 a transcription job.
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 S3 location where the transcription result is stored. Use this URI to access the results of the transcription job.
Constraints:
Length: 1 - 2000
String transcriptionJobName
A name to identify 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
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 a transcription job.
Transcript transcript
An object that describes the output of the transcription job.
Date creationTime
Timestamp of the date and time that the job was created.
Date completionTime
Timestamp of the date and time that the job completed.
String failureReason
If the TranscriptionJobStatus field is FAILED,
this field contains information about why the job failed.
Settings settings
Optional settings for the transcription job.
String transcriptionJobName
The name assigned to the transcription job when it was created.
Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+
Date creationTime
Timestamp of the date and time that the job was created.
Date completionTime
Timestamp of the date and time that the job completed.
String languageCode
The language code for the input speech.
Constraints:
Allowed Values: en-US, es-US
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,
this field contains a description of the error.
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
List<E> phrases
An array of strings containing the vocabulary entries.
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
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
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 © 2018. All rights reserved.