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

***********************************
batch_delete_custom_vocabulary_item
***********************************



.. py:method:: LexModelsV2.Client.batch_delete_custom_vocabulary_item(**kwargs)

  

  Delete a batch 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/BatchDeleteCustomVocabularyItem>`_  


  **Request Syntax**
  ::

    response = client.batch_delete_custom_vocabulary_item(
        botId='string',
        botVersion='string',
        localeId='string',
        customVocabularyItemList=[
            {
                'itemId': 'string'
            },
        ]
    )
    
  :type botId: string
  :param botId: **[REQUIRED]** 

    The identifier of the bot associated with this custom vocabulary.

    

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

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

    

  
  :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 customVocabularyItemList: list
  :param customVocabularyItemList: **[REQUIRED]** 

    A list of custom vocabulary items requested to be deleted. Each entry must contain the unique custom vocabulary entry identifier.

    

  
    - *(dict) --* 

      The unique entry identifier for the custom vocabulary items.

      

    
      - **itemId** *(string) --* **[REQUIRED]** 

        The unique item identifier for the custom vocabulary items.

        

      
    

  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'botId': 'string',
          'botVersion': 'string',
          'localeId': 'string',
          'errors': [
              {
                  'itemId': 'string',
                  'errorMessage': 'string',
                  'errorCode': 'DUPLICATE_INPUT'|'RESOURCE_DOES_NOT_EXIST'|'RESOURCE_ALREADY_EXISTS'|'INTERNAL_SERVER_FAILURE'
              },
          ],
          'resources': [
              {
                  'itemId': 'string',
                  'phrase': 'string',
                  'weight': 123,
                  'displayAs': '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).

        
      

      - **errors** *(list) --* 

        A list of custom vocabulary items that failed to delete during the operation. The reason for the error is contained within each error object.

        
        

        - *(dict) --* 

          The unique failed custom vocabulary item from the custom vocabulary list.

          
          

          - **itemId** *(string) --* 

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

            
          

          - **errorMessage** *(string) --* 

            The error message for the failed custom vocabulary item from the custom vocabulary list.

            
          

          - **errorCode** *(string) --* 

            The unique error code for the failed custom vocabulary item from the custom vocabulary list.

            
      
    
      

      - **resources** *(list) --* 

        A list of custom vocabulary items that were successfully deleted during the operation.

        
        

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

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

  