associated_contacts

Creates, updates, deletes, gets or lists an associated_contacts resource.

Overview

Name	associated_contacts
Type	Resource
Id	aws.connect.associated_contacts

Fields

The following fields are returned by SELECT queries:

list_associated_contacts

Name	Datatype	Description
contact_summary_list	array	List of the contact summary for all the contacts in contact tree associated with unique identifier.
next_token	string	If there are additional results, this is the token for the next set of results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_associated_contacts	select	instance_id, contactId, region	maxResults, nextToken	Provides information about contact tree, a list of associated contacts with a unique identifier.

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
contactId	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)
maxResults	integer	The maximum number of results to return per page.
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.

SELECT examples

list_associated_contacts

Provides information about contact tree, a list of associated contacts with a unique identifier.

SELECT
contact_summary_list,
next_token
FROM aws.connect.associated_contacts
WHERE instance_id = '{{ instance_id }}' -- required
AND contactId = '{{ contactId }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;