Amazon Q Connect

2024/06/27 - Amazon Q Connect - 4 new api methods

Changes  Adds CreateContentAssociation, ListContentAssociations, GetContentAssociation, and DeleteContentAssociation APIs.

GetContentAssociation (new) Link ¶

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 .

See also: AWS API Documentation

Request Syntax

client.get_content_association(
    contentAssociationId='string',
    contentId='string',
    knowledgeBaseId='string'
)
type contentAssociationId

string

param contentAssociationId

[REQUIRED]

The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.

type contentId

string

param contentId

[REQUIRED]

The identifier of the content.

type knowledgeBaseId

string

param knowledgeBaseId

[REQUIRED]

The identifier of the knowledge base.

rtype

dict

returns

Response Syntax

{
    'contentAssociation': {
        'associationData': {
            'amazonConnectGuideAssociation': {
                'flowId': 'string'
            }
        },
        'associationType': 'AMAZON_CONNECT_GUIDE',
        'contentArn': 'string',
        'contentAssociationArn': 'string',
        'contentAssociationId': 'string',
        'contentId': 'string',
        'knowledgeBaseArn': 'string',
        'knowledgeBaseId': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • contentAssociation (dict) --

      The association between Amazon Q in Connect content and another resource.

      • associationData (dict) --

        The content association.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: amazonConnectGuideAssociation. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        • amazonConnectGuideAssociation (dict) --

          The data of the step-by-step guide association.

          • flowId (string) --

            The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow.

      • associationType (string) --

        The type of association.

      • contentArn (string) --

        The Amazon Resource Name (ARN) of the content.

      • contentAssociationArn (string) --

        The Amazon Resource Name (ARN) of the content association.

      • contentAssociationId (string) --

        The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.

      • contentId (string) --

        The identifier of the content.

      • knowledgeBaseArn (string) --

        The Amazon Resource Name (ARN) of the knowledge base.

      • knowledgeBaseId (string) --

        The identifier of the knowledge base.

      • tags (dict) --

        The tags used to organize, track, or control access for this resource.

        • (string) --

          • (string) --

DeleteContentAssociation (new) Link ¶

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 .

See also: AWS API Documentation

Request Syntax

client.delete_content_association(
    contentAssociationId='string',
    contentId='string',
    knowledgeBaseId='string'
)
type contentAssociationId

string

param contentAssociationId

[REQUIRED]

The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.

type contentId

string

param contentId

[REQUIRED]

The identifier of the content.

type knowledgeBaseId

string

param knowledgeBaseId

[REQUIRED]

The identifier of the knowledge base.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

ListContentAssociations (new) Link ¶

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 .

See also: AWS API Documentation

Request Syntax

client.list_content_associations(
    contentId='string',
    knowledgeBaseId='string',
    maxResults=123,
    nextToken='string'
)
type contentId

string

param contentId

[REQUIRED]

The identifier of the content.

type knowledgeBaseId

string

param knowledgeBaseId

[REQUIRED]

The identifier of the knowledge base.

type maxResults

integer

param maxResults

The maximum number of results to return per page.

type nextToken

string

param nextToken

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.

rtype

dict

returns

Response Syntax

{
    'contentAssociationSummaries': [
        {
            'associationData': {
                'amazonConnectGuideAssociation': {
                    'flowId': 'string'
                }
            },
            'associationType': 'AMAZON_CONNECT_GUIDE',
            'contentArn': 'string',
            'contentAssociationArn': 'string',
            'contentAssociationId': 'string',
            'contentId': 'string',
            'knowledgeBaseArn': 'string',
            'knowledgeBaseId': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • contentAssociationSummaries (list) --

      Summary information about content associations.

      • (dict) --

        Summary information about a content association.

        • associationData (dict) --

          The content association.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: amazonConnectGuideAssociation. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          • amazonConnectGuideAssociation (dict) --

            The data of the step-by-step guide association.

            • flowId (string) --

              The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow.

        • associationType (string) --

          The type of association.

        • contentArn (string) --

          The Amazon Resource Name (ARN) of the content.

        • contentAssociationArn (string) --

          The Amazon Resource Name (ARN) of the content association.

        • contentAssociationId (string) --

          The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.

        • contentId (string) --

          The identifier of the content.

        • knowledgeBaseArn (string) --

          The Amazon Resource Name (ARN) of the knowledge base.

        • knowledgeBaseId (string) --

          The identifier of the knowledge base.

        • tags (dict) --

          The tags used to organize, track, or control access for this resource.

          • (string) --

            • (string) --

    • nextToken (string) --

      If there are additional results, this is the token for the next set of results.

CreateContentAssociation (new) Link ¶

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 .

See also: AWS API Documentation

Request Syntax

client.create_content_association(
    association={
        'amazonConnectGuideAssociation': {
            'flowId': 'string'
        }
    },
    associationType='AMAZON_CONNECT_GUIDE',
    clientToken='string',
    contentId='string',
    knowledgeBaseId='string',
    tags={
        'string': 'string'
    }
)
type association

dict

param association

[REQUIRED]

The identifier of the associated resource.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: amazonConnectGuideAssociation.

  • amazonConnectGuideAssociation (dict) --

    The data of the step-by-step guide association.

    • flowId (string) --

      The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow.

type associationType

string

param associationType

[REQUIRED]

The type of association.

type clientToken

string

param clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

This field is autopopulated if not provided.

type contentId

string

param contentId

[REQUIRED]

The identifier of the content.

type knowledgeBaseId

string

param knowledgeBaseId

[REQUIRED]

The identifier of the knowledge base.

type tags

dict

param tags

The tags used to organize, track, or control access for this resource.

  • (string) --

    • (string) --

rtype

dict

returns

Response Syntax

{
    'contentAssociation': {
        'associationData': {
            'amazonConnectGuideAssociation': {
                'flowId': 'string'
            }
        },
        'associationType': 'AMAZON_CONNECT_GUIDE',
        'contentArn': 'string',
        'contentAssociationArn': 'string',
        'contentAssociationId': 'string',
        'contentId': 'string',
        'knowledgeBaseArn': 'string',
        'knowledgeBaseId': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • contentAssociation (dict) --

      The association between Amazon Q in Connect content and another resource.

      • associationData (dict) --

        The content association.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: amazonConnectGuideAssociation. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        • amazonConnectGuideAssociation (dict) --

          The data of the step-by-step guide association.

          • flowId (string) --

            The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow.

      • associationType (string) --

        The type of association.

      • contentArn (string) --

        The Amazon Resource Name (ARN) of the content.

      • contentAssociationArn (string) --

        The Amazon Resource Name (ARN) of the content association.

      • contentAssociationId (string) --

        The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.

      • contentId (string) --

        The identifier of the content.

      • knowledgeBaseArn (string) --

        The Amazon Resource Name (ARN) of the knowledge base.

      • knowledgeBaseId (string) --

        The identifier of the knowledge base.

      • tags (dict) --

        The tags used to organize, track, or control access for this resource.

        • (string) --

          • (string) --