LocationService / Client / batch_update_device_position

batch_update_device_position

LocationService.Client.batch_update_device_position(**kwargs)

Uploads position update data for one or more devices to a tracker resource. Amazon Location uses the data when it reports the last known device position and position history. Amazon Location retains location data for 30 days.

Note

Position updates are handled based on the PositionFiltering property of the tracker. When PositionFiltering is set to TimeBased, updates are evaluated against linked geofence collections, and location data is stored at a maximum of one position per 30 second interval. If your update frequency is more often than every 30 seconds, only one update per 30 seconds is stored for each unique device ID.

When PositionFiltering is set to DistanceBased filtering, location data is stored and evaluated against linked geofence collections only if the device has moved more than 30 m (98.4 ft).

When PositionFiltering is set to AccuracyBased filtering, location data is stored and evaluated against linked geofence collections only if the device has moved more than the measured accuracy. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is neither stored or evaluated if the device has moved less than 15 m. If PositionFiltering is set to AccuracyBased filtering, Amazon Location uses the default value { "Horizontal": 0} when accuracy is not provided on a DevicePositionUpdate.

See also: AWS API Documentation

Request Syntax

response = client.batch_update_device_position(
    TrackerName='string',
    Updates=[
        {
            'Accuracy': {
                'Horizontal': 123.0
            },
            'DeviceId': 'string',
            'Position': [
                123.0,
            ],
            'PositionProperties': {
                'string': 'string'
            },
            'SampleTime': datetime(2015, 1, 1)
        },
    ]
)

Parameters:

• TrackerName (string) –

  [REQUIRED]

  The name of the tracker resource to update.

• Updates (list) –

  [REQUIRED]

  Contains the position update details for each device.

  • (dict) –

    Contains the position update details for a device.

    • Accuracy (dict) –

      The accuracy of the device position.

      • Horizontal (float) – [REQUIRED]

        Estimated maximum distance, in meters, between the measured position and the true position of a device, along the Earth’s surface.

    • DeviceId (string) – [REQUIRED]

      The device associated to the position update.

    • Position (list) – [REQUIRED]

      The latest device position defined in WGS 84 format: [X or longitude, Y or latitude].

      • (float) –

    • PositionProperties (dict) –

      Associates one of more properties with the position update. A property is a key-value pair stored with the position update and added to any geofence event the update may trigger.

      Format: "key" : "value"

      • (string) –

        • (string) –

    • SampleTime (datetime) – [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'Errors': [
        {
            'DeviceId': 'string',
            'Error': {
                'Code': 'AccessDeniedError'|'ConflictError'|'InternalServerError'|'ResourceNotFoundError'|'ThrottlingError'|'ValidationError',
                'Message': 'string'
            },
            'SampleTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

• (dict) –

  • Errors (list) –

    Contains error details for each device that failed to update its position.

    • (dict) –

      Contains error details for each device that failed to update its position.

      • DeviceId (string) –

        The device associated with the failed location update.

      • Error (dict) –

        Contains details related to the error code such as the error code and error message.

        • Code (string) –

          The error code associated with the batch request error.

        • Message (string) –

          A message with the reason for the batch request error.

      • SampleTime (datetime) –

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

Exceptions

• LocationService.Client.exceptions.InternalServerException

• LocationService.Client.exceptions.ResourceNotFoundException

• LocationService.Client.exceptions.AccessDeniedException

• LocationService.Client.exceptions.ValidationException

• LocationService.Client.exceptions.ThrottlingException