[ aws . lexv2-models ]

describe-custom-vocabulary-metadata

Description

Provides metadata information about a custom vocabulary.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-custom-vocabulary-metadata
--bot-id <value>
--bot-version <value>
--locale-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--bot-id (string)

The unique identifier of the bot that contains the custom vocabulary.

--bot-version (string)

The bot version of the bot to return metadata for.

--locale-id (string)

The locale to return the custom vocabulary information for. The locale must be en_GB .

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

botId -> (string)

The identifier of the bot that contains the custom vocabulary.

botVersion -> (string)

The version of the bot that contains the custom vocabulary to describe.

localeId -> (string)

The locale that contains the custom vocabulary to describe.

customVocabularyStatus -> (string)

The status of the custom vocabulary. If the status is Ready the custom vocabulary is ready to use.

creationDateTime -> (timestamp)

The date and time that the custom vocabulary was created.

lastUpdatedDateTime -> (timestamp)

The date and time that the custom vocabulary was last updated.