QConnect / Client / list_assistant_associations

list_assistant_associations

QConnect.Client.list_assistant_associations(**kwargs)

Lists information about assistant associations.

See also: AWS API Documentation

Request Syntax

response = client.list_assistant_associations(
    nextToken='string',
    maxResults=123,
    assistantId='string'
)
Parameters:

  • 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.

  • maxResults (integer) – The maximum number of results to return per page.

  • assistantId (string) –

    [REQUIRED]

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Return type:

dict

Returns:

Response Syntax

{
    'assistantAssociationSummaries': [
        {
            'assistantAssociationId': 'string',
            'assistantAssociationArn': 'string',
            'assistantId': 'string',
            'assistantArn': 'string',
            'associationType': 'KNOWLEDGE_BASE',
            'associationData': {
                'knowledgeBaseAssociation': {
                    'knowledgeBaseId': 'string',
                    'knowledgeBaseArn': 'string'
                }
            },
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • assistantAssociationSummaries (list) –

      Summary information about assistant associations.

      • (dict) –

        Summary information about the assistant association.

        • assistantAssociationId (string) –

          The identifier of the assistant association.

        • assistantAssociationArn (string) –

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

        • assistantId (string) –

          The identifier of the Amazon Q in Connect assistant.

        • assistantArn (string) –

          The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

        • associationType (string) –

          The type of association.

        • associationData (dict) –

          The association data.

          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.

            • knowledgeBaseId (string) –

              The identifier of the knowledge base.

            • knowledgeBaseArn (string) –

              The Amazon Resource Name (ARN) 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.

Exceptions

  • QConnect.Client.exceptions.ValidationException

  • QConnect.Client.exceptions.AccessDeniedException

  • QConnect.Client.exceptions.ResourceNotFoundException