:doc:`CleanRoomsService <../../cleanrooms>` / Client / list_collaborations

*******************
list_collaborations
*******************



.. py:method:: CleanRoomsService.Client.list_collaborations(**kwargs)

  

  Lists collaborations the caller owns, is active in, or has been invited to.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cleanrooms-2022-02-17/ListCollaborations>`_  


  **Request Syntax**
  ::

    response = client.list_collaborations(
        nextToken='string',
        maxResults=123,
        memberStatus='INVITED'|'ACTIVE'
    )
    
  :type nextToken: string
  :param nextToken: 

    The pagination token that's used to fetch the next set of results.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.

    

  
  :type memberStatus: string
  :param memberStatus: 

    The caller's status in a collaboration.

    

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

    
    ::

      {
          'nextToken': 'string',
          'collaborationList': [
              {
                  'id': 'string',
                  'arn': 'string',
                  'name': 'string',
                  'creatorAccountId': 'string',
                  'creatorDisplayName': 'string',
                  'createTime': datetime(2015, 1, 1),
                  'updateTime': datetime(2015, 1, 1),
                  'memberStatus': 'INVITED'|'ACTIVE'|'LEFT'|'REMOVED',
                  'membershipId': 'string',
                  'membershipArn': 'string',
                  'analyticsEngine': 'SPARK'|'CLEAN_ROOMS_SQL'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **nextToken** *(string) --* 

        The pagination token that's used to fetch the next set of results.

        
      

      - **collaborationList** *(list) --* 

        The list of collaborations.

        
        

        - *(dict) --* 

          The metadata of the collaboration.

          
          

          - **id** *(string) --* 

            The identifier for the collaboration.

            
          

          - **arn** *(string) --* 

            The ARN of the collaboration.

            
          

          - **name** *(string) --* 

            A human-readable identifier provided by the collaboration owner. Display names are not unique.

            
          

          - **creatorAccountId** *(string) --* 

            The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

            
          

          - **creatorDisplayName** *(string) --* 

            The display name of the collaboration creator.

            
          

          - **createTime** *(datetime) --* 

            The time when the collaboration was created.

            
          

          - **updateTime** *(datetime) --* 

            The time the collaboration metadata was last updated.

            
          

          - **memberStatus** *(string) --* 

            The status of a member in a collaboration.

            
          

          - **membershipId** *(string) --* 

            The identifier of a member in a collaboration.

            
          

          - **membershipArn** *(string) --* 

            The ARN of a member in a collaboration.

            
          

          - **analyticsEngine** *(string) --* 

            The analytics engine.

             

            .. note::

              

              After July 16, 2025, the ``CLEAN_ROOMS_SQL`` parameter will no longer be available.

              

            
      
    
  
  **Exceptions**
  
  *   :py:class:`CleanRoomsService.Client.exceptions.InternalServerException`

  
  *   :py:class:`CleanRoomsService.Client.exceptions.ValidationException`

  
  *   :py:class:`CleanRoomsService.Client.exceptions.ThrottlingException`

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

  