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

*************************
list_content_associations
*************************



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

  

  Lists the content associations.

   

  For more information about content associations--what they are and when they are used--see `Integrate Amazon Q in Connect with step-by-step guides <https://docs.aws.amazon.com/connect/latest/adminguide/integrate-q-with-guides.html>`__ in the *Amazon Connect Administrator Guide*.

  

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


  **Request Syntax**
  ::

    response = client.list_content_associations(
        nextToken='string',
        maxResults=123,
        knowledgeBaseId='string',
        contentId='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 knowledgeBaseId: string
  :param knowledgeBaseId: **[REQUIRED]** 

    The identifier of the knowledge base.

    

  
  :type contentId: string
  :param contentId: **[REQUIRED]** 

    The identifier of the content.

    

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

    
    ::

      {
          'contentAssociationSummaries': [
              {
                  'knowledgeBaseId': 'string',
                  'knowledgeBaseArn': 'string',
                  'contentId': 'string',
                  'contentArn': 'string',
                  'contentAssociationId': 'string',
                  'contentAssociationArn': 'string',
                  'associationType': 'AMAZON_CONNECT_GUIDE',
                  'associationData': {
                      'amazonConnectGuideAssociation': {
                          'flowId': 'string'
                      }
                  },
                  'tags': {
                      'string': 'string'
                  }
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **contentAssociationSummaries** *(list) --* 

        Summary information about content associations.

        
        

        - *(dict) --* 

          Summary information about a content association.

          
          

          - **knowledgeBaseId** *(string) --* 

            The identifier of the knowledge base.

            
          

          - **knowledgeBaseArn** *(string) --* 

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

            
          

          - **contentId** *(string) --* 

            The identifier of the content.

            
          

          - **contentArn** *(string) --* 

            The Amazon Resource Name (ARN) of the content.

            
          

          - **contentAssociationId** *(string) --* 

            The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.

            
          

          - **contentAssociationArn** *(string) --* 

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

            
          

          - **associationType** *(string) --* 

            The type of association.

            
          

          - **associationData** *(dict) --* 

            The content association.

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


          
            

            - **amazonConnectGuideAssociation** *(dict) --* 

              The data of the step-by-step guide association.

              
              

              - **flowId** *(string) --* 

                The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow.

                
          
        
          

          - **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.UnauthorizedException`

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

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

  