queues

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

Overview

Name	queues
Type	Resource
Id	aws.deadline.queues

Fields

The following fields are returned by SELECT queries:

get_queue

Name	Datatype	Description
allowed_storage_profile_ids	array	The storage profile IDs for the queue.
blocked_reason	string	The reason the queue was blocked. (NO_BUDGET_CONFIGURED, BUDGET_THRESHOLD_REACHED)
created_at	string (date-time)	The date and time the resource was created.
created_by	string	The user or system that created this resource.
default_budget_action	string	The default action taken on a queue if a budget wasn't configured. (NONE, STOP_SCHEDULING_AND_COMPLETE_TASKS, STOP_SCHEDULING_AND_CANCEL_TASKS)
description	string	The description of the queue. 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.
display_name	string	The display name of the queue. 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.
farm_id	string	The farm ID for the queue. (pattern: <code>farm-[0-9a-f]{32}</code>)
job_attachment_settings	object	The job attachment settings. These are the Amazon S3 bucket name and the Amazon S3 prefix.
job_run_as_user	object	Identifies the user for a job.
queue_id	string	The queue ID. (pattern: <code>queue-[0-9a-f]{32}</code>)
required_file_system_location_names	array	A list of the required file system location names in the queue.
role_arn	string	The IAM role ARN. (pattern: <code>arn:(aws[a-zA-Z-]):iam::\d{12}:role(/[!-.0-~]+)/[\w+=,.@-]+</code>)
scheduling_configuration	object	The scheduling configuration for a queue. Defines the strategy used to assign workers to jobs.
status	string	The status of the queue. ACTIVE–The queue is active. SCHEDULING–The queue is scheduling. SCHEDULING_BLOCKED–The queue scheduling is blocked. See the provided reason. (IDLE, SCHEDULING, SCHEDULING_BLOCKED)
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_queues

Name	Datatype	Description
blocked_reason	string	The reason the queue is blocked, if applicable. (NO_BUDGET_CONFIGURED, BUDGET_THRESHOLD_REACHED)
created_at	string (date-time)	The date and time the resource was created.
created_by	string	The user or system that created this resource.
default_budget_action	string	The default action taken on a queue summary if a budget wasn't configured. (NONE, STOP_SCHEDULING_AND_COMPLETE_TASKS, STOP_SCHEDULING_AND_CANCEL_TASKS)
display_name	string	The display name of the queue summary to update. 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.
farm_id	string	The farm ID. (pattern: <code>farm-[0-9a-f]{32}</code>)
queue_id	string	The queue ID. (pattern: <code>queue-[0-9a-f]{32}</code>)
status	string	That status of the queue. (IDLE, SCHEDULING, SCHEDULING_BLOCKED)
updated_at	string (date-time)	The date and time the resource was updated.
updated_by	string	The user or system that updated this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_queue	select	farm_id, queue_id, region		Gets a queue.
list_queues	select	farm_id, region	nextToken, maxResults, principalId, status	Lists queues.
create_queue	insert	farm_id, region, displayName	X-Amz-Client-Token	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.
associate_member_to_queue	update	farm_id, queue_id, principal_id, region, principalType, identityStoreId, membershipLevel		Assigns a queue membership level to a member
disassociate_member_from_queue	update	farm_id, queue_id, principal_id, region		Disassociates a member from a queue.
update_queue	update	farm_id, queue_id, region	X-Amz-Client-Token	Updates a queue.
delete_queue	delete	farm_id, queue_id, region		Deletes a queue. You can't recover the jobs in a queue if you delete the queue. Deleting the queue also deletes the jobs in that queue.
assume_queue_role_for_read	exec	farm_id, queue_id, region		Gets Amazon Web Services credentials from the queue role. The IAM permissions of the credentials are scoped down to have read-only access.
assume_queue_role_for_user	exec	farm_id, queue_id, region		Allows a user to assume a role for a queue.

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 queue that the user assumes the role for.
principal_id	string	A member's principal ID to disassociate from a queue.
queue_id	string	The queue ID of the queue that the user assumes the role for.
region	string	AWS region (default: us-east-1)
X-Amz-Client-Token	string	The idempotency token to update in the queue.
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.
principalId	string	The principal IDs to include in the list of queues.
status	string	The status of the queues listed. ACTIVE–The queues are active. SCHEDULING–The queues are scheduling. SCHEDULING_BLOCKED–The queue scheduling is blocked for these queues.

SELECT examples

get_queue

Gets a queue.

SELECT
allowed_storage_profile_ids,
blocked_reason,
created_at,
created_by,
default_budget_action,
description,
display_name,
farm_id,
job_attachment_settings,
job_run_as_user,
queue_id,
required_file_system_location_names,
role_arn,
scheduling_configuration,
status,
updated_at,
updated_by
FROM aws.deadline.queues
WHERE farm_id = '{{ farm_id }}' -- required
AND queue_id = '{{ queue_id }}' -- required
AND region = '{{ region }}' -- required
;

list_queues

Lists queues.

SELECT
blocked_reason,
created_at,
created_by,
default_budget_action,
display_name,
farm_id,
queue_id,
status,
updated_at,
updated_by
FROM aws.deadline.queues
WHERE farm_id = '{{ farm_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND principalId = '{{ principalId }}'
AND status = '{{ status }}'
;

INSERT examples

create_queue

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.

INSERT INTO aws.deadline.queues (
displayName,
description,
defaultBudgetAction,
jobAttachmentSettings,
roleArn,
jobRunAsUser,
requiredFileSystemLocationNames,
allowedStorageProfileIds,
tags,
schedulingConfiguration,
farm_id,
region,
`X-Amz-Client-Token`
)
SELECT 
'{{ displayName }}' /* required */,
'{{ description }}',
'{{ defaultBudgetAction }}',
'{{ jobAttachmentSettings }}',
'{{ roleArn }}',
'{{ jobRunAsUser }}',
'{{ requiredFileSystemLocationNames }}',
'{{ allowedStorageProfileIds }}',
'{{ tags }}',
'{{ schedulingConfiguration }}',
'{{ farm_id }}',
'{{ region }}',
'{{ X-Amz-Client-Token }}'
RETURNING
queue_id
;

Manifest

# Description fields are for documentation purposes
- name: queues
props:
  - name: farm_id
    value: "{{ farm_id }}"
    description: Required parameter for the queues resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the queues resource.
  - name: displayName
    value: "{{ displayName }}"
  - name: description
    value: "{{ description }}"
  - name: defaultBudgetAction
    value: "{{ defaultBudgetAction }}"
    valid_values: ['NONE', 'STOP_SCHEDULING_AND_COMPLETE_TASKS', 'STOP_SCHEDULING_AND_CANCEL_TASKS']
  - name: jobAttachmentSettings
    description: |
      The job attachment settings. These are the Amazon S3 bucket name and the Amazon S3 prefix.
    value:
      s3BucketName: "{{ s3BucketName }}"
      rootPrefix: "{{ rootPrefix }}"
  - name: roleArn
    value: "{{ roleArn }}"
  - name: jobRunAsUser
    description: |
      Identifies the user for a job.
    value:
      posix:
        user: "{{ user }}"
        group: "{{ group }}"
      windows:
        user: "{{ user }}"
        passwordArn: "{{ passwordArn }}"
      runAs: "{{ runAs }}"
  - name: requiredFileSystemLocationNames
    value:
      - "{{ requiredFileSystemLocationNames }}"
  - name: allowedStorageProfileIds
    value:
      - "{{ allowedStorageProfileIds }}"
  - name: tags
    value: "{{ tags }}"
  - name: schedulingConfiguration
    description: |
      The scheduling configuration for a queue. Defines the strategy used to assign workers to jobs.
    value:
      priorityFifo: "{{ priorityFifo }}"
      priorityBalanced:
        renderingTaskBuffer: {{ renderingTaskBuffer }}
      weightedBalanced:
        priorityWeight: {{ priorityWeight }}
        errorWeight: {{ errorWeight }}
        submissionTimeWeight: {{ submissionTimeWeight }}
        renderingTaskWeight: {{ renderingTaskWeight }}
        renderingTaskBuffer: {{ renderingTaskBuffer }}
        maxPriorityOverride:
          alwaysScheduleFirst: "{{ alwaysScheduleFirst }}"
        minPriorityOverride:
          alwaysScheduleLast: "{{ alwaysScheduleLast }}"
  - 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

associate_member_to_queue

Assigns a queue membership level to a member

UPDATE aws.deadline.queues
SET 
principalType = '{{ principalType }}',
identityStoreId = '{{ identityStoreId }}',
membershipLevel = '{{ membershipLevel }}',
identityCenterRegion = '{{ identityCenterRegion }}'
WHERE 
farm_id = '{{ farm_id }}' --required
AND queue_id = '{{ queue_id }}' --required
AND principal_id = '{{ principal_id }}' --required
AND region = '{{ region }}' --required
AND principalType = '{{ principalType }}' --required
AND identityStoreId = '{{ identityStoreId }}' --required
AND membershipLevel = '{{ membershipLevel }}' --required;

disassociate_member_from_queue

Disassociates a member from a queue.

UPDATE aws.deadline.queues
SET 
-- No updatable properties
WHERE 
farm_id = '{{ farm_id }}' --required
AND queue_id = '{{ queue_id }}' --required
AND principal_id = '{{ principal_id }}' --required
AND region = '{{ region }}' --required;

update_queue

Updates a queue.

UPDATE aws.deadline.queues
SET 
displayName = '{{ displayName }}',
description = '{{ description }}',
defaultBudgetAction = '{{ defaultBudgetAction }}',
jobAttachmentSettings = '{{ jobAttachmentSettings }}',
roleArn = '{{ roleArn }}',
jobRunAsUser = '{{ jobRunAsUser }}',
requiredFileSystemLocationNamesToAdd = '{{ requiredFileSystemLocationNamesToAdd }}',
requiredFileSystemLocationNamesToRemove = '{{ requiredFileSystemLocationNamesToRemove }}',
allowedStorageProfileIdsToAdd = '{{ allowedStorageProfileIdsToAdd }}',
allowedStorageProfileIdsToRemove = '{{ allowedStorageProfileIdsToRemove }}',
schedulingConfiguration = '{{ schedulingConfiguration }}'
WHERE 
farm_id = '{{ farm_id }}' --required
AND queue_id = '{{ queue_id }}' --required
AND region = '{{ region }}' --required
AND `X-Amz-Client-Token` = '{{ X-Amz-Client-Token}}';

DELETE examples

delete_queue

Deletes a queue. You can't recover the jobs in a queue if you delete the queue. Deleting the queue also deletes the jobs in that queue.

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

Lifecycle Methods

assume_queue_role_for_read

Gets Amazon Web Services credentials from the queue role. The IAM permissions of the credentials are scoped down to have read-only access.

EXEC aws.deadline.queues.assume_queue_role_for_read 
@farm_id='{{ farm_id }}' --required, 
@queue_id='{{ queue_id }}' --required, 
@region='{{ region }}' --required
;

assume_queue_role_for_user

Allows a user to assume a role for a queue.

EXEC aws.deadline.queues.assume_queue_role_for_user 
@farm_id='{{ farm_id }}' --required, 
@queue_id='{{ queue_id }}' --required, 
@region='{{ region }}' --required
;