Class: Aws::LocationService::Types::DescribeGeofenceCollectionResponse

Inherits:

Struct

• Object
• Struct
• Aws::LocationService::Types::DescribeGeofenceCollectionResponse

Defined in:

gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #collection_arn ⇒ String

  The Amazon Resource Name (ARN) for the geofence collection resource.

• #collection_name ⇒ String

  The name of the geofence collection.

• #create_time ⇒ Time

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

• #description ⇒ String

  The optional description for the geofence collection.

• #geofence_count ⇒ Integer

  The number of geofences in the geofence collection.

• #kms_key_id ⇒ String

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

• #pricing_plan ⇒ String

  No longer used.

• #pricing_plan_data_source ⇒ String

  No longer used.

• #tags ⇒ Hash<String,String>

  Displays the key, value pairs of tags associated with this resource.

• #update_time ⇒ Time

  The timestamp for when the geofence collection was last updated in [ISO 8601][1] format: YYYY-MM-DDThh:mm:ss.sssZ.

Instance Attribute Details

#collection_arn ⇒ String

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

• Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection

^

Returns:

• (String)

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

class DescribeGeofenceCollectionResponse < Struct.new(
  :collection_arn,
  :collection_name,
  :create_time,
  :description,
  :geofence_count,
  :kms_key_id,
  :pricing_plan,
  :pricing_plan_data_source,
  :tags,
  :update_time)
  SENSITIVE = []
  include Aws::Structure
end

#collection_name ⇒ String

The name of the geofence collection.

Returns:

• (String)

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

class DescribeGeofenceCollectionResponse < Struct.new(
  :collection_arn,
  :collection_name,
  :create_time,
  :description,
  :geofence_count,
  :kms_key_id,
  :pricing_plan,
  :pricing_plan_data_source,
  :tags,
  :update_time)
  SENSITIVE = []
  include Aws::Structure
end

#create_time ⇒ Time

The timestamp for when the geofence resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Returns:

• (Time)

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

class DescribeGeofenceCollectionResponse < Struct.new(
  :collection_arn,
  :collection_name,
  :create_time,
  :description,
  :geofence_count,
  :kms_key_id,
  :pricing_plan,
  :pricing_plan_data_source,
  :tags,
  :update_time)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The optional description for the geofence collection.

Returns:

• (String)

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

class DescribeGeofenceCollectionResponse < Struct.new(
  :collection_arn,
  :collection_name,
  :create_time,
  :description,
  :geofence_count,
  :kms_key_id,
  :pricing_plan,
  :pricing_plan_data_source,
  :tags,
  :update_time)
  SENSITIVE = []
  include Aws::Structure
end

#geofence_count ⇒ Integer

The number of geofences in the geofence collection.

Returns:

• (Integer)

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

class DescribeGeofenceCollectionResponse < Struct.new(
  :collection_arn,
  :collection_name,
  :create_time,
  :description,
  :geofence_count,
  :kms_key_id,
  :pricing_plan,
  :pricing_plan_data_source,
  :tags,
  :update_time)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

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

Returns:

• (String)

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

class DescribeGeofenceCollectionResponse < Struct.new(
  :collection_arn,
  :collection_name,
  :create_time,
  :description,
  :geofence_count,
  :kms_key_id,
  :pricing_plan,
  :pricing_plan_data_source,
  :tags,
  :update_time)
  SENSITIVE = []
  include Aws::Structure
end

#pricing_plan ⇒ String

No longer used. Always returns RequestBasedUsage.

Returns:

• (String)

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

class DescribeGeofenceCollectionResponse < Struct.new(
  :collection_arn,
  :collection_name,
  :create_time,
  :description,
  :geofence_count,
  :kms_key_id,
  :pricing_plan,
  :pricing_plan_data_source,
  :tags,
  :update_time)
  SENSITIVE = []
  include Aws::Structure
end

#pricing_plan_data_source ⇒ String

No longer used. Always returns an empty string.

Returns:

• (String)

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

class DescribeGeofenceCollectionResponse < Struct.new(
  :collection_arn,
  :collection_name,
  :create_time,
  :description,
  :geofence_count,
  :kms_key_id,
  :pricing_plan,
  :pricing_plan_data_source,
  :tags,
  :update_time)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Displays the key, value pairs of tags associated with this resource.

Returns:

• (Hash<String,String>)

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

class DescribeGeofenceCollectionResponse < Struct.new(
  :collection_arn,
  :collection_name,
  :create_time,
  :description,
  :geofence_count,
  :kms_key_id,
  :pricing_plan,
  :pricing_plan_data_source,
  :tags,
  :update_time)
  SENSITIVE = []
  include Aws::Structure
end

#update_time ⇒ Time

The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Returns:

• (Time)

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

class DescribeGeofenceCollectionResponse < Struct.new(
  :collection_arn,
  :collection_name,
  :create_time,
  :description,
  :geofence_count,
  :kms_key_id,
  :pricing_plan,
  :pricing_plan_data_source,
  :tags,
  :update_time)
  SENSITIVE = []
  include Aws::Structure
end