Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetDevicePositionHistory

Retrieves the device position history from a tracker resource within a specified range of time.

Note

Device positions are deleted after 30 days.

Request Syntax


POST /tracking/v0/trackers/TrackerName/devices/DeviceId/list-positions HTTP/1.1
Content-type: application/json

{
   "EndTimeExclusive": "string",
   "MaxResults": number,
   "NextToken": "string",
   "StartTimeInclusive": "string"
}

URI Request Parameters

The request uses the following URI parameters.

DeviceId

The device whose position history you want to retrieve.

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[-._\p{L}\p{N}]+$

Required: Yes

TrackerName

The tracker resource receiving the request for the device position history.

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.

EndTimeExclusive

Specify the end time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be the time that the request is made.

Requirement:

The time specified for EndTimeExclusive must be after the time for StartTimeInclusive.

Type: Timestamp

Required: No

MaxResults

An optional limit for the number of device positions returned in a single call.

Default value: 100

Type: 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: null

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2000.

Required: No

StartTimeInclusive

Specify the start time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be 24 hours prior to the time that the request is made.

Requirement:

The time specified for StartTimeInclusive must be before EndTimeExclusive.

Type: Timestamp

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "DevicePositions": [ 
      { 
         "Accuracy": { 
            "Horizontal": number
         },
         "DeviceId": "string",
         "Position": [ number ],
         "PositionProperties": { 
            "string" : "string" 
         },
         "ReceivedTime": "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.

DevicePositions

Contains the position history details for the requested device.

Type: Array of DevicePosition 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

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