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

***********
update_farm
***********



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

  

  Updates a farm.

  

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


  **Request Syntax**
  ::

    response = client.update_farm(
        farmId='string',
        displayName='string',
        description='string'
    )
    
  :type farmId: string
  :param farmId: **[REQUIRED]** 

    The farm ID to update.

    

  
  :type displayName: string
  :param displayName: 

    The display name of the farm to update.

     

    .. 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 to update.

     

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

      

    

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

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **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`

  