:doc:`QConnect <../../qconnect>` / Client / list_assistant_associations

***************************
list_assistant_associations
***************************



.. py:method:: QConnect.Client.list_assistant_associations(**kwargs)

  

  Lists information about assistant associations.

  

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


  **Request Syntax**
  ::

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

    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.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return per page.

    

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

    

  
  
  :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) --* 

        If there are additional results, this is the token for the next set of results.

        
  
  **Exceptions**
  
  *   :py:class:`QConnect.Client.exceptions.ValidationException`

  
  *   :py:class:`QConnect.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`QConnect.Client.exceptions.ResourceNotFoundException`

  