[ aws . transcribe ]

get-vocabulary-filter

Description

Provides information about the specified custom vocabulary filter.

To view the status of the specified vocabulary filter, 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 filter failed.

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--vocabulary-filter-name (string)

The name of the custom vocabulary filter you want information about. Vocabulary filter names are 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

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To get information about a vocabulary filter

The following get-vocabulary-filter example gets information about a vocabulary filter. You can use the DownloadUri parameter to get the list of words you used to create the vocabulary filter.

aws transcribe get-vocabulary-filter \
    --vocabulary-filter-name testFilter

Output:

{
    "VocabularyFilterName": "testFilter",
    "LanguageCode": "language-code",
    "LastModifiedTime": "2020-05-07T22:39:32.147000+00:00",
    "DownloadUri": "https://Amazon-S3-location-to-download-your-vocabulary-filter"
}

For more information, see Filter Unwanted Words in the Amazon Transcribe Developer Guide.

Output

VocabularyFilterName -> (string)

The name of the custom vocabulary filter you requested information about.

LanguageCode -> (string)

The language code you selected for your vocabulary filter.

LastModifiedTime -> (timestamp)

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

DownloadUri -> (string)

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