LocationService / Paginator / ListDevicePositions

ListDevicePositions

class LocationService.Paginator.ListDevicePositions

paginator = client.get_paginator('list_device_positions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from LocationService.Client.list_device_positions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    TrackerName='string',
    FilterGeometry={
        'Polygon': [
            [
                [
                    123.0,
                ],
            ],
        ]
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• TrackerName (string) –

  [REQUIRED]

  The tracker resource containing the requested devices.

• FilterGeometry (dict) –

  The geometry used to filter device positions.

  • Polygon (list) –

    The set of arrays which define the polygon. A polygon can have between 4 and 1000 vertices.

    • (list) –

      • (list) –

        • (float) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

}

Response Structure

• (dict) –

  • Entries (list) –

    Contains details about each device’s last known position.

    • (dict) –

      Contains the tracker resource details.

      • DeviceId (string) –

        The ID of the device for this position.

      • SampleTime (datetime) –

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

      • Position (list) –

        The last known device position. Empty if no positions currently stored.

        • (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) –