DeadlineCloud / Client / create_queue_environment

create_queue_environment#

DeadlineCloud.Client.create_queue_environment(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.create_queue_environment(
    clientToken='string',
    farmId='string',
    priority=123,
    queueId='string',
    template='string',
    templateType='JSON'|'YAML'
)
Parameters:

  • clientToken (string) –

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

    This field is autopopulated if not provided.

  • farmId (string) –

    [REQUIRED]

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

  • priority (integer) –

    [REQUIRED]

    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.

  • queueId (string) –

    [REQUIRED]

    The queue ID to connect the queue and environment.

  • template (string) –

    [REQUIRED]

    The environment template to use in the queue.

  • templateType (string) –

    [REQUIRED]

    The template’s file type, JSON or YAML.

Return type:

dict

Returns:

Response Syntax

{
    'queueEnvironmentId': 'string'
}

Response Structure

  • (dict) –

    • queueEnvironmentId (string) –

      The queue environment ID.

Exceptions