A batch request to retrieve all device positions.
Request Syntax
POST /tracking/v0/trackers/TrackerName/list-positions HTTP/1.1
Content-type: application/json
{
"FilterGeometry": {
"Polygon": [
[
[ number ]
]
]
},
"MaxResults": number,
"NextToken": "string"
}URI Request Parameters
The request uses the following URI parameters.
- TrackerName
-
The tracker resource containing the requested devices.
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.
- FilterGeometry
-
The geometry used to filter device positions.
Type: TrackingFilterGeometry object
Required: No
- MaxResults
-
An optional limit for the number of entries returned in a single call.
Default value:
100Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.
Default value:
nullType: String
Length Constraints: Minimum length of 1. Maximum length of 2000.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Entries": [
{
"Accuracy": {
"Horizontal": number
},
"DeviceId": "string",
"Position": [ number ],
"PositionProperties": {
"string" : "string"
},
"SampleTime": "string"
}
],
"NextToken": "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.
- Entries
-
Contains details about each device's last known position.
Type: Array of ListDevicePositionsResponseEntry objects
- NextToken
-
A pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2000.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
HTTP Status Code: 403
- InternalServerException
-
HTTP Status Code: 500
- ThrottlingException
-
HTTP Status Code: 429
- ValidationException
-
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
