Serialized Form (AWS Java SDK for Amazon Transcribe 1.11.605 API)

Package com.amazonaws.services.transcribe.model
- Class com.amazonaws.services.transcribe.model.AmazonTranscribeException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.transcribe.model.BadRequestException extends AmazonTranscribeException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.transcribe.model.ConflictException extends AmazonTranscribeException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.transcribe.model.CreateVocabularyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vocabularyName
```
String vocabularyName
```
      The name of the vocabulary. The name must be unique within an AWS account. The name is case-sensitive.
    - languageCode
```
String languageCode
```
      The language code of the vocabulary entries.
    - phrases
```
List<E> phrases
```
      An array of strings that contains the vocabulary entries.
    - vocabularyFileUri
```
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.
- Class com.amazonaws.services.transcribe.model.CreateVocabularyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - vocabularyName
```
String vocabularyName
```
      The name of the vocabulary.
    - languageCode
```
String languageCode
```
      The language code of the vocabulary entries.
    - vocabularyState
```
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.
    - lastModifiedTime
```
Date lastModifiedTime
```
      The date and time that the vocabulary was created.
    - failureReason
```
String failureReason
```
      If the VocabularyState field is FAILED, this field contains information about why the job failed.
- Class com.amazonaws.services.transcribe.model.DeleteTranscriptionJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - transcriptionJobName
```
String transcriptionJobName
```
      The name of the transcription job to be deleted.
- Class com.amazonaws.services.transcribe.model.DeleteTranscriptionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.transcribe.model.DeleteVocabularyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vocabularyName
```
String vocabularyName
```
      The name of the vocabulary to delete.
- Class com.amazonaws.services.transcribe.model.DeleteVocabularyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.transcribe.model.GetTranscriptionJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - transcriptionJobName
```
String transcriptionJobName
```
      The name of the job.
- Class com.amazonaws.services.transcribe.model.GetTranscriptionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - transcriptionJob
```
TranscriptionJob transcriptionJob
```
      An object that contains the results of the transcription job.
- Class com.amazonaws.services.transcribe.model.GetVocabularyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vocabularyName
```
String vocabularyName
```
      The name of the vocabulary to return information about. The name is case-sensitive.
- Class com.amazonaws.services.transcribe.model.GetVocabularyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - vocabularyName
```
String vocabularyName
```
      The name of the vocabulary to return.
    - languageCode
```
String languageCode
```
      The language code of the vocabulary entries.
    - vocabularyState
```
String vocabularyState
```
      The processing state of the vocabulary.
    - lastModifiedTime
```
Date lastModifiedTime
```
      The date and time that the vocabulary was last modified.
    - failureReason
```
String failureReason
```
      If the VocabularyState field is FAILED, this field contains information about why the job failed.
    - downloadUri
```
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.
- Class com.amazonaws.services.transcribe.model.InternalFailureException extends AmazonTranscribeException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.transcribe.model.LimitExceededException extends AmazonTranscribeException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.transcribe.model.ListTranscriptionJobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - status
```
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.
    - jobNameContains
```
String jobNameContains
```
      When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
    - nextToken
```
String nextToken
```
      If the result of the previous request to ListTranscriptionJobs was truncated, include the NextToken to fetch the next set of jobs.
    - maxResults
```
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.
- Class com.amazonaws.services.transcribe.model.ListTranscriptionJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - status
```
String status
```
      The requested status of the jobs returned.
    - nextToken
```
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.
    - transcriptionJobSummaries
```
List<E> transcriptionJobSummaries
```
      A list of objects containing summary information for a transcription job.
- Class com.amazonaws.services.transcribe.model.ListVocabulariesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      If the result of the previous request to ListVocabularies was truncated, include the NextToken to fetch the next set of jobs.
    - maxResults
```
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.
    - stateEquals
```
String stateEquals
```
      When specified, only returns vocabularies with the VocabularyState field equal to the specified state.
    - nameContains
```
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.
- Class com.amazonaws.services.transcribe.model.ListVocabulariesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - status
```
String status
```
      The requested vocabulary state.
    - nextToken
```
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.
    - vocabularies
```
List<E> vocabularies
```
      A list of objects that describe the vocabularies that match the search criteria in the request.
- Class com.amazonaws.services.transcribe.model.Media extends Object implements Serializable
  - Serialized Fields
    - mediaFileUri
```
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.
- Class com.amazonaws.services.transcribe.model.NotFoundException extends AmazonTranscribeException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.transcribe.model.Settings extends Object implements Serializable
  - Serialized Fields
    - vocabularyName
```
String vocabularyName
```
      The name of a vocabulary to use when processing the transcription job.
    - showSpeakerLabels
```
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.
    - maxSpeakerLabels
```
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.
    - channelIdentification
```
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.
- Class com.amazonaws.services.transcribe.model.StartTranscriptionJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - transcriptionJobName
```
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.
    - languageCode
```
String languageCode
```
      The language code for the language used in the input media file.
    - mediaSampleRateHertz
```
Integer mediaSampleRateHertz
```
      The sample rate, in Hertz, of the audio track in the input media file.
    - mediaFormat
```
String mediaFormat
```
      The format of the input media file.
    - media
```
Media media
```
      An object that describes the input media for a transcription job.
    - outputBucketName
```
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.
    - settings
```
Settings settings
```
      A Settings object that provides optional settings for a transcription job.
- Class com.amazonaws.services.transcribe.model.StartTranscriptionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - transcriptionJob
```
TranscriptionJob transcriptionJob
```
      An object containing details of the asynchronous transcription job.
- Class com.amazonaws.services.transcribe.model.Transcript extends Object implements Serializable
  - Serialized Fields
    - transcriptFileUri
```
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.
- Class com.amazonaws.services.transcribe.model.TranscriptionJob extends Object implements Serializable
  - Serialized Fields
    - transcriptionJobName
```
String transcriptionJobName
```
      The name of the transcription job.
    - transcriptionJobStatus
```
String transcriptionJobStatus
```
      The status of the transcription job.
    - languageCode
```
String languageCode
```
      The language code for the input speech.
    - mediaSampleRateHertz
```
Integer mediaSampleRateHertz
```
      The sample rate, in Hertz, of the audio track in the input media file.
    - mediaFormat
```
String mediaFormat
```
      The format of the input media file.
    - media
```
Media media
```
      An object that describes the input media for the transcription job.
    - transcript
```
Transcript transcript
```
      An object that describes the output of the transcription job.
    - creationTime
```
Date creationTime
```
      A timestamp that shows when the job was created.
    - completionTime
```
Date completionTime
```
      A timestamp that shows when the job was completed.
    - failureReason
```
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 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.
- Class com.amazonaws.services.transcribe.model.TranscriptionJobSummary extends Object implements Serializable
  - Serialized Fields
    - transcriptionJobName
```
String transcriptionJobName
```
      The name of the transcription job.
    - creationTime
```
Date creationTime
```
      A timestamp that shows when the job was created.
    - completionTime
```
Date completionTime
```
      A timestamp that shows when the job was completed.
    - languageCode
```
String languageCode
```
      The language code for the input speech.
    - transcriptionJobStatus
```
String transcriptionJobStatus
```
      The status of the transcription job. When the status is COMPLETED, use the GetTranscriptionJob operation to get the results of the transcription.
    - failureReason
```
String failureReason
```
      If the TranscriptionJobStatus field is FAILED, a description of the error.
    - outputLocationType
```
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.
- Class com.amazonaws.services.transcribe.model.UpdateVocabularyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vocabularyName
```
String vocabularyName
```
      The name of the vocabulary to update. The name is case-sensitive.
    - languageCode
```
String languageCode
```
      The language code of the vocabulary entries.
    - phrases
```
List<E> phrases
```
      An array of strings containing the vocabulary entries.
    - vocabularyFileUri
```
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.
- Class com.amazonaws.services.transcribe.model.UpdateVocabularyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - vocabularyName
```
String vocabularyName
```
      The name of the vocabulary that was updated.
    - languageCode
```
String languageCode
```
      The language code of the vocabulary entries.
    - lastModifiedTime
```
Date lastModifiedTime
```
      The date and time that the vocabulary was updated.
    - vocabularyState
```
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.
- Class com.amazonaws.services.transcribe.model.VocabularyInfo extends Object implements Serializable
  - Serialized Fields
    - vocabularyName
```
String vocabularyName
```
      The name of the vocabulary.
    - languageCode
```
String languageCode
```
      The language code of the vocabulary entries.
    - lastModifiedTime
```
Date lastModifiedTime
```
      The date and time that the vocabulary was last modified.
    - vocabularyState
```
String vocabularyState
```
      The processing state of the vocabulary. If the state is READY you can use the vocabulary in a StartTranscriptionJob request.

Serialized Form

Package com.amazonaws.services.transcribe.model

Class com.amazonaws.services.transcribe.model.AmazonTranscribeException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.transcribe.model.BadRequestException extends AmazonTranscribeException implements Serializable

Class com.amazonaws.services.transcribe.model.ConflictException extends AmazonTranscribeException implements Serializable

Class com.amazonaws.services.transcribe.model.CreateVocabularyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vocabularyName

languageCode

phrases

vocabularyFileUri

Class com.amazonaws.services.transcribe.model.CreateVocabularyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

vocabularyName

languageCode

vocabularyState

lastModifiedTime

failureReason

Class com.amazonaws.services.transcribe.model.DeleteTranscriptionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

transcriptionJobName

Class com.amazonaws.services.transcribe.model.DeleteTranscriptionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.transcribe.model.DeleteVocabularyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vocabularyName

Class com.amazonaws.services.transcribe.model.DeleteVocabularyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.transcribe.model.GetTranscriptionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

transcriptionJobName

Class com.amazonaws.services.transcribe.model.GetTranscriptionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

transcriptionJob

Class com.amazonaws.services.transcribe.model.GetVocabularyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vocabularyName

Class com.amazonaws.services.transcribe.model.GetVocabularyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

vocabularyName

languageCode

vocabularyState

lastModifiedTime

failureReason

downloadUri

Class com.amazonaws.services.transcribe.model.InternalFailureException extends AmazonTranscribeException implements Serializable

Class com.amazonaws.services.transcribe.model.LimitExceededException extends AmazonTranscribeException implements Serializable

Class com.amazonaws.services.transcribe.model.ListTranscriptionJobsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

status

jobNameContains

nextToken

maxResults

Class com.amazonaws.services.transcribe.model.ListTranscriptionJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

status

nextToken

transcriptionJobSummaries

Class com.amazonaws.services.transcribe.model.ListVocabulariesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextToken

maxResults

stateEquals

nameContains

Class com.amazonaws.services.transcribe.model.ListVocabulariesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

status

nextToken

vocabularies

Class com.amazonaws.services.transcribe.model.Media extends Object implements Serializable

Serialized Fields

mediaFileUri

Class com.amazonaws.services.transcribe.model.NotFoundException extends AmazonTranscribeException implements Serializable

Class com.amazonaws.services.transcribe.model.Settings extends Object implements Serializable

Serialized Fields

vocabularyName

showSpeakerLabels

maxSpeakerLabels

channelIdentification

Class com.amazonaws.services.transcribe.model.StartTranscriptionJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

transcriptionJobName