Amazon Location Service

{'MaxResults': 'integer'}

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

See also: AWS API Documentation

Request Syntax

client.get_device_position_history(
    DeviceId='string',
    EndTimeExclusive=datetime(2015, 1, 1),
    MaxResults=123,
    NextToken='string',
    StartTimeInclusive=datetime(2015, 1, 1),
    TrackerName='string'
)

type DeviceId

string

param DeviceId

[REQUIRED]

The device whose position history you want to retrieve.

type EndTimeExclusive

datetime

param 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 MaxResults

integer

param MaxResults

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

Default value: 100

type NextToken

string

param 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 StartTimeInclusive

datetime

param 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 TrackerName

string

param TrackerName

[REQUIRED]

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

rtype

dict

returns

Response Syntax

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

Response Structure

• (dict) --

  • DevicePositions (list) --

    Contains the position history details for the requested device.

    • (dict) --

      Contains the device position details.

      • 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.

      • DeviceId (string) --

        The device whose position you retrieved.

      • Position (list) --

        The last known device position.

        • (float) --

      • PositionProperties (dict) --

        The properties associated with the position.

        • (string) --

          • (string) --

      • ReceivedTime (datetime) --

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

      • SampleTime (datetime) --

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

  • NextToken (string) --

    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.