assistant_associations

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

Overview

Name	assistant_associations
Type	Resource
Id	aws.qconnect.assistant_associations

Fields

The following fields are returned by SELECT queries:

get_assistant_association

Name	Datatype	Description
assistant_arn	string	The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. (pattern: <code>arn:[a-z-]?:wisdom:[a-z0-9-]?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}</code>)
assistant_association_arn	string	The Amazon Resource Name (ARN) of the assistant association. (pattern: <code>arn:[a-z-]?:wisdom:[a-z0-9-]?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}</code>)
assistant_association_id	string	The identifier of the assistant association. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
assistant_id	string	The identifier of the Amazon Q in Connect assistant. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
association_data	object	A union type that currently has a single argument, the knowledge base ID.
association_type	string	The type of association. (KNOWLEDGE_BASE, EXTERNAL_BEDROCK_KNOWLEDGE_BASE)
tags	object	The tags used to organize, track, or control access for this resource.

list_assistant_associations

Name	Datatype	Description
assistant_arn	string	The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant. (pattern: <code>arn:[a-z-]?:wisdom:[a-z0-9-]?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}</code>)
assistant_association_arn	string	The Amazon Resource Name (ARN) of the assistant association. (pattern: <code>arn:[a-z-]?:wisdom:[a-z0-9-]?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}</code>)
assistant_association_id	string	The identifier of the assistant association. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
assistant_id	string	The identifier of the Amazon Q in Connect assistant. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
association_data	object	The association data.
association_type	string	The type of association. (KNOWLEDGE_BASE, EXTERNAL_BEDROCK_KNOWLEDGE_BASE)
tags	object	The tags used to organize, track, or control access for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_assistant_association	select	assistant_association_id, assistant_id, region		Retrieves information about an assistant association.
list_assistant_associations	select	assistant_id, region	nextToken, maxResults	Lists information about assistant associations.
create_assistant_association	insert	assistant_id, region, associationType, association		Creates an association between an Amazon Q in Connect assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.
delete_assistant_association	delete	assistant_association_id, assistant_id, region		Deletes an assistant association.

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
assistant_association_id	string	The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
assistant_id	string	The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
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

get_assistant_association

Retrieves information about an assistant association.

SELECT
assistant_arn,
assistant_association_arn,
assistant_association_id,
assistant_id,
association_data,
association_type,
tags
FROM aws.qconnect.assistant_associations
WHERE assistant_association_id = '{{ assistant_association_id }}' -- required
AND assistant_id = '{{ assistant_id }}' -- required
AND region = '{{ region }}' -- required
;

list_assistant_associations

Lists information about assistant associations.

SELECT
assistant_arn,
assistant_association_arn,
assistant_association_id,
assistant_id,
association_data,
association_type,
tags
FROM aws.qconnect.assistant_associations
WHERE assistant_id = '{{ assistant_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_assistant_association

Creates an association between an Amazon Q in Connect assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.

INSERT INTO aws.qconnect.assistant_associations (
associationType,
association,
clientToken,
tags,
assistant_id,
region
)
SELECT 
'{{ associationType }}' /* required */,
'{{ association }}' /* required */,
'{{ clientToken }}',
'{{ tags }}',
'{{ assistant_id }}',
'{{ region }}'
RETURNING
assistant_association
;

Manifest

# Description fields are for documentation purposes
- name: assistant_associations
props:
  - name: assistant_id
    value: "{{ assistant_id }}"
    description: Required parameter for the assistant_associations resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the assistant_associations resource.
  - name: associationType
    value: "{{ associationType }}"
    valid_values: ['KNOWLEDGE_BASE', 'EXTERNAL_BEDROCK_KNOWLEDGE_BASE']
  - name: association
    description: |
      The data that is input into Amazon Q in Connect as a result of the assistant association.
    value:
      knowledgeBaseId: "{{ knowledgeBaseId }}"
      externalBedrockKnowledgeBaseConfig:
        bedrockKnowledgeBaseArn: "{{ bedrockKnowledgeBaseArn }}"
        accessRoleArn: "{{ accessRoleArn }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: tags
    value: "{{ tags }}"

DELETE examples

delete_assistant_association

Deletes an assistant association.

DELETE FROM aws.qconnect.assistant_associations
WHERE assistant_association_id = '{{ assistant_association_id }}' --required
AND assistant_id = '{{ assistant_id }}' --required
AND region = '{{ region }}' --required
;