LexModelsV2 / Client / describe_custom_vocabulary_metadata

describe_custom_vocabulary_metadata#

LexModelsV2.Client.describe_custom_vocabulary_metadata(**kwargs)#

Provides metadata information about a custom vocabulary.

See also: AWS API Documentation

Request Syntax

response = client.describe_custom_vocabulary_metadata(
    botId='string',
    botVersion='string',
    localeId='string'
)
Parameters:

  • botId (string) –

    [REQUIRED]

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

  • botVersion (string) –

    [REQUIRED]

    The bot version of the bot to return metadata for.

  • localeId (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'botId': 'string',
    'botVersion': 'string',
    'localeId': 'string',
    'customVocabularyStatus': 'Ready'|'Deleting'|'Exporting'|'Importing'|'Creating',
    'creationDateTime': datetime(2015, 1, 1),
    'lastUpdatedDateTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • 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 (datetime) –

      The date and time that the custom vocabulary was created.

    • lastUpdatedDateTime (datetime) –

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

Exceptions