"documentation":"<p>Returns information about a transcription job. To see the status of the job, check the <code>TranscriptionJobStatus</code> field. If the status is <code>COMPLETED</code>, the job is finished and you can find the results at the location specified in the <code>TranscriptionFileUri</code> field.</p>"
},
"GetVocabulary":{
"name":"GetVocabulary",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetVocabularyRequest"},
"output":{"shape":"GetVocabularyResponse"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"InternalFailureException"},
{"shape":"BadRequestException"}
],
"documentation":"<p>Gets information about a vocabulary.</p>"
"documentation":"<p>Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.</p>"
"documentation":"<p>Updates an existing vocabulary with new values. The <code>UpdateVocabulary</code> operation overwrites all of the existing information with the values that you provide in the request.</p>"
"documentation":"<p>Your request didn't pass one or more validation tests. For example, a name already exists when creating a resource or a name may not exist when getting a transcription job or custom vocabulary. See the exception <code>Message</code> field for more information.</p>",
"documentation":"<p>When you are using the <code>StartTranscriptionJob</code> operation, the <code>JobName</code> field is a duplicate of a previously entered job name. Resend your request with a different name.</p> <p>When you are using the <code>UpdateVocabulary</code> operation, there are two jobs running at the same time. Resend the second request later.</p>",
"documentation":"<p>The name of the vocabulary. The name must be unique within an AWS account. The name is case-sensitive.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language code of the vocabulary entries.</p>"
},
"Phrases":{
"shape":"Phrases",
"documentation":"<p>An array of strings that contains the vocabulary entries. </p>"
}
}
},
"CreateVocabularyResponse":{
"type":"structure",
"members":{
"VocabularyName":{
"shape":"VocabularyName",
"documentation":"<p>The name of the vocabulary.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language code of the vocabulary entries.</p>"
},
"VocabularyState":{
"shape":"VocabularyState",
"documentation":"<p>The processing state of the vocabulary. When the <code>VocabularyState</code> field contains <code>READY</code> the vocabulary is ready to be used in a <code>StartTranscriptionJob</code> request.</p>"
},
"LastModifiedTime":{
"shape":"DateTime",
"documentation":"<p>The date and time that the vocabulary was created.</p>"
},
"FailureReason":{
"shape":"FailureReason",
"documentation":"<p>If the <code>VocabularyState</code> field is <code>FAILED</code>, this field contains information about why the job failed.</p>"
"documentation":"<p>The name of the vocabulary to return information about. The name is case-sensitive.</p>"
}
}
},
"GetVocabularyResponse":{
"type":"structure",
"members":{
"VocabularyName":{
"shape":"VocabularyName",
"documentation":"<p>The name of the vocabulary to return.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language code of the vocabulary entries.</p>"
},
"VocabularyState":{
"shape":"VocabularyState",
"documentation":"<p>The processing state of the vocabulary.</p>"
},
"LastModifiedTime":{
"shape":"DateTime",
"documentation":"<p>The date and time that the vocabulary was last modified.</p>"
},
"FailureReason":{
"shape":"FailureReason",
"documentation":"<p>If the <code>VocabularyState</code> field is <code>FAILED</code>, this field contains information about why the job failed.</p>"
},
"DownloadUri":{
"shape":"Uri",
"documentation":"<p>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.</p>"
"documentation":"<p>Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.</p>",
"documentation":"<p>If the result of the previous request to <code>ListTranscriptionJobs</code> was truncated, include the <code>NextToken</code> to fetch the next set of jobs.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>The <code>ListTranscriptionJobs</code> operation returns a page of jobs at a time. The maximum size of the page is set by the <code>MaxResults</code> parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the <code>NextPage</code> token. Include the token in the next request to the <code>ListTranscriptionJobs</code> operation to return in the next page of jobs.</p>"
"documentation":"<p>If the result of the previous request to <code>ListVocabularies</code> was truncated, include the <code>NextToken</code> to fetch the next set of jobs.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>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.</p>"
},
"StateEquals":{
"shape":"VocabularyState",
"documentation":"<p>When specified, only returns vocabularies with the <code>VocabularyState</code> field equal to the specified state.</p>"
},
"NameContains":{
"shape":"VocabularyName",
"documentation":"<p>When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string. The search is case-insensitive, <code>ListVocabularies</code> will return both \"vocabularyname\" and \"VocabularyName\" in the response list.</p>"
"documentation":"<p>The <code>ListVocabularies</code> operation returns a page of vocabularies at a time. The maximum size of the page is set by the <code>MaxResults</code> parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the <code>NextPage</code> token. Include the token in the next request to the <code>ListVocabularies</code> operation to return in the next page of jobs.</p>"
},
"Vocabularies":{
"shape":"Vocabularies",
"documentation":"<p>A list of objects that describe the vocabularies that match the search criteria in the request.</p>"
"documentation":"<p>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:</p> <p> <code> https://<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey> </code> </p> <p>For example:</p> <p> <code>https://s3-us-east-1.amazonaws.com/examplebucket/example.mp4</code> </p> <p> <code>https://s3-us-east-1.amazonaws.com/examplebucket/mediadocs/example.mp4</code> </p> <p>For more information about S3 object names, see <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys\">Object Keys</a> in the <i>Amazon S3 Developer Guide</i>.</p>"
"documentation":"<p>The name of a vocabulary to use when processing the transcription job.</p>"
},
"ShowSpeakerLabels":{
"shape":"Boolean",
"documentation":"<p>Determines whether the transcription job should use speaker recognition to identify different speakers in the input audio. If you set the <code>ShowSpeakerLabels</code> field to true, you must also set the maximum number of speaker labels <code>MaxSpeakerLabels</code> field.</p>"
},
"MaxSpeakerLabels":{
"shape":"MaxSpeakers",
"documentation":"<p>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 <code>MaxSpeakerLabels</code> field, you must set the <code>ShowSpeakerLabels</code> field to true.</p>"
}
},
"documentation":"<p>Provides optional settings for the <code>StartTranscriptionJob</code> operation.</p>"
"documentation":"<p>The name of the job. You can't use the strings \".\" or \"..\" in the job name. The name must be unique within an AWS account.</p>"
"documentation":"<p>The location where the transcription is stored.</p> <p>If you set the <code>OutputBucketName</code>, Amazon Transcribe puts the transcription in the specified S3 bucket. When you call the <a>GetTranscriptionJob</a> operation, the operation returns this location in the <code>TranscriptFileUri</code> field. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/access-control-managing-permissions.html#auth-role-iam-user\">Permissions Required for IAM User Roles</a>.</p> <p>If you don't set the <code>OutputBucketName</code>, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the <code>TranscriptFileUri</code> field. Use this URL to download the transcription.</p>"
"documentation":"<p>The location where the transcription is stored.</p> <p>Use this URI to access the transcription. If you specified an S3 bucket in the <code>OutputBucketName</code> 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.</p>"
"documentation":"<p>If the <code>TranscriptionJobStatus</code> field is <code>FAILED</code>, this field contains information about why the job failed.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>The language code for the input speech.</p>"
},
"TranscriptionJobStatus":{
"shape":"TranscriptionJobStatus",
"documentation":"<p>The status of the transcription job. When the status is <code>COMPLETED</code>, use the <code>GetTranscriptionJob</code> operation to get the results of the transcription.</p>"
"documentation":"<p>If the <code>TranscriptionJobStatus</code> field is <code>FAILED</code>, a description of the error.</p>"
},
"OutputLocationType":{
"shape":"OutputLocationType",
"documentation":"<p>Indicates the location of the output of the transcription job.</p> <p>If the value is <code>CUSTOMER_BUCKET</code> then the location is the S3 bucket specified in the <code>outputBucketName</code> field when the transcription job was started with the <code>StartTranscriptionJob</code> operation.</p> <p>If the value is <code>SERVICE_BUCKET</code> then the output is stored by Amazon Transcribe and can be retrieved using the URI in the <code>GetTranscriptionJob</code> response's <code>TranscriptFileUri</code> field.</p>"
"documentation":"<p>The name of the vocabulary to update. The name is case-sensitive.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language code of the vocabulary entries.</p>"
},
"Phrases":{
"shape":"Phrases",
"documentation":"<p>An array of strings containing the vocabulary entries.</p>"
}
}
},
"UpdateVocabularyResponse":{
"type":"structure",
"members":{
"VocabularyName":{
"shape":"VocabularyName",
"documentation":"<p>The name of the vocabulary that was updated.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language code of the vocabulary entries.</p>"
},
"LastModifiedTime":{
"shape":"DateTime",
"documentation":"<p>The date and time that the vocabulary was updated.</p>"
},
"VocabularyState":{
"shape":"VocabularyState",
"documentation":"<p>The processing state of the vocabulary. When the <code>VocabularyState</code> field contains <code>READY</code> the vocabulary is ready to be used in a <code>StartTranscriptionJob</code> request.</p>"
"documentation":"<p>The name of the vocabulary.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language code of the vocabulary entries.</p>"
},
"LastModifiedTime":{
"shape":"DateTime",
"documentation":"<p>The date and time that the vocabulary was last modified.</p>"
},
"VocabularyState":{
"shape":"VocabularyState",
"documentation":"<p>The processing state of the vocabulary. If the state is <code>READY</code> you can use the vocabulary in a <code>StartTranscriptionJob</code> request.</p>"
}
},
"documentation":"<p>Provides information about a custom vocabulary.</p>"