:doc:`DeadlineCloud <../../deadline>` / Client / list_farms

**********
list_farms
**********



.. py:method:: DeadlineCloud.Client.list_farms(**kwargs)

  

  Lists farms.

  

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


  **Request Syntax**
  ::

    response = client.list_farms(
        nextToken='string',
        principalId='string',
        maxResults=123
    )
    
  :type nextToken: string
  :param nextToken: 

    The token for the next set of results, or ``null`` to start from the beginning.

    

  
  :type principalId: string
  :param principalId: 

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

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return. Use this parameter with ``NextToken`` to get results as a set of sequential pages.

    

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

    
    ::

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

    

    - *(dict) --* 
      

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

        If Deadline Cloud returns ``nextToken``, then there are more results available. The value of ``nextToken`` is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then ``nextToken`` is set to ``null``. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ``ValidationException`` error.

        
      

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

            
      
    
  
  **Exceptions**
  
  *   :py:class:`DeadlineCloud.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`DeadlineCloud.Client.exceptions.InternalServerErrorException`

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

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

  