[ aws . transcribe ]

get-vocabulary-filter

Description

Returns information about a vocabulary filter.

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 vocabulary filter for which to return information.

--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 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": "en-US",
    "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 vocabulary filter.

LanguageCode -> (string)

The language code of the words in the vocabulary filter.

LastModifiedTime -> (timestamp)

The date and time that the contents of the vocabulary filter were updated.

DownloadUri -> (string)

The URI of the list of words in the vocabulary filter. You can use this URI to get the list of words.