geofence_collections

Creates, updates, deletes, gets or lists a geofence_collections resource.

Overview

Name	geofence_collections
Type	Resource
Id	aws.location.geofence_collections

Fields

The following fields are returned by SELECT queries:

describe_geofence_collection

Name	Datatype	Description
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 (pattern: <code>arn(:[a-z0-9]+([.-][a-z0-9]+)){2}(:([a-z0-9]+([.-][a-z0-9]+))?){2}:([^/].*)?</code>)
collection_name	string	The name of the geofence collection. (pattern: <code>[-._\w]+</code>)
create_time	string (date-time)	The timestamp for when the geofence resource was created in ISO 8601 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 assigned to the Amazon Location resource
pricing_plan	string	No longer used. Always returns RequestBasedUsage. (RequestBasedUsage, MobileAssetTracking, MobileAssetManagement)
pricing_plan_data_source	string	No longer used. Always returns an empty string.
tags	object	Displays the key, value pairs of tags associated with this resource.
update_time	string (date-time)	The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

list_geofence_collections

Name	Datatype	Description
collection_name	string	The name of the geofence collection. (pattern: <code>[-._\w]+</code>)
create_time	string (date-time)	The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
description	string	The description for the geofence collection
pricing_plan	string	No longer used. Always returns RequestBasedUsage. (RequestBasedUsage, MobileAssetTracking, MobileAssetManagement)
pricing_plan_data_source	string	No longer used. Always returns an empty string.
update_time	string (date-time)	Specifies a timestamp for when the resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_geofence_collection	select	collection_name, region		Retrieves the geofence collection details.
list_geofence_collections	select	region		Lists geofence collections in your Amazon Web Services account.
create_geofence_collection	insert	region, CollectionName		Creates a geofence collection, which manages and stores geofences.
update_geofence_collection	update	collection_name, region		Updates the specified properties of a given geofence collection.
delete_geofence_collection	delete	collection_name, region		Deletes a geofence collection from your Amazon Web Services account. This operation deletes the resource permanently. If the geofence collection is the target of a tracker resource, the devices will no longer be monitored.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
collection_name	string	The name of the geofence collection to be deleted.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_geofence_collection

Retrieves the geofence collection details.

SELECT
collection_arn,
collection_name,
create_time,
description,
geofence_count,
kms_key_id,
pricing_plan,
pricing_plan_data_source,
tags,
update_time
FROM aws.location.geofence_collections
WHERE collection_name = '{{ collection_name }}' -- required
AND region = '{{ region }}' -- required
;

list_geofence_collections

Lists geofence collections in your Amazon Web Services account.

SELECT
collection_name,
create_time,
description,
pricing_plan,
pricing_plan_data_source,
update_time
FROM aws.location.geofence_collections
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_geofence_collection

Creates a geofence collection, which manages and stores geofences.

INSERT INTO aws.location.geofence_collections (
CollectionName,
PricingPlan,
PricingPlanDataSource,
Description,
Tags,
KmsKeyId,
region
)
SELECT 
'{{ CollectionName }}' /* required */,
'{{ PricingPlan }}',
'{{ PricingPlanDataSource }}',
'{{ Description }}',
'{{ Tags }}',
'{{ KmsKeyId }}',
'{{ region }}'
RETURNING
collection_arn,
collection_name,
create_time
;

Manifest

# Description fields are for documentation purposes
- name: geofence_collections
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the geofence_collections resource.
  - name: CollectionName
    value: "{{ CollectionName }}"
  - name: PricingPlan
    value: "{{ PricingPlan }}"
    valid_values: ['RequestBasedUsage', 'MobileAssetTracking', 'MobileAssetManagement']
  - name: PricingPlanDataSource
    value: "{{ PricingPlanDataSource }}"
  - name: Description
    value: "{{ Description }}"
  - name: Tags
    value: "{{ Tags }}"
  - name: KmsKeyId
    value: "{{ KmsKeyId }}"

UPDATE examples

update_geofence_collection

Updates the specified properties of a given geofence collection.

UPDATE aws.location.geofence_collections
SET 
PricingPlan = '{{ PricingPlan }}',
PricingPlanDataSource = '{{ PricingPlanDataSource }}',
Description = '{{ Description }}'
WHERE 
collection_name = '{{ collection_name }}' --required
AND region = '{{ region }}' --required
RETURNING
collection_arn,
collection_name,
update_time;

DELETE examples

delete_geofence_collection

Deletes a geofence collection from your Amazon Web Services account. This operation deletes the resource permanently. If the geofence collection is the target of a tracker resource, the devices will no longer be monitored.

DELETE FROM aws.location.geofence_collections
WHERE collection_name = '{{ collection_name }}' --required
AND region = '{{ region }}' --required
;