LocationService / Client / get_device_position

get_device_position#

LocationService.Client.get_device_position(**kwargs)#

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

Note

Device positions are deleted after 30 days.

Request Syntax

response = client.get_device_position(
    TrackerName='string',
    DeviceId='string'
)

Parameters:

TrackerName (string) –
[REQUIRED]

The tracker resource receiving the position update.
DeviceId (string) –
[REQUIRED]

The device whose position you want to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'DeviceId': 'string',
    'SampleTime': datetime(2015, 1, 1),
    'ReceivedTime': datetime(2015, 1, 1),
    'Position': [
        123.0,
    ],
    'Accuracy': {
        'Horizontal': 123.0
    },
    'PositionProperties': {
        'string': 'string'
    }
}

Response Structure

(dict) –
- DeviceId (string) –
  
  The device whose position you retrieved.
- SampleTime (datetime) –
  
  The timestamp at which the device’s position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
- ReceivedTime (datetime) –
  
  The timestamp for when the tracker resource received the device position. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
- Position (list) –
  
  The last known device position.
  - (float) –
- Accuracy (dict) –
  
  The accuracy of the device position.
  - Horizontal (float) –
    
    Estimated maximum distance, in meters, between the measured position and the true position of a device, along the Earth’s surface.
- PositionProperties (dict) –
  
  The properties associated with the position.
  - (string) –
    - (string) –

Exceptions

LocationService.Client.exceptions.InternalServerException
LocationService.Client.exceptions.ResourceNotFoundException
LocationService.Client.exceptions.AccessDeniedException
LocationService.Client.exceptions.ValidationException
LocationService.Client.exceptions.ThrottlingException