:doc:`LocationService <../../location>` / Client / list_device_positions

*********************
list_device_positions
*********************



.. py:method:: LocationService.Client.list_device_positions(**kwargs)

  

  A batch request to retrieve all device positions.

  

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


  **Request Syntax**
  ::

    response = client.list_device_positions(
        TrackerName='string',
        MaxResults=123,
        NextToken='string',
        FilterGeometry={
            'Polygon': [
                [
                    [
                        123.0,
                    ],
                ],
            ]
        }
    )
    
  :type TrackerName: string
  :param TrackerName: **[REQUIRED]** 

    The tracker resource containing the requested devices.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    An optional limit for the number of entries 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 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) --* 

          
      
    
  
  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'Entries': [
              {
                  'DeviceId': 'string',
                  'SampleTime': datetime(2015, 1, 1),
                  'Position': [
                      123.0,
                  ],
                  'Accuracy': {
                      'Horizontal': 123.0
                  },
                  'PositionProperties': {
                      'string': 'string'
                  }
              },
          ],
          'NextToken': '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) --* 
        
      
      
    
      

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

        
  
  **Exceptions**
  
  *   :py:class:`LocationService.Client.exceptions.InternalServerException`

  
  *   :py:class:`LocationService.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`LocationService.Client.exceptions.ValidationException`

  
  *   :py:class:`LocationService.Client.exceptions.ThrottlingException`

  