Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14126767600.8 KB

Updates a queue.

patch/2023-10-12/farms/{farmId}/queues/{queueId}

Path parameters

farmIdstring required

The farm ID to update in the queue.

queueIdstring required

The queue ID to update.

Headers

X-Amz-Client-Tokenstring

The idempotency token to update in the queue.

Request body

displayNamestring
<p>The display name of the queue to update.</p> <important> <p>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.</p> </important>
descriptionstring password
<p>The description of the queue to update.</p> <important> <p>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.</p> </important>
defaultBudgetAction'NONE' | 'STOP_SCHEDULING_AND_COMPLETE_TASKS' | 'STOP_SCHEDULING_AND_CANCEL_TASKS'

The default action to take for a queue update if a budget isn't configured.

roleArnstring

The IAM role ARN that's used to run jobs from this queue.

requiredFileSystemLocationNamesToAddFileSystemLocationName[]

The required file system location names to add to the queue.

requiredFileSystemLocationNamesToRemoveFileSystemLocationName[]

The required file system location names to remove from the queue.

allowedStorageProfileIdsToAddStorageProfileId[]

The storage profile IDs to add.

allowedStorageProfileIdsToRemoveStorageProfileId[]

The storage profile ID to remove.

Response

Success

UpdateQueueResponse required