integration_associations

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

Overview

Name	integration_associations
Type	Resource
Id	aws.connect.integration_associations

Fields

The following fields are returned by SELECT queries:

list_integration_associations

Name	Datatype	Description
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.
integration_arn	string	The Amazon Resource Name (ARN) for the AppIntegration.
integration_association_arn	string	The Amazon Resource Name (ARN) for the AppIntegration association.
integration_association_id	string	The identifier for the AppIntegration association.
integration_type	string	The integration type. (EVENT, VOICE_ID, PINPOINT_APP, WISDOM_ASSISTANT, WISDOM_KNOWLEDGE_BASE, WISDOM_QUICK_RESPONSES, Q_MESSAGE_TEMPLATES, CASES_DOMAIN, APPLICATION, FILE_SCANNER, SES_IDENTITY, ANALYTICS_CONNECTOR, CALL_TRANSFER_CONNECTOR, COGNITO_USER_POOL, MESSAGE_PROCESSOR)
source_application_name	string	The user-provided, friendly name for the external application. (pattern: <code>^[a-zA-Z0-9_ -]+$</code>)
source_application_url	string	The URL for the external application.
source_type	string	The name of the source. (SALESFORCE, ZENDESK, CASES)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_integration_associations	select	instance_id, region	integrationType, nextToken, maxResults, integrationArn	Provides summary information about the Amazon Web Services resource associations for the specified Connect Customer instance.
create_integration_association	insert	instance_id, region, IntegrationType, IntegrationArn		Creates an Amazon Web Services resource association with an Connect Customer instance.
delete_integration_association	delete	instance_id, integration_association_id, region		Deletes an Amazon Web Services resource association from an Connect Customer instance. The association must not have any use cases associated with it.

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
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.
integration_association_id	string	The identifier for the integration association.
region	string	AWS region (default: us-east-1)
integrationArn	string	The Amazon Resource Name (ARN) of the integration.
integrationType	string	The integration type.
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_integration_associations

Provides summary information about the Amazon Web Services resource associations for the specified Connect Customer instance.

SELECT
instance_id,
integration_arn,
integration_association_arn,
integration_association_id,
integration_type,
source_application_name,
source_application_url,
source_type
FROM aws.connect.integration_associations
WHERE instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
AND integrationType = '{{ integrationType }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND integrationArn = '{{ integrationArn }}'
;

INSERT examples

create_integration_association

Creates an Amazon Web Services resource association with an Connect Customer instance.

INSERT INTO aws.connect.integration_associations (
IntegrationType,
IntegrationArn,
SourceApplicationUrl,
SourceApplicationName,
SourceType,
Tags,
instance_id,
region
)
SELECT 
'{{ IntegrationType }}' /* required */,
'{{ IntegrationArn }}' /* required */,
'{{ SourceApplicationUrl }}',
'{{ SourceApplicationName }}',
'{{ SourceType }}',
'{{ Tags }}',
'{{ instance_id }}',
'{{ region }}'
RETURNING
integration_association_arn,
integration_association_id
;

Manifest

# Description fields are for documentation purposes
- name: integration_associations
props:
  - name: instance_id
    value: "{{ instance_id }}"
    description: Required parameter for the integration_associations resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the integration_associations resource.
  - name: IntegrationType
    value: "{{ IntegrationType }}"
    valid_values: ['EVENT', 'VOICE_ID', 'PINPOINT_APP', 'WISDOM_ASSISTANT', 'WISDOM_KNOWLEDGE_BASE', 'WISDOM_QUICK_RESPONSES', 'Q_MESSAGE_TEMPLATES', 'CASES_DOMAIN', 'APPLICATION', 'FILE_SCANNER', 'SES_IDENTITY', 'ANALYTICS_CONNECTOR', 'CALL_TRANSFER_CONNECTOR', 'COGNITO_USER_POOL', 'MESSAGE_PROCESSOR']
  - name: IntegrationArn
    value: "{{ IntegrationArn }}"
  - name: SourceApplicationUrl
    value: "{{ SourceApplicationUrl }}"
  - name: SourceApplicationName
    value: "{{ SourceApplicationName }}"
  - name: SourceType
    value: "{{ SourceType }}"
    valid_values: ['SALESFORCE', 'ZENDESK', 'CASES']
  - name: Tags
    value: "{{ Tags }}"

DELETE examples

delete_integration_association

Deletes an Amazon Web Services resource association from an Connect Customer instance. The association must not have any use cases associated with it.

DELETE FROM aws.connect.integration_associations
WHERE instance_id = '{{ instance_id }}' --required
AND integration_association_id = '{{ integration_association_id }}' --required
AND region = '{{ region }}' --required
;