:doc:`LocationService <../../location>` / Client / batch_delete_geofence

*********************
batch_delete_geofence
*********************



.. py:method:: LocationService.Client.batch_delete_geofence(**kwargs)

  

  Deletes a batch of geofences from a geofence collection.

   

  .. note::

    

    This operation deletes the resource permanently.

    

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/BatchDeleteGeofence>`_  


  **Request Syntax**
  ::

    response = client.batch_delete_geofence(
        CollectionName='string',
        GeofenceIds=[
            'string',
        ]
    )
    
  :type CollectionName: string
  :param CollectionName: **[REQUIRED]** 

    The geofence collection storing the geofences to be deleted.

    

  
  :type GeofenceIds: list
  :param GeofenceIds: **[REQUIRED]** 

    The batch of geofences to be deleted.

    

  
    - *(string) --* 

    

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

    
    ::

      {
          'Errors': [
              {
                  'GeofenceId': 'string',
                  'Error': {
                      'Code': 'AccessDeniedError'|'ConflictError'|'InternalServerError'|'ResourceNotFoundError'|'ThrottlingError'|'ValidationError',
                      'Message': 'string'
                  }
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Errors** *(list) --* 

        Contains error details for each geofence that failed to delete.

        
        

        - *(dict) --* 

          Contains error details for each geofence that failed to delete from the geofence collection.

          
          

          - **GeofenceId** *(string) --* 

            The geofence associated with the error message.

            
          

          - **Error** *(dict) --* 

            Contains details associated to the batch error.

            
            

            - **Code** *(string) --* 

              The error code associated with the batch request error.

              
            

            - **Message** *(string) --* 

              A message with the reason for the batch request error.

              
        
      
    
  
  **Exceptions**
  
  *   :py:class:`LocationService.Client.exceptions.InternalServerException`

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

  
  *   :py:class:`LocationService.Client.exceptions.AccessDeniedException`

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

  
  *   :py:class:`LocationService.Client.exceptions.ThrottlingException`

  