QConnect / Paginator / ListAssistantAssociations


class QConnect.Paginator.ListAssistantAssociations#
paginator = client.get_paginator('list_assistant_associations')

Creates an iterator that will paginate through responses from QConnect.Client.list_assistant_associations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • assistantId (string) –


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

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



Response Syntax

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

Response Structure

  • (dict) –

    • assistantAssociationSummaries (list) –

      Summary information about assistant associations.

      • (dict) –

        Summary information about the assistant association.

        • assistantArn (string) –

          The Amazon Resource Name (ARN) of the Amazon Q in Connect 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 Amazon Q in Connect assistant.

        • associationData (dict) –

          The association data.


          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.

        • associationType (string) –

          The type of association.

        • tags (dict) –

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

          • (string) –

            • (string) –

    • NextToken (string) –

      A token to resume pagination.