:doc:`QConnect <../../qconnect>` / Paginator / ListAssistantAssociations

*************************
ListAssistantAssociations
*************************



.. py:class:: QConnect.Paginator.ListAssistantAssociations

  ::

    
    paginator = client.get_paginator('list_assistant_associations')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`QConnect.Client.list_assistant_associations`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAssistantAssociations>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          assistantId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type assistantId: string
    :param assistantId: **[REQUIRED]** 

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

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'assistantAssociationSummaries': [
                {
                    'assistantAssociationId': 'string',
                    'assistantAssociationArn': 'string',
                    'assistantId': 'string',
                    'assistantArn': 'string',
                    'associationType': 'KNOWLEDGE_BASE'|'EXTERNAL_BEDROCK_KNOWLEDGE_BASE',
                    'associationData': {
                        'knowledgeBaseAssociation': {
                            'knowledgeBaseId': 'string',
                            'knowledgeBaseArn': 'string'
                        },
                        'externalBedrockKnowledgeBaseConfig': {
                            'bedrockKnowledgeBaseArn': 'string',
                            'accessRoleArn': '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``, ``externalBedrockKnowledgeBaseConfig``.     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.

                  
            
              

              - **externalBedrockKnowledgeBaseConfig** *(dict) --* 

                The configuration for an external Bedrock knowledge base association in the output data.

                
                

                - **bedrockKnowledgeBaseArn** *(string) --* 

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

                  
                

                - **accessRoleArn** *(string) --* 

                  The Amazon Resource Name (ARN) of the IAM role used to access the external Bedrock knowledge base.

                  
            
          
            

            - **tags** *(dict) --* 

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

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    