LocationService / Client / update_tracker

update_tracker

LocationService.Client.update_tracker(**kwargs)

Updates the specified properties of a given tracker resource.

See also: AWS API Documentation

Request Syntax

response = client.update_tracker(
    Description='string',
    PositionFiltering='TimeBased'|'DistanceBased'|'AccuracyBased',
    PricingPlan='RequestBasedUsage'|'MobileAssetTracking'|'MobileAssetManagement',
    PricingPlanDataSource='string',
    TrackerName='string'
)

Parameters:

• Description (string) – Updates the description for the tracker resource.

• PositionFiltering (string) –

  Updates the position filtering for the tracker resource.

  Valid values:

  • TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.

  • DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.

  • AccuracyBased - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This helps educe the effects of GPS noise when displaying device trajectories on a map, and can help control costs by reducing the number of geofence evaluations.

• PricingPlan (string) – No longer used. If included, the only allowed value is RequestBasedUsage.

• PricingPlanDataSource (string) – This parameter is no longer used.

• TrackerName (string) –

  [REQUIRED]

  The name of the tracker resource to update.

Return type:

dict

Returns:

Response Syntax

{
    'TrackerArn': 'string',
    'TrackerName': 'string',
    'UpdateTime': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • TrackerArn (string) –

    The Amazon Resource Name (ARN) of the updated tracker resource. Used to specify a resource across AWS.

    • Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker

  • TrackerName (string) –

    The name of the updated tracker resource.

  • UpdateTime (datetime) –

    The timestamp for when the tracker resource was last updated in 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