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

************
update_limit
************



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

  

  Updates the properties of the specified limit.

  

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


  **Request Syntax**
  ::

    response = client.update_limit(
        farmId='string',
        limitId='string',
        displayName='string',
        description='string',
        maxCount=123
    )
    
  :type farmId: string
  :param farmId: **[REQUIRED]** 

    The unique identifier of the farm that contains the limit.

    

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

    The unique identifier of the limit to update.

    

  
  :type displayName: string
  :param displayName: 

    The new display name of the limit.

     

    .. 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 new description of the limit.

     

    .. 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 maxCount: integer
  :param maxCount: 

    The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.

     

    If more than the new maximum number is currently in use, running jobs finish but no new jobs are started until the number of resources in use is below the new maximum number.

     

    The ``maxCount`` must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.

    

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

  