GetVocabulary
Provides information about the specified custom vocabulary.
To view the status of the specified custom vocabulary, check the
VocabularyState
field. If the status is READY
, your custom
vocabulary is available to use. If the status is FAILED
,
FailureReason
provides details on why your custom vocabulary
failed.
To get a list of your custom vocabularies, use the ListVocabularies operation.
Request Syntax
{
"VocabularyName": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- VocabularyName
-
The name of the custom vocabulary you want information about. Custom vocabulary names are case sensitive.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[0-9a-zA-Z._-]+
Required: Yes
Response Syntax
{
"DownloadUri": "string",
"FailureReason": "string",
"LanguageCode": "string",
"LastModifiedTime": number,
"VocabularyName": "string",
"VocabularyState": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- DownloadUri
-
The Amazon S3 location where the custom vocabulary is stored; use this URI to view or download the custom vocabulary.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2000.
Pattern:
(s3://|http(s*)://).+
- FailureReason
-
If
VocabularyState
isFAILED
,FailureReason
contains information about why the custom vocabulary request failed. See also: Common Errors.Type: String
- LanguageCode
-
The language code you selected for your custom vocabulary.
Type: String
Valid Values:
af-ZA | ar-AE | ar-SA | da-DK | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fa-IR | fr-CA | fr-FR | he-IL | hi-IN | id-ID | it-IT | ja-JP | ko-KR | ms-MY | nl-NL | pt-BR | pt-PT | ru-RU | ta-IN | te-IN | tr-TR | zh-CN | zh-TW | th-TH | en-ZA | en-NZ | vi-VN | sv-SE | ab-GE | ast-ES | az-AZ | ba-RU | be-BY | bg-BG | bn-IN | bs-BA | ca-ES | ckb-IQ | ckb-IR | cs-CZ | cy-WL | el-GR | et-ET | eu-ES | fi-FI | gl-ES | gu-IN | ha-NG | hr-HR | hu-HU | hy-AM | is-IS | ka-GE | kab-DZ | kk-KZ | kn-IN | ky-KG | lg-IN | lt-LT | lv-LV | mhr-RU | mi-NZ | mk-MK | ml-IN | mn-MN | mr-IN | mt-MT | no-NO | or-IN | pa-IN | pl-PL | ps-AF | ro-RO | rw-RW | si-LK | sk-SK | sl-SI | so-SO | sr-RS | su-ID | sw-BI | sw-KE | sw-RW | sw-TZ | sw-UG | tl-PH | tt-RU | ug-CN | uk-UA | uz-UZ | wo-SN | zu-ZA
- LastModifiedTime
-
The date and time the specified custom 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.Type: Timestamp
- VocabularyName
-
The name of the custom vocabulary you requested information about.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[0-9a-zA-Z._-]+
- VocabularyState
-
The processing state of your custom vocabulary. If the state is
READY
, you can use the custom vocabulary in aStartTranscriptionJob
request.Type: String
Valid Values:
PENDING | READY | FAILED
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as
IN PROGRESS
). See the exception message field for more information.HTTP Status Code: 400
- InternalFailureException
-
There was an internal error. Check the error message, correct the issue, and try your request again.
HTTP Status Code: 500
- LimitExceededException
-
You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
HTTP Status Code: 400
- NotFoundException
-
We can't find the requested resource. Check that the specified name is correct and try your request again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: