content_associations

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

Overview

Name	content_associations
Type	Resource
Id	aws.qconnect.content_associations

Fields

The following fields are returned by SELECT queries:

get_content_association

Name	Datatype	Description
association_data	object	The contents of a content association.
association_type	string	The type of association. (AMAZON_CONNECT_GUIDE)
content_arn	string	The Amazon Resource Name (ARN) of the content. (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>)
content_association_arn	string	The Amazon Resource Name (ARN) of the content 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>)
content_association_id	string	The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
content_id	string	The identifier of the content. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
knowledge_base_arn	string	The Amazon Resource Name (ARN) of the knowledge base. (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>)
knowledge_base_id	string	The identifier of the knowledge base. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
tags	object	The tags used to organize, track, or control access for this resource.

list_content_associations

Name	Datatype	Description
association_data	object	The contents of a content association.
association_type	string	The type of association. (AMAZON_CONNECT_GUIDE)
content_arn	string	The Amazon Resource Name (ARN) of the content. (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>)
content_association_arn	string	The Amazon Resource Name (ARN) of the content 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>)
content_association_id	string	The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
content_id	string	The identifier of the content. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
knowledge_base_arn	string	The Amazon Resource Name (ARN) of the knowledge base. (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>)
knowledge_base_id	string	The identifier of the knowledge base. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
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_content_association	select	knowledge_base_id, content_id, content_association_id, region		Returns the content association. For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.
list_content_associations	select	knowledge_base_id, content_id, region	nextToken, maxResults	Lists the content associations. For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.
create_content_association	insert	knowledge_base_id, content_id, region, associationType, association		Creates an association between a content resource in a knowledge base and step-by-step guides. Step-by-step guides offer instructions to agents for resolving common customer issues. You create a content association to integrate Amazon Q in Connect and step-by-step guides. After you integrate Amazon Q and step-by-step guides, when Amazon Q provides a recommendation to an agent based on the intent that it's detected, it also provides them with the option to start the step-by-step guide that you have associated with the content. Note the following limitations: You can create only one content association for each content resource in a knowledge base. You can associate a step-by-step guide with multiple content resources. For more information, see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.
delete_content_association	delete	knowledge_base_id, content_id, content_association_id, region		Deletes the content association. For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

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
content_association_id	string	The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
content_id	string	The identifier of the content.
knowledge_base_id	string	The identifier of the knowledge base.
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_content_association

Returns the content association. For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

SELECT
association_data,
association_type,
content_arn,
content_association_arn,
content_association_id,
content_id,
knowledge_base_arn,
knowledge_base_id,
tags
FROM aws.qconnect.content_associations
WHERE knowledge_base_id = '{{ knowledge_base_id }}' -- required
AND content_id = '{{ content_id }}' -- required
AND content_association_id = '{{ content_association_id }}' -- required
AND region = '{{ region }}' -- required
;

list_content_associations

Lists the content associations. For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

SELECT
association_data,
association_type,
content_arn,
content_association_arn,
content_association_id,
content_id,
knowledge_base_arn,
knowledge_base_id,
tags
FROM aws.qconnect.content_associations
WHERE knowledge_base_id = '{{ knowledge_base_id }}' -- required
AND content_id = '{{ content_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_content_association

Creates an association between a content resource in a knowledge base and step-by-step guides. Step-by-step guides offer instructions to agents for resolving common customer issues. You create a content association to integrate Amazon Q in Connect and step-by-step guides. After you integrate Amazon Q and step-by-step guides, when Amazon Q provides a recommendation to an agent based on the intent that it's detected, it also provides them with the option to start the step-by-step guide that you have associated with the content. Note the following limitations: You can create only one content association for each content resource in a knowledge base. You can associate a step-by-step guide with multiple content resources. For more information, see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

INSERT INTO aws.qconnect.content_associations (
clientToken,
associationType,
association,
tags,
knowledge_base_id,
content_id,
region
)
SELECT 
'{{ clientToken }}',
'{{ associationType }}' /* required */,
'{{ association }}' /* required */,
'{{ tags }}',
'{{ knowledge_base_id }}',
'{{ content_id }}',
'{{ region }}'
RETURNING
content_association
;

Manifest

# Description fields are for documentation purposes
- name: content_associations
props:
  - name: knowledge_base_id
    value: "{{ knowledge_base_id }}"
    description: Required parameter for the content_associations resource.
  - name: content_id
    value: "{{ content_id }}"
    description: Required parameter for the content_associations resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the content_associations resource.
  - name: clientToken
    value: "{{ clientToken }}"
  - name: associationType
    value: "{{ associationType }}"
    valid_values: ['AMAZON_CONNECT_GUIDE']
  - name: association
    description: |
      The contents of a content association.
    value:
      amazonConnectGuideAssociation:
        flowId: "{{ flowId }}"
  - name: tags
    value: "{{ tags }}"

DELETE examples

delete_content_association

Deletes the content association. For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

DELETE FROM aws.qconnect.content_associations
WHERE knowledge_base_id = '{{ knowledge_base_id }}' --required
AND content_id = '{{ content_id }}' --required
AND content_association_id = '{{ content_association_id }}' --required
AND region = '{{ region }}' --required
;