CreateQueueEnvironment - AWS Deadline Cloud


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

Request Syntax

POST /2023-10-12/farms/farmId/queues/queueId/environments HTTP/1.1 X-Amz-Client-Token: clientToken Content-type: application/json { "priority": number, "template": "string", "templateType": "string" }

URI Request Parameters

The request uses the following URI parameters.


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

Length Constraints: Minimum length of 1. Maximum length of 64.


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

Pattern: ^farm-[0-9a-f]{32}$

Required: Yes


The queue ID to connect the queue and environment.

Pattern: ^queue-[0-9a-f]{32}$

Required: Yes

Request Body

The request accepts the following data in JSON format.


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

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 10000.

Required: Yes


The environment template to use in the queue.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 15000.

Required: Yes


The template's file type, JSON or YAML.

Type: String

Valid Values: JSON | YAML

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "queueEnvironmentId": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The queue environment ID.

Type: String

Pattern: ^queueenv-[0-9a-f]{32}$


For information about the errors that are common to all actions, see Common Errors.


You don't have permission to perform the action.

HTTP Status Code: 403


Deadline Cloud can't process your request right now. Try again later.

HTTP Status Code: 500


The requested resource can't be found.

HTTP Status Code: 404


You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your AWS account.

HTTP Status Code: 402


Your request exceeded a request rate quota.

HTTP Status Code: 429


The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: