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

***********
create_farm
***********



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

  

  Creates a farm to allow space for queues and fleets. Farms are the space where the components of your renders gather and are pieced together in the cloud. Farms contain budgets and allow you to enforce permissions. Deadline Cloud farms are a useful container for large projects.

  

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


  **Request Syntax**
  ::

    response = client.create_farm(
        clientToken='string',
        displayName='string',
        description='string',
        kmsKeyArn='string',
        tags={
            'string': 'string'
        }
    )
    
  :type clientToken: string
  :param clientToken: 

    The unique token which the server uses to recognize retries of the same request.

    This field is autopopulated if not provided.

  
  :type displayName: string
  :param displayName: **[REQUIRED]** 

    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.

      

    

  
  :type description: string
  :param description: 

    The description 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.

      

    

  
  :type kmsKeyArn: string
  :param kmsKeyArn: 

    The ARN of the KMS key to use on the farm.

    

  
  :type tags: dict
  :param tags: 

    The tags to add to your farm. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


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

    
    ::

      {
          'farmId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The farm ID.

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

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

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

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

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

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

  