Patch 2023 10 12farmsfarmidqueue limit associationsqueueidlimitid

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14126767600.8 KB

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

patch/2023-10-12/farms/{farmId}/queue-limit-associations/{queueId}/{limitId}

Path parameters

farmIdstring required

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

queueIdstring required

The unique identifier of the queue associated to the limit.

limitIdstring required

The unique identifier of the limit associated to the queue.

Request body

status'ACTIVE' | 'STOP_LIMIT_USAGE_AND_COMPLETE_TASKS' | 'STOP_LIMIT_USAGE_AND_CANCEL_TASKS' 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.

Response

Success

UpdateQueueLimitAssociationResponse required