:doc:`LexModelsV2 <../../lexv2-models>` / Client / list_custom_vocabulary_items

****************************
list_custom_vocabulary_items
****************************



.. py:method:: 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 <https://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListCustomVocabularyItems>`_  


  **Request Syntax**
  ::

    response = client.list_custom_vocabulary_items(
        botId='string',
        botVersion='string',
        localeId='string',
        maxResults=123,
        nextToken='string'
    )
    
  :type botId: string
  :param botId: **[REQUIRED]** 

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

    

  
  :type botVersion: string
  :param botVersion: **[REQUIRED]** 

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

    

  
  :type localeId: string
  :param localeId: **[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).

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of items returned by the list operation.

    

  
  :type nextToken: string
  :param nextToken: 

    The nextToken identifier to the list custom vocabulary request.

    

  
  
  :rtype: 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 <https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html>`__.

        
      

      - **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**
  
  *   :py:class:`LexModelsV2.Client.exceptions.ThrottlingException`

  
  *   :py:class:`LexModelsV2.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`LexModelsV2.Client.exceptions.ValidationException`

  
  *   :py:class:`LexModelsV2.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`LexModelsV2.Client.exceptions.InternalServerException`

  