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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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) 


2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
 
# File 'lib/aws-sdk-locationservice/types.rb', line 2317

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

#collection_name ⇒ String

The name of the geofence collection.

Returns:

  • (String) 


2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
 
# File 'lib/aws-sdk-locationservice/types.rb', line 2317

class DescribeGeofenceCollectionResponse < Struct.new(
  :collection_name,
  :collection_arn,
  :description,
  :pricing_plan,
  :pricing_plan_data_source,
  :kms_key_id,
  :tags,
  :create_time,
  :update_time,
  :geofence_count)
  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`

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

Returns:

  • (Time) 


2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
 
# File 'lib/aws-sdk-locationservice/types.rb', line 2317

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

#description ⇒ String

The optional description for the geofence collection.

Returns:

  • (String) 


2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
 
# File 'lib/aws-sdk-locationservice/types.rb', line 2317

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

#geofence_count ⇒ Integer

The number of geofences in the geofence collection.

Returns:

  • (Integer) 


2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
 
# File 'lib/aws-sdk-locationservice/types.rb', line 2317

class DescribeGeofenceCollectionResponse < Struct.new(
  :collection_name,
  :collection_arn,
  :description,
  :pricing_plan,
  :pricing_plan_data_source,
  :kms_key_id,
  :tags,
  :create_time,
  :update_time,
  :geofence_count)
  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

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

Returns:

  • (String) 


2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
 
# File 'lib/aws-sdk-locationservice/types.rb', line 2317

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

#pricing_plan ⇒ String

No longer used. Always returns ‘RequestBasedUsage`.

Returns:

  • (String) 


2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
 
# File 'lib/aws-sdk-locationservice/types.rb', line 2317

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

#pricing_plan_data_source ⇒ String

No longer used. Always returns an empty string.

Returns:

  • (String) 


2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
 
# File 'lib/aws-sdk-locationservice/types.rb', line 2317

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

#tags ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
 
# File 'lib/aws-sdk-locationservice/types.rb', line 2317

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

#update_time ⇒ Time

The timestamp for when the geofence collection was last updated in

ISO 8601][1

format: ‘YYYY-MM-DDThh:mm:ss.sssZ`

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

Returns:

  • (Time) 


2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
 
# File 'lib/aws-sdk-locationservice/types.rb', line 2317

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