LocationService / Client / batch_delete_geofence

batch_delete_geofence#

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

Request Syntax

response = client.batch_delete_geofence(
    CollectionName='string',
    GeofenceIds=[
        'string',
    ]
)
Parameters:

  • CollectionName (string) –

    [REQUIRED]

    The geofence collection storing the geofences to be deleted.

  • GeofenceIds (list) –

    [REQUIRED]

    The batch of geofences to be deleted.

    • (string) –

Return type:

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