QConnect / Client / get_content_association

get_content_association#

QConnect.Client.get_content_association(**kwargs)#

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

response = client.get_content_association(
    contentAssociationId='string',
    contentId='string',
    knowledgeBaseId='string'
)
Parameters:

  • contentAssociationId (string) –

    [REQUIRED]

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

  • contentId (string) –

    [REQUIRED]

    The identifier of the content.

  • knowledgeBaseId (string) –

    [REQUIRED]

    The identifier of the knowledge base.

Return type:

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) –

Exceptions

  • QConnect.Client.exceptions.ValidationException

  • QConnect.Client.exceptions.AccessDeniedException

  • QConnect.Client.exceptions.ResourceNotFoundException