LocationService / Client / batch_delete_device_position_history

batch_delete_device_position_history#

LocationService.Client.batch_delete_device_position_history(**kwargs)#

Deletes the position history of one or more devices from a tracker resource.

See also: AWS API Documentation

Request Syntax

response = client.batch_delete_device_position_history(
    TrackerName='string',
    DeviceIds=[
        'string',
    ]
)
Parameters:

  • TrackerName (string) –

    [REQUIRED]

    The name of the tracker resource to delete the device position history from.

  • DeviceIds (list) –

    [REQUIRED]

    Devices whose position history you want to delete.

    • For example, for two devices: “DeviceIds” : [DeviceId1,DeviceId2]

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Errors': [
        {
            'DeviceId': 'string',
            'Error': {
                'Code': 'AccessDeniedError'|'ConflictError'|'InternalServerError'|'ResourceNotFoundError'|'ThrottlingError'|'ValidationError',
                'Message': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) –

    • Errors (list) –

      Contains error details for each device history that failed to delete.

      • (dict) –

        Contains the tracker resource details.

        • DeviceId (string) –

          The ID of the device for this position.

        • Error (dict) –

          Contains the batch request error details associated with the request.

          • Code (string) –

            The error code associated with the batch request error.

          • Message (string) –

            A message with the reason for the batch request error.

Exceptions