:doc:`LocationService <../../location>` / Paginator / ListDevicePositions

*******************
ListDevicePositions
*******************



.. py:class:: LocationService.Paginator.ListDevicePositions

  ::

    
    paginator = client.get_paginator('list_device_positions')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`LocationService.Client.list_device_positions`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListDevicePositions>`_    


    **Request Syntax**
    ::

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

      The tracker resource containing the requested devices.

      

    
    :type FilterGeometry: dict
    :param FilterGeometry: 

      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) --* 

            
        
      
    
    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: 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 <https://www.iso.org/iso-8601-date-and-time-format.html>`__ 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) --* 
          
        
        
      
    