Class: Aws::LocationService::Types::UpdateTrackerRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb

Overview

Note:

When making an API call, you may pass UpdateTrackerRequest data as a hash:

{
  description: "ResourceDescription",
  position_filtering: "TimeBased", # accepts TimeBased, DistanceBased
  pricing_plan: "RequestBasedUsage", # accepts RequestBasedUsage, MobileAssetTracking, MobileAssetManagement
  pricing_plan_data_source: "String",
  tracker_name: "ResourceName", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

Updates the description for the tracker resource.

Returns:

  • (String)


5223
5224
5225
5226
5227
5228
5229
5230
5231
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 5223

class UpdateTrackerRequest < Struct.new(
  :description,
  :position_filtering,
  :pricing_plan,
  :pricing_plan_data_source,
  :tracker_name)
  SENSITIVE = []
  include Aws::Structure
end

#position_filteringString

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 device positions to retrieve. Distance-based filtering can also reduce the jitter effect when displaying device trajectory on a map.

Returns:

  • (String)


5223
5224
5225
5226
5227
5228
5229
5230
5231
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 5223

class UpdateTrackerRequest < Struct.new(
  :description,
  :position_filtering,
  :pricing_plan,
  :pricing_plan_data_source,
  :tracker_name)
  SENSITIVE = []
  include Aws::Structure
end

#pricing_planString

Updates the pricing plan for the tracker resource.

For more information about each pricing plan option restrictions, see Amazon Location Service pricing.

Returns:

  • (String)


5223
5224
5225
5226
5227
5228
5229
5230
5231
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 5223

class UpdateTrackerRequest < Struct.new(
  :description,
  :position_filtering,
  :pricing_plan,
  :pricing_plan_data_source,
  :tracker_name)
  SENSITIVE = []
  include Aws::Structure
end

#pricing_plan_data_sourceString

Updates the data provider for the tracker resource.

A required value for the following pricing plans: MobileAssetTracking| MobileAssetManagement

For more information about data providers and pricing plans, see the Amazon Location Service product page

This can only be updated when updating the PricingPlan in the same request.

Amazon Location Service uses PricingPlanDataSource to calculate billing for your tracker resource. Your data won't be shared with the data provider, and will remain in your AWS account and Region unless you move it.

Returns:

  • (String)


5223
5224
5225
5226
5227
5228
5229
5230
5231
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 5223

class UpdateTrackerRequest < Struct.new(
  :description,
  :position_filtering,
  :pricing_plan,
  :pricing_plan_data_source,
  :tracker_name)
  SENSITIVE = []
  include Aws::Structure
end

#tracker_nameString

The name of the tracker resource to update.

Returns:

  • (String)


5223
5224
5225
5226
5227
5228
5229
5230
5231
# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 5223

class UpdateTrackerRequest < Struct.new(
  :description,
  :position_filtering,
  :pricing_plan,
  :pricing_plan_data_source,
  :tracker_name)
  SENSITIVE = []
  include Aws::Structure
end