DeadlineCloud / Client / update_queue_limit_association

update_queue_limit_association#

DeadlineCloud.Client.update_queue_limit_association(**kwargs)#

Updates the status of the queue. If you set the status to one of the STOP_LIMIT_USAGE* values, there will be a delay before the status transitions to the STOPPED state.

See also: AWS API Documentation

Request Syntax

response = client.update_queue_limit_association(
    farmId='string',
    queueId='string',
    limitId='string',
    status='ACTIVE'|'STOP_LIMIT_USAGE_AND_COMPLETE_TASKS'|'STOP_LIMIT_USAGE_AND_CANCEL_TASKS'
)
Parameters:

  • farmId (string) –

    [REQUIRED]

    The unique identifier of the farm that contains the associated queues and limits.

  • queueId (string) –

    [REQUIRED]

    The unique identifier of the queue associated to the limit.

  • limitId (string) –

    [REQUIRED]

    The unique identifier of the limit associated to the queue.

  • status (string) –

    [REQUIRED]

    Sets the status of the limit. You can mark the limit active, or you can stop usage of the limit and either complete existing tasks or cancel any existing tasks immediately.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions