contact_references

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

Overview

Name	contact_references
Type	Resource
Id	aws.connect.contact_references

Fields

The following fields are returned by SELECT queries:

list_contact_references

Name	Datatype	Description
attachment	object	Information about the reference when the referenceType is ATTACHMENT. Otherwise, null.
date	object	Information about a reference when the referenceType is DATE. Otherwise, null.
email	object	Information about a reference when the referenceType is EMAIL. Otherwise, null.
email_message	object	Information about the reference when the referenceType is EMAIL_MESSAGE. Otherwise, null.
email_message_plain_text	object	Information about the reference when the referenceType is EMAIL_MESSAGE. Otherwise, null.
email_message_plain_text_redacted	object	Information about the reference when the referenceType is EMAIL_MESSAGE. Otherwise, null.
email_message_redacted	object	Information about the reference when the referenceType is EMAIL_MESSAGE. Otherwise, null.
number	object	Information about a reference when the referenceType is NUMBER. Otherwise, null.
string	object	Information about a reference when the referenceType is STRING. Otherwise, null.
url	object	Information about the reference when the referenceType is URL. Otherwise, null.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_contact_references	select	instance_id, contact_id, referenceTypes, region	nextToken	This API is in preview release for Connect Customer and is subject to change. For the specified referenceTypes, returns a list of references associated with the contact. References are links to documents that are related to a contact, such as emails, attachments, or URLs.

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
contact_id	string	The identifier of the initial contact.
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.
referenceTypes	array	The type of reference.
region	string	AWS region (default: us-east-1)
nextToken	string	The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. This is not expected to be set, because the value returned in the previous response is always null.

SELECT examples

list_contact_references

This API is in preview release for Connect Customer and is subject to change. For the specified referenceTypes, returns a list of references associated with the contact. References are links to documents that are related to a contact, such as emails, attachments, or URLs.

SELECT
attachment,
date,
email,
email_message,
email_message_plain_text,
email_message_plain_text_redacted,
email_message_redacted,
number,
string,
url
FROM aws.connect.contact_references
WHERE instance_id = '{{ instance_id }}' -- required
AND contact_id = '{{ contact_id }}' -- required
AND referenceTypes = '{{ referenceTypes }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
;