limits

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

Overview

Name	limits
Type	Resource
Id	aws.deadline.limits

Fields

The following fields are returned by SELECT queries:

get_limit

Name	Datatype	Description
amount_requirement_name	string	The value that you specify as the name in the amounts field of the hostRequirements in a step of a job template to declare the limit requirement.
created_at	string (date-time)	The Unix timestamp of the date and time that the limit was created.
created_by	string	The user identifier of the person that created the limit.
current_count	integer	The number of resources from the limit that are being used by jobs. The result is delayed and may not be the count at the time that you called the operation.
description	string	The description of the limit that helps identify what the limit is used for. 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 limit. 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 unique identifier of the farm that contains the limit. (pattern: <code>farm-[0-9a-f]{32}</code>)
limit_id	string	The unique identifier of the limit. (pattern: <code>limit-[0-9a-f]{32}</code>)
max_count	integer	The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available. The maxValue must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.
updated_at	string (date-time)	The Unix timestamp of the date and time that the limit was last updated.
updated_by	string	The user identifier of the person that last updated the limit.

list_limits

Name	Datatype	Description
amount_requirement_name	string	The value that you specify as the name in the amounts field of the hostRequirements in a step of a job template to declare the limit requirement.
created_at	string (date-time)	The Unix timestamp of the date and time that the limit was created.
created_by	string	The user identifier of the person that created the limit.
current_count	integer	The number of resources from the limit that are being used by jobs. The result is delayed and may not be the count at the time that you called the operation.
display_name	string	The name of the limit used in lists to identify the limit. 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 unique identifier of the farm that contains the limit. (pattern: <code>farm-[0-9a-f]{32}</code>)
limit_id	string	The unique identifier of the limit. (pattern: <code>limit-[0-9a-f]{32}</code>)
max_count	integer	The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available. The maxValue must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.
updated_at	string (date-time)	The Unix timestamp of the date and time that the limit was last updated.
updated_by	string	The user identifier of the person that last updated the limit.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_limit	select	farm_id, limit_id, region		Gets information about a specific limit.
list_limits	select	farm_id, region	nextToken, maxResults	Gets a list of limits defined in the specified farm.
create_limit	insert	farm_id, region, displayName, amountRequirementName, maxCount	X-Amz-Client-Token	Creates a limit that manages the distribution of shared resources, such as floating licenses. A limit can throttle work assignments, help manage workloads, and track current usage. Before you use a limit, you must associate the limit with one or more queues. You must add the amountRequirementName to a step in a job template to declare the limit requirement.
update_limit	update	farm_id, limit_id, region		Updates the properties of the specified limit.
delete_limit	delete	farm_id, limit_id, region		Removes a limit from the specified farm. Before you delete a limit you must use the DeleteQueueLimitAssociation operation to remove the association with any queues.

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 limit to delete.
limit_id	string	The unique identifier of the limit 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 limits to return in each page of results.
nextToken	string	The token for the next set of results, or null to start from the beginning.

SELECT examples

get_limit

Gets information about a specific limit.

SELECT
amount_requirement_name,
created_at,
created_by,
current_count,
description,
display_name,
farm_id,
limit_id,
max_count,
updated_at,
updated_by
FROM aws.deadline.limits
WHERE farm_id = '{{ farm_id }}' -- required
AND limit_id = '{{ limit_id }}' -- required
AND region = '{{ region }}' -- required
;

list_limits

Gets a list of limits defined in the specified farm.

SELECT
amount_requirement_name,
created_at,
created_by,
current_count,
display_name,
farm_id,
limit_id,
max_count,
updated_at,
updated_by
FROM aws.deadline.limits
WHERE farm_id = '{{ farm_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_limit

Creates a limit that manages the distribution of shared resources, such as floating licenses. A limit can throttle work assignments, help manage workloads, and track current usage. Before you use a limit, you must associate the limit with one or more queues. You must add the amountRequirementName to a step in a job template to declare the limit requirement.

INSERT INTO aws.deadline.limits (
displayName,
amountRequirementName,
maxCount,
description,
farm_id,
region,
`X-Amz-Client-Token`
)
SELECT 
'{{ displayName }}' /* required */,
'{{ amountRequirementName }}' /* required */,
{{ maxCount }} /* required */,
'{{ description }}',
'{{ farm_id }}',
'{{ region }}',
'{{ X-Amz-Client-Token }}'
RETURNING
limit_id
;

Manifest

# Description fields are for documentation purposes
- name: limits
props:
  - name: farm_id
    value: "{{ farm_id }}"
    description: Required parameter for the limits resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the limits resource.
  - name: displayName
    value: "{{ displayName }}"
  - name: amountRequirementName
    value: "{{ amountRequirementName }}"
  - name: maxCount
    value: {{ maxCount }}
  - name: description
    value: "{{ description }}"
  - 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_limit

Updates the properties of the specified limit.

UPDATE aws.deadline.limits
SET 
displayName = '{{ displayName }}',
description = '{{ description }}',
maxCount = {{ maxCount }}
WHERE 
farm_id = '{{ farm_id }}' --required
AND limit_id = '{{ limit_id }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_limit

Removes a limit from the specified farm. Before you delete a limit you must use the DeleteQueueLimitAssociation operation to remove the association with any queues.

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