ConnectWisdomService / Client / create_assistant_association

create_assistant_association#

ConnectWisdomService.Client.create_assistant_association(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.create_assistant_association(
    assistantId='string',
    association={
        'knowledgeBaseId': 'string'
    },
    associationType='KNOWLEDGE_BASE',
    clientToken='string',
    tags={
        'string': 'string'
    }
)
Parameters:

  • assistantId (string) –

    [REQUIRED]

    The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • association (dict) –

    [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: knowledgeBaseId.

    • knowledgeBaseId (string) –

      The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you’re storing Wisdom Content resource to it.

  • associationType (string) –

    [REQUIRED]

    The type of association.

  • clientToken (string) –

    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.

  • tags (dict) –

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

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'assistantAssociation': {
        'assistantArn': 'string',
        'assistantAssociationArn': 'string',
        'assistantAssociationId': 'string',
        'assistantId': 'string',
        'associationData': {
            'knowledgeBaseAssociation': {
                'knowledgeBaseArn': 'string',
                'knowledgeBaseId': 'string'
            }
        },
        'associationType': 'KNOWLEDGE_BASE',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • assistantAssociation (dict) –

      The assistant association.

      • assistantArn (string) –

        The Amazon Resource Name (ARN) of the Wisdom assistant.

      • assistantAssociationArn (string) –

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

      • assistantAssociationId (string) –

        The identifier of the assistant association.

      • assistantId (string) –

        The identifier of the Wisdom assistant.

      • associationData (dict) –

        A union type that currently has a single argument, the knowledge base ID.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: knowledgeBaseAssociation. 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'}

        • knowledgeBaseAssociation (dict) –

          The knowledge base where output data is sent.

          • knowledgeBaseArn (string) –

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

          • knowledgeBaseId (string) –

            The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you’re storing Wisdom Content resource to it.

      • associationType (string) –

        The type of association.

      • tags (dict) –

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

        • (string) –

          • (string) –

Exceptions