[ aws . connect ]

describe-vocabulary

Description

Describes the specified vocabulary.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-vocabulary
--instance-id <value>
--vocabulary-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--instance-id (string)

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

--vocabulary-id (string)

The identifier of the custom vocabulary.

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

Output

Vocabulary -> (structure)

A list of specific words that you want Contact Lens for Amazon Connect to recognize in your audio input. They are generally domain-specific words and phrases, words that Contact Lens is not recognizing, or proper nouns.

Name -> (string)

A unique name of the custom vocabulary.

Id -> (string)

The identifier of the custom vocabulary.

Arn -> (string)

The Amazon Resource Name (ARN) of the custom vocabulary.

LanguageCode -> (string)

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

State -> (string)

The current state of the custom vocabulary.

LastModifiedTime -> (timestamp)

The timestamp when the custom vocabulary was last modified.

FailureReason -> (string)

The reason why the custom vocabulary was not created.

Content -> (string)

The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase , IPA , SoundsLike , and DisplayAs fields. Separate the fields with TAB characters. For more information, see Create a custom vocabulary using a table .

Tags -> (map)

The tags used to organize, track, or control access for this resource.

key -> (string)

value -> (string)