Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . transcribe ]

get-vocabulary

Description

Provides information about the specified custom vocabulary.

To view the status of the specified vocabulary, check the VocabularyState field. If the status is READY , your vocabulary is available to use. If the status is FAILED , FailureReason provides details on why your vocabulary failed.

To get a list of your custom vocabularies, use the operation.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-vocabulary
--vocabulary-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--vocabulary-name (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To get information about a custom vocabulary

The following get-vocabulary example gets information on a previously created custom vocabulary.

aws transcribe get-vocabulary \
    --vocabulary-name cli-vocab-1

Output:

{
    "VocabularyName": "cli-vocab-1",
    "LanguageCode": "language-code",
    "VocabularyState": "READY",
    "LastModifiedTime": "2020-09-19T23:22:32.836000+00:00",
    "DownloadUri": "https://link-to-download-the-text-file-used-to-create-your-custom-vocabulary"
}

For more information, see Custom Vocabularies in the Amazon Transcribe Developer Guide.

Output

VocabularyName -> (string)

The name of the custom vocabulary you requested information about.

LanguageCode -> (string)

The language code you selected for your custom vocabulary.

VocabularyState -> (string)

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

LastModifiedTime -> (timestamp)

The date and time the specified 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.

FailureReason -> (string)

If VocabularyState is FAILED , FailureReason contains information about why the vocabulary request failed. See also: Common Errors .

DownloadUri -> (string)

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