LexModelsV2 / Client / list_custom_vocabulary_items

list_custom_vocabulary_items#

LexModelsV2.Client.list_custom_vocabulary_items(**kwargs)#

Paginated list of custom vocabulary items for a given bot locale’s custom vocabulary.

See also: AWS API Documentation

Request Syntax

response = client.list_custom_vocabulary_items(
    botId='string',
    botVersion='string',
    localeId='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • botId (string) –

    [REQUIRED]

    The identifier of the version of the bot associated with this custom vocabulary.

  • botVersion (string) –

    [REQUIRED]

    The bot version of the bot to the list custom vocabulary request.

  • localeId (string) –

    [REQUIRED]

    The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).

  • maxResults (integer) – The maximum number of items returned by the list operation.

  • nextToken (string) – The nextToken identifier to the list custom vocabulary request.

Return type:

dict

Returns:

Response Syntax

{
    'botId': 'string',
    'botVersion': 'string',
    'localeId': 'string',
    'customVocabularyItems': [
        {
            'itemId': 'string',
            'phrase': 'string',
            'weight': 123,
            'displayAs': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • botId (string) –

      The identifier of the bot associated with this custom vocabulary.

    • botVersion (string) –

      The identifier of the version of the bot associated with this custom vocabulary.

    • localeId (string) –

      The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported Languages.

    • customVocabularyItems (list) –

      The custom vocabulary items from the list custom vocabulary response.

      • (dict) –

        The unique custom vocabulary item from the custom vocabulary list.

        • itemId (string) –

          The unique item identifer for the custom vocabulary item from the custom vocabulary list.

        • phrase (string) –

          The unique phrase for the custom vocabulary item from the custom vocabulary list.

        • weight (integer) –

          The weight assigned for the custom vocabulary item from the custom vocabulary list.

        • displayAs (string) –

          The DisplayAs value for the custom vocabulary item from the custom vocabulary list.

    • nextToken (string) –

      The nextToken identifier to the list custom vocabulary response.

Exceptions