Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14126767600.8 KB

Creates a queue to coordinate the order in which jobs run on a farm. A queue can also specify where to pull resources and indicate where to output completed jobs.

post/2023-10-12/farms/{farmId}/queues

Path parameters

farmIdstring required

The farm ID of the farm to connect to the queue.

Headers

X-Amz-Client-Tokenstring

The unique token which the server uses to recognize retries of the same request.

Request body

displayNamestring required
<p>The display name of the queue.</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.</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 on a queue if a budget isn't configured.

roleArnstring

The IAM role ARN that workers will use while running jobs for this queue.

requiredFileSystemLocationNamesFileSystemLocationName[]

The file system location name to include in the queue.

allowedStorageProfileIdsStorageProfileId[]

The storage profile IDs to include in the queue.

tagsobject

Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

Response

Success

queueIdstring required

The queue ID.