LocationService / Client / batch_get_device_position

batch_get_device_position#

LocationService.Client.batch_get_device_position(**kwargs)#

Lists the latest device positions for requested devices.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_device_position(
    DeviceIds=[
        'string',
    ],
    TrackerName='string'
)
Parameters:

  • DeviceIds (list) –

    [REQUIRED]

    Devices whose position you want to retrieve.

    • For example, for two devices: device-ids=DeviceId1&device-ids=DeviceId2

    • (string) –

  • TrackerName (string) –

    [REQUIRED]

    The tracker resource retrieving the device position.

Return type:

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)
        },
    ],
    'Errors': [
        {
            'DeviceId': 'string',
            'Error': {
                'Code': 'AccessDeniedError'|'ConflictError'|'InternalServerError'|'ResourceNotFoundError'|'ThrottlingError'|'ValidationError',
                'Message': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) –

    • DevicePositions (list) –

      Contains device position details such as the device ID, position, and timestamps for when the position was received and sampled.

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

    • Errors (list) –

      Contains error details for each device that failed to send its position to the tracker resource.

      • (dict) –

        Contains error details for each device that didn’t return a position.

        • DeviceId (string) –

          The ID of the device that didn’t return a position.

        • Error (dict) –

          Contains details related to the error code.

          • Code (string) –

            The error code associated with the batch request error.

          • Message (string) –

            A message with the reason for the batch request error.

Exceptions