Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14126767600.8 KB

Creates an environment for a queue that defines how jobs in the queue run.

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

Path parameters

farmIdstring required

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

queueIdstring required

The queue ID to connect the queue and environment.

Headers

X-Amz-Client-Tokenstring

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

Request body

priorityinteger required

Sets the priority of the environments in the queue from 0 to 10,000, where 0 is the highest priority (activated first and deactivated last). If two environments share the same priority value, the environment created first takes higher priority.

templateType'JSON' | 'YAML' required

The template's file type, <code>JSON</code> or <code>YAML</code>.

templatestring password required

The environment template to use in the queue.

Response

Success

queueEnvironmentIdstring required

The queue environment ID.