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

*********
ListFarms
*********



.. py:class:: DeadlineCloud.Paginator.ListFarms

  ::

    
    paginator = client.get_paginator('list_farms')

  
  

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

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

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


    **Request Syntax**
    ::

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

      The principal ID of the member to list on the farm.

      

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

      
      ::

        {
            'farms': [
                {
                    'farmId': 'string',
                    'displayName': 'string',
                    'kmsKeyArn': 'string',
                    'createdAt': datetime(2015, 1, 1),
                    'createdBy': 'string',
                    'updatedAt': datetime(2015, 1, 1),
                    'updatedBy': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **farms** *(list) --* 

          Farms on the list.

          
          

          - *(dict) --* 

            The summary of details for a farm.

            
            

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

              The farm ID.

              
            

            - **displayName** *(string) --* 

              The display name of the farm.

               

              .. warning::

                 

                This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

                

              
            

            - **kmsKeyArn** *(string) --* 

              The ARN for the KMS key.

              
            

            - **createdAt** *(datetime) --* 

              The date and time the resource was created.

              
            

            - **createdBy** *(string) --* 

              The user or system that created this resource.

              
            

            - **updatedAt** *(datetime) --* 

              The date and time the resource was updated.

              
            

            - **updatedBy** *(string) --* 

              The user or system that updated this resource.

              
        
      
        

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

          A token to resume pagination.

          
    