:doc:`CleanRoomsService <../../cleanrooms>` / Paginator / ListCollaborations

******************
ListCollaborations
******************



.. py:class:: CleanRoomsService.Paginator.ListCollaborations

  ::

    
    paginator = client.get_paginator('list_collaborations')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`CleanRoomsService.Client.list_collaborations`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          memberStatus='INVITED'|'ACTIVE',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type memberStatus: string
    :param memberStatus: 

      The caller's status in a collaboration.

      

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

      
      ::

        {
            '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'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

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

                

              
        
      
        

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

          A token to resume pagination.

          
    