queue_limit_associations

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

Overview

Name	queue_limit_associations
Type	Resource
Id	aws.deadline.queue_limit_associations

Fields

The following fields are returned by SELECT queries:

get_queue_limit_association

Name	Datatype	Description
created_at	string (date-time)	The Unix timestamp of the date and time that the association was created.
created_by	string	The user identifier of the person that created the association.
limit_id	string	The unique identifier of the limit associated with the queue. (pattern: <code>limit-[0-9a-f]{32}</code>)
queue_id	string	The unique identifier of the queue associated with the limit. (pattern: <code>queue-[0-9a-f]{32}</code>)
status	string	The current status of the limit. (ACTIVE, STOP_LIMIT_USAGE_AND_COMPLETE_TASKS, STOP_LIMIT_USAGE_AND_CANCEL_TASKS, STOPPED)
updated_at	string (date-time)	The Unix timestamp of the date and time that the association was last updated.
updated_by	string	The user identifier of the person that last updated the association.

list_queue_limit_associations

Name	Datatype	Description
created_at	string (date-time)	The Unix timestamp of the date and time that the association was created.
created_by	string	The user identifier of the person that created the association.
limit_id	string	The unique identifier of the limit in the association. (pattern: <code>limit-[0-9a-f]{32}</code>)
queue_id	string	The unique identifier of the queue in the association. (pattern: <code>queue-[0-9a-f]{32}</code>)
status	string	The status of task scheduling in the queue-limit association. ACTIVE - Association is active. STOP_LIMIT_USAGE_AND_COMPLETE_TASKS - Association has stopped scheduling new tasks and is completing current tasks. STOP_LIMIT_USAGE_AND_CANCEL_TASKS - Association has stopped scheduling new tasks and is canceling current tasks. STOPPED - Association has been stopped. (ACTIVE, STOP_LIMIT_USAGE_AND_COMPLETE_TASKS, STOP_LIMIT_USAGE_AND_CANCEL_TASKS, STOPPED)
updated_at	string (date-time)	The Unix timestamp of the date and time that the association was last updated.
updated_by	string	The user identifier of the person that updated the association.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_queue_limit_association	select	farm_id, queue_id, limit_id, region		Gets information about a specific association between a queue and a limit.
list_queue_limit_associations	select	farm_id, region	nextToken, maxResults, queueId, limitId	Gets a list of the associations between queues and limits defined in a farm.
create_queue_limit_association	insert	farm_id, region, queueId, limitId		Associates a limit with a particular queue. After the limit is associated, all workers for jobs that specify the limit associated with the queue are subject to the limit. You can't associate two limits with the same amountRequirementName to the same queue.
update_queue_limit_association	update	farm_id, queue_id, limit_id, region, status		Updates the status of the queue. If you set the status to one of the STOP_LIMIT_USAGE* values, there will be a delay before the status transitions to the STOPPED state.
delete_queue_limit_association	delete	farm_id, queue_id, limit_id, region		Removes the association between a queue and a limit. You must use the UpdateQueueLimitAssociation operation to set the status to STOP_LIMIT_USAGE_AND_COMPLETE_TASKS or STOP_LIMIT_USAGE_AND_CANCEL_TASKS. The status does not change immediately. Use the GetQueueLimitAssociation operation to see if the status changed to STOPPED before deleting the association.

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 unique identifier of the farm that contains the queue and limit to disassociate.
limit_id	string	The unique identifier of the limit to disassociate.
queue_id	string	The unique identifier of the queue to disassociate.
region	string	AWS region (default: us-east-1)
limitId	string	Specifies that the operation should return only the queue limit associations for the specified limit. If you specify both the queueId and the limitId, only the specified limit is returned if it exists.
maxResults	integer	The maximum number of associations to return in each page of results.
nextToken	string	The token for the next set of results, or null to start from the beginning.
queueId	string	Specifies that the operation should return only the queue limit associations for the specified queue. If you specify both the queueId and the limitId, only the specified limit is returned if it exists.

SELECT examples

get_queue_limit_association

Gets information about a specific association between a queue and a limit.

SELECT
created_at,
created_by,
limit_id,
queue_id,
status,
updated_at,
updated_by
FROM aws.deadline.queue_limit_associations
WHERE farm_id = '{{ farm_id }}' -- required
AND queue_id = '{{ queue_id }}' -- required
AND limit_id = '{{ limit_id }}' -- required
AND region = '{{ region }}' -- required
;

list_queue_limit_associations

Gets a list of the associations between queues and limits defined in a farm.

SELECT
created_at,
created_by,
limit_id,
queue_id,
status,
updated_at,
updated_by
FROM aws.deadline.queue_limit_associations
WHERE farm_id = '{{ farm_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND queueId = '{{ queueId }}'
AND limitId = '{{ limitId }}'
;

INSERT examples

create_queue_limit_association

Associates a limit with a particular queue. After the limit is associated, all workers for jobs that specify the limit associated with the queue are subject to the limit. You can't associate two limits with the same amountRequirementName to the same queue.

INSERT INTO aws.deadline.queue_limit_associations (
queueId,
limitId,
farm_id,
region
)
SELECT 
'{{ queueId }}' /* required */,
'{{ limitId }}' /* required */,
'{{ farm_id }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: queue_limit_associations
props:
  - name: farm_id
    value: "{{ farm_id }}"
    description: Required parameter for the queue_limit_associations resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the queue_limit_associations resource.
  - name: queueId
    value: "{{ queueId }}"
  - name: limitId
    value: "{{ limitId }}"

UPDATE examples

update_queue_limit_association

Updates the status of the queue. If you set the status to one of the STOP_LIMIT_USAGE* values, there will be a delay before the status transitions to the STOPPED state.

UPDATE aws.deadline.queue_limit_associations
SET 
status = '{{ status }}'
WHERE 
farm_id = '{{ farm_id }}' --required
AND queue_id = '{{ queue_id }}' --required
AND limit_id = '{{ limit_id }}' --required
AND region = '{{ region }}' --required
AND status = '{{ status }}' --required;

DELETE examples

delete_queue_limit_association

Removes the association between a queue and a limit. You must use the UpdateQueueLimitAssociation operation to set the status to STOP_LIMIT_USAGE_AND_COMPLETE_TASKS or STOP_LIMIT_USAGE_AND_CANCEL_TASKS. The status does not change immediately. Use the GetQueueLimitAssociation operation to see if the status changed to STOPPED before deleting the association.

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