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': [
        {
            'Error': {
                'Code': 'AccessDeniedError'|'ConflictError'|'InternalServerError'|'ResourceNotFoundError'|'ThrottlingError'|'ValidationError',
                'Message': 'string'
            },
            'GeofenceId': '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.

      • 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.

      • GeofenceId (string) --

        The geofence associated with the error message.

Exceptions

• LocationService.Client.exceptions.InternalServerException
• LocationService.Client.exceptions.ResourceNotFoundException
• LocationService.Client.exceptions.AccessDeniedException
• LocationService.Client.exceptions.ValidationException
• LocationService.Client.exceptions.ThrottlingException