GetDevicePosition - Amazon Location Service

GetDevicePosition

Retrieves a device's most recent position according to its sample time.

Note

Device positions are deleted after 30 days.

Request Syntax

GET /tracking/v0/trackers/TrackerName/devices/DeviceId/positions/latest HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

DeviceId

The device whose position 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 position update.

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

Pattern: ^[-._\w]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Accuracy": { "Horizontal": number }, "DeviceId": "string", "Position": [ number ], "PositionProperties": { "string" : "string" }, "ReceivedTime": number, "SampleTime": number }

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.

Accuracy

The accuracy of the device position.

Type: PositionalAccuracy object

DeviceId

The device whose position you retrieved.

Type: String

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

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

Position

The last known device position.

Type: Array of doubles

Array Members: Fixed number of 2 items.

PositionProperties

The properties associated with the position.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 3 items.

Key Length Constraints: Minimum length of 1. Maximum length of 20.

Value Length Constraints: Minimum length of 1. Maximum length of 40.

ReceivedTime

The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Type: Timestamp

SampleTime

The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Type: Timestamp

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: