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

Inherits:

Struct

• Object
• Struct
• Aws::LocationService::Types::UpdateTrackerRequest

Includes:

Structure

Defined in:

lib/aws-sdk-locationservice/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  Updates the description for the tracker resource.

• #event_bridge_enabled ⇒ Boolean

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

• #kms_key_enable_geospatial_queries ⇒ Boolean

  Enables ‘GeospatialQueries` for a tracker that uses a [Amazon Web Services KMS customer managed key].

• #position_filtering ⇒ String

  Updates the position filtering for the tracker resource.

• #pricing_plan ⇒ String

  No longer used.

• #pricing_plan_data_source ⇒ String

  This parameter is no longer used.

• #tracker_name ⇒ String

  The name of the tracker resource to update.

Instance Attribute Details

#description ⇒ String

Updates the description for the tracker resource.

Returns:

• (String)

# File 'lib/aws-sdk-locationservice/types.rb', line 6967

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

#event_bridge_enabled ⇒ Boolean

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

<note markdown=“1”> 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.

</note>

Returns:

• (Boolean)

# File 'lib/aws-sdk-locationservice/types.rb', line 6967

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

#kms_key_enable_geospatial_queries ⇒ Boolean

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.

[1]: docs.aws.amazon.com/kms/latest/developerguide/create-keys.html

Returns:

• (Boolean)

# File 'lib/aws-sdk-locationservice/types.rb', line 6967

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

#position_filtering ⇒ 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.

Returns:

• (String)

# File 'lib/aws-sdk-locationservice/types.rb', line 6967

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

#pricing_plan ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-locationservice/types.rb', line 6967

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

#pricing_plan_data_source ⇒ String

This parameter is no longer used.

Returns:

• (String)

# File 'lib/aws-sdk-locationservice/types.rb', line 6967

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

#tracker_name ⇒ String

The name of the tracker resource to update.

Returns:

• (String)

# File 'lib/aws-sdk-locationservice/types.rb', line 6967

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