DeadlineCloud / Client / update_limit

update_limit#

DeadlineCloud.Client.update_limit(**kwargs)#

Updates the properties of the specified limit.

See also: AWS API Documentation

Request Syntax

response = client.update_limit(
    farmId='string',
    limitId='string',
    displayName='string',
    description='string',
    maxCount=123
)
Parameters:

  • farmId (string) –

    [REQUIRED]

    The unique identifier of the farm that contains the limit.

  • limitId (string) –

    [REQUIRED]

    The unique identifier of the limit to update.

  • displayName (string) –

    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.

  • description (string) –

    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.

  • maxCount (integer) –

    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.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions