Skip to content

Update Tracker

locationservice_update_tracker R Documentation

Updates the specified properties of a given tracker resource

Description

Updates the specified properties of a given tracker resource.

Usage

locationservice_update_tracker(TrackerName, PricingPlan,
  PricingPlanDataSource, Description, PositionFiltering,
  EventBridgeEnabled, KmsKeyEnableGeospatialQueries)

Arguments

TrackerName

[required] The name of the tracker resource to update.

PricingPlan

No longer used. If included, the only allowed value is RequestBasedUsage.

PricingPlanDataSource

This parameter is no longer used.

Description

Updates the description for the tracker resource.

PositionFiltering

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.

EventBridgeEnabled

Whether to enable position UPDATE events from this tracker to be sent to EventBridge.

You do not need enable this feature to get ENTER and EXIT events for geofences with this tracker. Those events are always sent to EventBridge.

KmsKeyEnableGeospatialQueries

Enables GeospatialQueries for a tracker that uses a Amazon Web Services KMS customer managed key.

This parameter is only used if you are using a KMS customer managed key.

Value

A list with the following syntax: 

list(
  TrackerName = "string",
  TrackerArn = "string",
  UpdateTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$update_tracker(
  TrackerName = "string",
  PricingPlan = "RequestBasedUsage"|"MobileAssetTracking"|"MobileAssetManagement",
  PricingPlanDataSource = "string",
  Description = "string",
  PositionFiltering = "TimeBased"|"DistanceBased"|"AccuracyBased",
  EventBridgeEnabled = TRUE|FALSE,
  KmsKeyEnableGeospatialQueries = TRUE|FALSE
)