Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1439185265.0 KB

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 operation.

post/#X-Amz-Target=Transcribe.GetVocabulary

Headers

X-Amz-Target'Transcribe.GetVocabulary' required

Request body

VocabularyNamestring required

The name of the custom vocabulary you want information about. Custom vocabulary names are case sensitive.

Response

Success

VocabularyNamestring

The name of the custom vocabulary you requested information about.

LanguageCode'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'

The language code you selected for your custom vocabulary.

VocabularyState'PENDING' | 'READY' | 'FAILED'

The processing state of your custom vocabulary. If the state is <code>READY</code>, you can use the custom vocabulary in a <code>StartTranscriptionJob</code> request.

LastModifiedTimestring date-time
<p>The date and time the specified custom vocabulary was last modified.</p> <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May 4, 2022.</p>
FailureReasonstring

If <code>VocabularyState</code> is <code>FAILED</code>, <code>FailureReason</code> contains information about why the custom vocabulary request failed. See also: <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.

DownloadUristring

The S3 location where the custom vocabulary is stored; use this URI to view or download the custom vocabulary.