connect_instance_integrations

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

Overview

Name	connect_instance_integrations
Type	Resource
Id	aws.connectcampaignsv2.connect_instance_integrations

Fields

The following fields are returned by SELECT queries:

list_connect_instance_integrations

Name	Datatype	Description
customer_profiles	object	Customer Profiles integration summary
lambda	object	Lambda integration summary
q_connect	object	Q Connect integration summary

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_connect_instance_integrations	select	connect_instance_id, region	maxResults, nextToken	Provides summary information about the integration under the specified Connect instance.
put_connect_instance_integration	replace	connect_instance_id, region, integrationConfig		Put or update the integration for the specified Amazon Connect instance.
delete_connect_instance_integration	delete	connect_instance_id, region		Delete the integration for the specified Amazon Connect instance.

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
connect_instance_id	string
region	string	AWS region (default: us-east-1)
maxResults	integer
nextToken	string

SELECT examples

list_connect_instance_integrations

Provides summary information about the integration under the specified Connect instance.

SELECT
customer_profiles,
lambda,
q_connect
FROM aws.connectcampaignsv2.connect_instance_integrations
WHERE connect_instance_id = '{{ connect_instance_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

REPLACE examples

put_connect_instance_integration

Put or update the integration for the specified Amazon Connect instance.

REPLACE aws.connectcampaignsv2.connect_instance_integrations
SET 
integrationConfig = '{{ integrationConfig }}'
WHERE 
connect_instance_id = '{{ connect_instance_id }}' --required
AND region = '{{ region }}' --required
AND integrationConfig = '{{ integrationConfig }}' --required;

DELETE examples

delete_connect_instance_integration

Delete the integration for the specified Amazon Connect instance.

DELETE FROM aws.connectcampaignsv2.connect_instance_integrations
WHERE connect_instance_id = '{{ connect_instance_id }}' --required
AND region = '{{ region }}' --required
;