Deletes the position history of one or more devices from a tracker resource.
Request Syntax
POST /tracking/v0/trackers/TrackerName/delete-positions HTTP/1.1
Content-type: application/json
{
"DeviceIds": [ "string" ]
}URI Request Parameters
The request uses the following URI parameters.
- TrackerName
-
The name of the tracker resource to delete the device position history from.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[-._\w]+Required: Yes
Request Body
The request accepts the following data in JSON format.
- DeviceIds
-
Devices whose position history you want to delete.
-
For example, for two devices:
“DeviceIds” : [DeviceId1,DeviceId2]
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[-._\p{L}\p{N}]+Required: Yes
-
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Errors": [
{
"DeviceId": "string",
"Error": {
"Code": "string",
"Message": "string"
}
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Errors
-
Contains error details for each device history that failed to delete.
Type: Array of BatchDeleteDevicePositionHistoryError objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
HTTP Status Code: 403
- InternalServerException
-
The request has failed to process because of an unknown server error, exception, or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource that you've entered was not found in your AWS account.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied because of request throttling.
HTTP Status Code: 429
- ValidationException
-
The input failed to meet the constraints specified by the AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
