Class: Aws::LocationService::Types::DescribeTrackerResponse

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#create_timeTime

The timestamp for when the tracker resource was created in [ ISO 8601] format: ‘YYYY-MM-DDThh:mm:ss.sssZ`.

[1]: www.iso.org/iso-8601-date-and-time-format.html

Returns:

  • (Time)


2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
# File 'lib/aws-sdk-locationservice/types.rb', line 2794

class DescribeTrackerResponse < Struct.new(
  :tracker_name,
  :tracker_arn,
  :description,
  :pricing_plan,
  :pricing_plan_data_source,
  :tags,
  :create_time,
  :update_time,
  :kms_key_id,
  :position_filtering,
  :event_bridge_enabled,
  :kms_key_enable_geospatial_queries)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The optional description for the tracker resource.

Returns:

  • (String)


2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
# File 'lib/aws-sdk-locationservice/types.rb', line 2794

class DescribeTrackerResponse < Struct.new(
  :tracker_name,
  :tracker_arn,
  :description,
  :pricing_plan,
  :pricing_plan_data_source,
  :tags,
  :create_time,
  :update_time,
  :kms_key_id,
  :position_filtering,
  :event_bridge_enabled,
  :kms_key_enable_geospatial_queries)
  SENSITIVE = []
  include Aws::Structure
end

#event_bridge_enabledBoolean

Whether ‘UPDATE` events from this tracker in EventBridge are enabled. If set to `true` these events will be sent to EventBridge.

Returns:

  • (Boolean)


2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
# File 'lib/aws-sdk-locationservice/types.rb', line 2794

class DescribeTrackerResponse < Struct.new(
  :tracker_name,
  :tracker_arn,
  :description,
  :pricing_plan,
  :pricing_plan_data_source,
  :tags,
  :create_time,
  :update_time,
  :kms_key_id,
  :position_filtering,
  :event_bridge_enabled,
  :kms_key_enable_geospatial_queries)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_enable_geospatial_queriesBoolean

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.

<note markdown=“1”> If you wish to encrypt your data using your own KMS customer managed key, then the Bounding Polygon Queries feature will be disabled by default. This is because by using this feature, a representation of your device positions will not be encrypted using the your KMS managed key. The exact device position, however; is still encrypted using your managed key.

You can choose to opt-in to the Bounding Polygon Quseries feature.

This is done by setting the ‘KmsKeyEnableGeospatialQueries` parameter to true when creating or updating a Tracker.

</note>

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

Returns:

  • (Boolean)


2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
# File 'lib/aws-sdk-locationservice/types.rb', line 2794

class DescribeTrackerResponse < Struct.new(
  :tracker_name,
  :tracker_arn,
  :description,
  :pricing_plan,
  :pricing_plan_data_source,
  :tags,
  :create_time,
  :update_time,
  :kms_key_id,
  :position_filtering,
  :event_bridge_enabled,
  :kms_key_enable_geospatial_queries)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

A key identifier for an [Amazon Web Services KMS customer managed key] assigned to the Amazon Location resource.

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

Returns:

  • (String)


2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
# File 'lib/aws-sdk-locationservice/types.rb', line 2794

class DescribeTrackerResponse < Struct.new(
  :tracker_name,
  :tracker_arn,
  :description,
  :pricing_plan,
  :pricing_plan_data_source,
  :tags,
  :create_time,
  :update_time,
  :kms_key_id,
  :position_filtering,
  :event_bridge_enabled,
  :kms_key_enable_geospatial_queries)
  SENSITIVE = []
  include Aws::Structure
end

#position_filteringString

The position filtering method of the tracker resource.

Returns:

  • (String)


2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
# File 'lib/aws-sdk-locationservice/types.rb', line 2794

class DescribeTrackerResponse < Struct.new(
  :tracker_name,
  :tracker_arn,
  :description,
  :pricing_plan,
  :pricing_plan_data_source,
  :tags,
  :create_time,
  :update_time,
  :kms_key_id,
  :position_filtering,
  :event_bridge_enabled,
  :kms_key_enable_geospatial_queries)
  SENSITIVE = []
  include Aws::Structure
end

#pricing_planString

Always returns ‘RequestBasedUsage`.

Returns:

  • (String)


2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
# File 'lib/aws-sdk-locationservice/types.rb', line 2794

class DescribeTrackerResponse < Struct.new(
  :tracker_name,
  :tracker_arn,
  :description,
  :pricing_plan,
  :pricing_plan_data_source,
  :tags,
  :create_time,
  :update_time,
  :kms_key_id,
  :position_filtering,
  :event_bridge_enabled,
  :kms_key_enable_geospatial_queries)
  SENSITIVE = []
  include Aws::Structure
end

#pricing_plan_data_sourceString

No longer used. Always returns an empty string.

Returns:

  • (String)


2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
# File 'lib/aws-sdk-locationservice/types.rb', line 2794

class DescribeTrackerResponse < Struct.new(
  :tracker_name,
  :tracker_arn,
  :description,
  :pricing_plan,
  :pricing_plan_data_source,
  :tags,
  :create_time,
  :update_time,
  :kms_key_id,
  :position_filtering,
  :event_bridge_enabled,
  :kms_key_enable_geospatial_queries)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

The tags associated with the tracker resource.

Returns:

  • (Hash<String,String>)


2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
# File 'lib/aws-sdk-locationservice/types.rb', line 2794

class DescribeTrackerResponse < Struct.new(
  :tracker_name,
  :tracker_arn,
  :description,
  :pricing_plan,
  :pricing_plan_data_source,
  :tags,
  :create_time,
  :update_time,
  :kms_key_id,
  :position_filtering,
  :event_bridge_enabled,
  :kms_key_enable_geospatial_queries)
  SENSITIVE = []
  include Aws::Structure
end

#tracker_arnString

The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all Amazon Web Services.

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

^

Returns:

  • (String)


2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
# File 'lib/aws-sdk-locationservice/types.rb', line 2794

class DescribeTrackerResponse < Struct.new(
  :tracker_name,
  :tracker_arn,
  :description,
  :pricing_plan,
  :pricing_plan_data_source,
  :tags,
  :create_time,
  :update_time,
  :kms_key_id,
  :position_filtering,
  :event_bridge_enabled,
  :kms_key_enable_geospatial_queries)
  SENSITIVE = []
  include Aws::Structure
end

#tracker_nameString

The name of the tracker resource.

Returns:

  • (String)


2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
# File 'lib/aws-sdk-locationservice/types.rb', line 2794

class DescribeTrackerResponse < Struct.new(
  :tracker_name,
  :tracker_arn,
  :description,
  :pricing_plan,
  :pricing_plan_data_source,
  :tags,
  :create_time,
  :update_time,
  :kms_key_id,
  :position_filtering,
  :event_bridge_enabled,
  :kms_key_enable_geospatial_queries)
  SENSITIVE = []
  include Aws::Structure
end

#update_timeTime

The timestamp for when the tracker resource was last updated in [ ISO 8601] format: ‘YYYY-MM-DDThh:mm:ss.sssZ`.

[1]: www.iso.org/iso-8601-date-and-time-format.html

Returns:

  • (Time)


2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
# File 'lib/aws-sdk-locationservice/types.rb', line 2794

class DescribeTrackerResponse < Struct.new(
  :tracker_name,
  :tracker_arn,
  :description,
  :pricing_plan,
  :pricing_plan_data_source,
  :tags,
  :create_time,
  :update_time,
  :kms_key_id,
  :position_filtering,
  :event_bridge_enabled,
  :kms_key_enable_geospatial_queries)
  SENSITIVE = []
  include Aws::Structure
end