tags

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

Overview

Name	tags
Type	Resource
Id	aws.connect.tags

Fields

The following fields are returned by SELECT queries:

list_tags_for_resource

Name	Datatype	Description
tags	object	Information about the tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_tags_for_resource	select	resource_arn, region		Lists the tags for the specified resource. For sample policies that use tags, see Connect Customer Identity-Based Policy Examples in the Connect Customer Administrator Guide.
untag_contact	update	contact_id, instance_id, TagKeys, region		Removes the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Connect Customer usage.
tag_resource	update	resource_arn, region, tags		Adds the specified tags to the specified resource. Some of the supported resource types are agents, routing profiles, queues, quick connects, flows, agent statuses, hours of operation, phone numbers, security profiles, task templates, and custom metrics. For a complete list, see Tagging resources in Connect Customer. For sample policies that use tags, see Connect Customer Identity-Based Policy Examples in the Connect Customer Administrator Guide.
tag_contact	update	region, ContactId, InstanceId		Adds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Connect Customer usage.
untag_resource	update	resource_arn, region	tagKeys	Removes the specified tags from the specified resource.

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
TagKeys	array	A list of tag keys. Existing tags on the contact whose keys are members of this list will be removed.
contact_id	string	The identifier of the contact in this instance of Connect Customer.
instance_id	string	The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
region	string	AWS region (default: us-east-1)
resource_arn	string	The Amazon Resource Name (ARN) of the resource.
tagKeys	array	The tag keys.

SELECT examples

list_tags_for_resource

Lists the tags for the specified resource. For sample policies that use tags, see Connect Customer Identity-Based Policy Examples in the Connect Customer Administrator Guide.

SELECT
tags
FROM aws.connect.tags
WHERE resource_arn = '{{ resource_arn }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

untag_contact

Removes the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Connect Customer usage.

UPDATE aws.connect.tags
SET 
-- No updatable properties
WHERE 
contact_id = '{{ contact_id }}' --required
AND instance_id = '{{ instance_id }}' --required
AND TagKeys = '{{ TagKeys }}' --required
AND region = '{{ region }}' --required;

tag_resource

Adds the specified tags to the specified resource. Some of the supported resource types are agents, routing profiles, queues, quick connects, flows, agent statuses, hours of operation, phone numbers, security profiles, task templates, and custom metrics. For a complete list, see Tagging resources in Connect Customer. For sample policies that use tags, see Connect Customer Identity-Based Policy Examples in the Connect Customer Administrator Guide.

UPDATE aws.connect.tags
SET 
tags = '{{ tags }}'
WHERE 
resource_arn = '{{ resource_arn }}' --required
AND region = '{{ region }}' --required
AND tags = '{{ tags }}' --required;

tag_contact

Adds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Connect Customer usage.

UPDATE aws.connect.tags
SET 
ContactId = '{{ ContactId }}',
InstanceId = '{{ InstanceId }}',
Tags = '{{ Tags }}'
WHERE 
region = '{{ region }}' --required
AND ContactId = '{{ ContactId }}' --required
AND InstanceId = '{{ InstanceId }}' --required;

untag_resource

Removes the specified tags from the specified resource.

UPDATE aws.connect.tags
SET 
-- No updatable properties
WHERE 
resource_arn = '{{ resource_arn }}' --required
AND region = '{{ region }}' --required
AND tagKeys = '{{ tagKeys}}';