tracker_consumers

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

Overview

Name	tracker_consumers
Type	Resource
Id	aws.location.tracker_consumers

Fields

The following fields are returned by SELECT queries:

list_tracker_consumers

Name	Datatype	Description
consumer_arn	string	Contains the list of geofence collection ARNs associated to the tracker resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_tracker_consumers	select	tracker_name, region		Lists geofence collections currently associated to the given tracker resource.
associate_tracker_consumer	update	tracker_name, region, ConsumerArn		Creates an association between a geofence collection and a tracker resource. This allows the tracker resource to communicate location data to the linked geofence collection. You can associate up to five geofence collections to each tracker resource. Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.
disassociate_tracker_consumer	update	tracker_name, consumer_arn, region		Removes the association between a tracker resource and a geofence collection. Once you unlink a tracker resource from a geofence collection, the tracker positions will no longer be automatically evaluated against geofences.

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
consumer_arn	string	The Amazon Resource Name (ARN) for the geofence collection to be disassociated from the tracker resource. Used when you need to specify a resource across all Amazon Web Services. Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer
region	string	AWS region (default: us-east-1)
tracker_name	string	The name of the tracker resource to be dissociated from the consumer.

SELECT examples

list_tracker_consumers

Lists geofence collections currently associated to the given tracker resource.

SELECT
consumer_arn
FROM aws.location.tracker_consumers
WHERE tracker_name = '{{ tracker_name }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

associate_tracker_consumer

Creates an association between a geofence collection and a tracker resource. This allows the tracker resource to communicate location data to the linked geofence collection. You can associate up to five geofence collections to each tracker resource. Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.

UPDATE aws.location.tracker_consumers
SET 
ConsumerArn = '{{ ConsumerArn }}'
WHERE 
tracker_name = '{{ tracker_name }}' --required
AND region = '{{ region }}' --required
AND ConsumerArn = '{{ ConsumerArn }}' --required;

disassociate_tracker_consumer

Removes the association between a tracker resource and a geofence collection. Once you unlink a tracker resource from a geofence collection, the tracker positions will no longer be automatically evaluated against geofences.

UPDATE aws.location.tracker_consumers
SET 
-- No updatable properties
WHERE 
tracker_name = '{{ tracker_name }}' --required
AND consumer_arn = '{{ consumer_arn }}' --required
AND region = '{{ region }}' --required;