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().

Request Syntax

response_iterator = paginator.paginate(
    TrackerName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

TrackerName (string) –
[REQUIRED]

The tracker resource containing the requested devices.
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': [
        {
            'Accuracy': {
                'Horizontal': 123.0
            },
            'DeviceId': 'string',
            'Position': [
                123.0,
            ],
            'PositionProperties': {
                'string': 'string'
            },
            'SampleTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

(dict) –
- Entries (list) –
  
  Contains details about each device’s last known position. These details includes the device ID, the time when the position was sampled on the device, the time that the service received the update, and the most recent coordinates.
  - (dict) –
    
    Contains the tracker resource 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 ID of the device for this position.
    - Position (list) –
      
      The last known device position. Empty if no positions currently stored.
      - (float) –
    - PositionProperties (dict) –
      
      The properties associated with the position.
      - (string) –
        
        (string) –
    - SampleTime (datetime) –
      
      The timestamp at which the device position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.