:doc:`DeadlineCloud <../../deadline>` / Paginator / ListFarmMembers

***************
ListFarmMembers
***************



.. py:class:: DeadlineCloud.Paginator.ListFarmMembers

  ::

    
    paginator = client.get_paginator('list_farm_members')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`DeadlineCloud.Client.list_farm_members`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/ListFarmMembers>`_    


    **Request Syntax**
    ::

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

      The farm ID.

      

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

      
      ::

        {
            'members': [
                {
                    'farmId': 'string',
                    'principalId': 'string',
                    'principalType': 'USER'|'GROUP',
                    'identityStoreId': 'string',
                    'membershipLevel': 'VIEWER'|'CONTRIBUTOR'|'OWNER'|'MANAGER'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **members** *(list) --* 

          The members on the list.

          
          

          - *(dict) --* 

            The member of a farm.

            
            

            - **farmId** *(string) --* 

              The farm ID of the farm member.

              
            

            - **principalId** *(string) --* 

              The principal ID of the farm member.

              
            

            - **principalType** *(string) --* 

              The principal type of the farm member.

              
            

            - **identityStoreId** *(string) --* 

              The identity store ID of the farm member.

              
            

            - **membershipLevel** *(string) --* 

              The farm member's membership level.

              
        
      
        

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

          A token to resume pagination.

          
    