contact_attributes

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

Overview

Name	contact_attributes
Type	Resource
Id	aws.connect.contact_attributes

Fields

The following fields are returned by SELECT queries:

get_contact_attributes

Name	Datatype	Description
attributes	object	Information about the attributes.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_contact_attributes	select	instance_id, initial_contact_id, region		Retrieves the contact attributes for the specified contact.
update_contact_attributes	update	region, InitialContactId, InstanceId		Creates or updates user-defined contact attributes associated with the specified contact. You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Connect Customer. You could also flag calls for additional analysis, such as legal review or to identify abusive callers. Contact attributes are available in Connect Customer for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see Feature specifications in the Connect Customer Administrator Guide.

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
initial_contact_id	string	The identifier of the initial contact.
instance_id	string	The identifier of the Connect Customer instance.
region	string	AWS region (default: us-east-1)

SELECT examples

get_contact_attributes

Retrieves the contact attributes for the specified contact.

SELECT
attributes
FROM aws.connect.contact_attributes
WHERE instance_id = '{{ instance_id }}' -- required
AND initial_contact_id = '{{ initial_contact_id }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_contact_attributes

Creates or updates user-defined contact attributes associated with the specified contact. You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Connect Customer. You could also flag calls for additional analysis, such as legal review or to identify abusive callers. Contact attributes are available in Connect Customer for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see Feature specifications in the Connect Customer Administrator Guide.

UPDATE aws.connect.contact_attributes
SET 
InitialContactId = '{{ InitialContactId }}',
InstanceId = '{{ InstanceId }}',
Attributes = '{{ Attributes }}'
WHERE 
region = '{{ region }}' --required
AND InitialContactId = '{{ InitialContactId }}' --required
AND InstanceId = '{{ InstanceId }}' --required;