queue_environments

Creates, updates, deletes, gets or lists a queue_environments resource.

Overview

Name	queue_environments
Type	Resource
Id	aws.deadline.queue_environments

Fields

The following fields are returned by SELECT queries:

get_queue_environment

Name	Datatype	Description
name	string	The name of the queue environment.
created_at	string (date-time)	The date and time the resource was created.
created_by	string	The user or system that created this resource.>
priority	integer	The priority of the queue environment.
queue_environment_id	string	The queue environment ID. (pattern: <code>queueenv-[0-9a-f]{32}</code>)
template	string	The template for the queue environment.
template_type	string	The type of template for the queue environment. (JSON, YAML)
updated_at	string (date-time)	The date and time the resource was updated.
updated_by	string	The user or system that updated this resource.

list_queue_environments

Name	Datatype	Description
name	string	The name of the queue environment.
priority	integer	The queue environment's priority.
queue_environment_id	string	The queue environment ID. (pattern: <code>queueenv-[0-9a-f]{32}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_queue_environment	select	farm_id, queue_id, queue_environment_id, region		Gets a queue environment.
list_queue_environments	select	farm_id, queue_id, region	nextToken, maxResults	Lists queue environments.
create_queue_environment	insert	farm_id, queue_id, region, priority, templateType, template	X-Amz-Client-Token	Creates an environment for a queue that defines how jobs in the queue run.
update_queue_environment	update	farm_id, queue_id, queue_environment_id, region	X-Amz-Client-Token	Updates the queue environment.
delete_queue_environment	delete	farm_id, queue_id, queue_environment_id, region		Deletes a queue environment.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
farm_id	string	The farm ID of the farm from which to remove the queue environment.
queue_environment_id	string	The queue environment ID of the queue environment to delete.
queue_id	string	The queue ID of the queue environment to delete.
region	string	AWS region (default: us-east-1)
X-Amz-Client-Token	string	The unique token which the server uses to recognize retries of the same request.
maxResults	integer	The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
nextToken	string	The token for the next set of results, or null to start from the beginning.

SELECT examples

get_queue_environment

Gets a queue environment.

SELECT
name,
created_at,
created_by,
priority,
queue_environment_id,
template,
template_type,
updated_at,
updated_by
FROM aws.deadline.queue_environments
WHERE farm_id = '{{ farm_id }}' -- required
AND queue_id = '{{ queue_id }}' -- required
AND queue_environment_id = '{{ queue_environment_id }}' -- required
AND region = '{{ region }}' -- required
;

list_queue_environments

Lists queue environments.

SELECT
name,
priority,
queue_environment_id
FROM aws.deadline.queue_environments
WHERE farm_id = '{{ farm_id }}' -- required
AND queue_id = '{{ queue_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_queue_environment

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

INSERT INTO aws.deadline.queue_environments (
priority,
templateType,
template,
farm_id,
queue_id,
region,
`X-Amz-Client-Token`
)
SELECT 
{{ priority }} /* required */,
'{{ templateType }}' /* required */,
'{{ template }}' /* required */,
'{{ farm_id }}',
'{{ queue_id }}',
'{{ region }}',
'{{ X-Amz-Client-Token }}'
RETURNING
queue_environment_id
;

Manifest

# Description fields are for documentation purposes
- name: queue_environments
props:
  - name: farm_id
    value: "{{ farm_id }}"
    description: Required parameter for the queue_environments resource.
  - name: queue_id
    value: "{{ queue_id }}"
    description: Required parameter for the queue_environments resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the queue_environments resource.
  - name: priority
    value: {{ priority }}
  - name: templateType
    value: "{{ templateType }}"
    valid_values: ['JSON', 'YAML']
  - name: template
    value: "{{ template }}"
  - name: X-Amz-Client-Token
    value: "{{ X-Amz-Client-Token }}"
    description: The unique token which the server uses to recognize retries of the same request.
    description: The unique token which the server uses to recognize retries of the same request.

UPDATE examples

update_queue_environment

Updates the queue environment.

UPDATE aws.deadline.queue_environments
SET 
priority = {{ priority }},
templateType = '{{ templateType }}',
template = '{{ template }}'
WHERE 
farm_id = '{{ farm_id }}' --required
AND queue_id = '{{ queue_id }}' --required
AND queue_environment_id = '{{ queue_environment_id }}' --required
AND region = '{{ region }}' --required
AND `X-Amz-Client-Token` = '{{ X-Amz-Client-Token}}';

DELETE examples

delete_queue_environment

Deletes a queue environment.

DELETE FROM aws.deadline.queue_environments
WHERE farm_id = '{{ farm_id }}' --required
AND queue_id = '{{ queue_id }}' --required
AND queue_environment_id = '{{ queue_environment_id }}' --required
AND region = '{{ region }}' --required
;