[ aws . transcribe ]

get-vocabulary

Description

Gets information about a vocabulary.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--vocabulary-name (string)

The name of the vocabulary to return information about. The name is case sensitive.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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": "en-US",
    "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 vocabulary to return.

LanguageCode -> (string)

The language code of the vocabulary entries.

VocabularyState -> (string)

The processing state of the vocabulary.

LastModifiedTime -> (timestamp)

The date and time that the vocabulary was last modified.

FailureReason -> (string)

If the VocabularyState field is FAILED , this field contains information about why the job failed.

DownloadUri -> (string)

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.