quota_shares

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

Overview

Name	quota_shares
Type	Resource
Id	aws.batch.quota_shares

Fields

The following fields are returned by SELECT queries:

describe_quota_share

Name	Datatype	Description
capacity_limits	array	A list that specifies the quantity and type of compute capacity allocated to the quota share.
job_queue_arn	string	The ARN of the job queue associated with the quota share.
preemption_configuration	object	Specifies the preemption behavior for jobs in a quota share.
quota_share_arn	string	The Amazon Resource Name (ARN) of the quota share.
quota_share_name	string	The name of the quota share.
resource_sharing_configuration	object	Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.
state	string	The state of the quota share. (ENABLED, DISABLED)
status	string	The current status of the quota share. (CREATING, VALID, INVALID, UPDATING, DELETING)
tags	object	The tags applied to the quota share.

list_quota_shares

Name	Datatype	Description
capacity_limits	array	A list that specifies the quantity and type of compute capacity allocated to the quota share.
job_queue_arn	string	The Amazon Resource Name (ARN) of the job queue associated with the quota share.
preemption_configuration	object	Specifies the preemption behavior for jobs in a quota share.
quota_share_arn	string	The Amazon Resource Name (ARN) of the quota share.
quota_share_name	string	The name of the quota share.
resource_sharing_configuration	object	Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.
state	string	The state of the quota share. (ENABLED, DISABLED)
status	string	The current status of the quota share. (CREATING, VALID, INVALID, UPDATING, DELETING)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_quota_share	select	region		Returns a description of the specified quota share.
list_quota_shares	select	region		Returns a list of Batch quota shares associated with a job queue.
create_quota_share	insert	region, quotaShareName, jobQueue, capacityLimits, resourceSharingConfiguration, preemptionConfiguration		Creates an Batch quota share. Each quota share operates as a virtual queue with a configured compute capacity, resource sharing strategy, and borrow limits.
update_quota_share	update	region, quotaShareArn		Updates a quota share.
delete_quota_share	delete	region		Deletes the specified quota share. You must first disable submissions for the share by updating the state to DISABLED using the UpdateQuotaShare operation. All jobs in the share are eventually terminated when you delete a quota share.

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
region	string	AWS region (default: us-east-1)

SELECT examples

describe_quota_share

Returns a description of the specified quota share.

SELECT
capacity_limits,
job_queue_arn,
preemption_configuration,
quota_share_arn,
quota_share_name,
resource_sharing_configuration,
state,
status,
tags
FROM aws.batch.quota_shares
WHERE region = '{{ region }}' -- required
;

list_quota_shares

Returns a list of Batch quota shares associated with a job queue.

SELECT
capacity_limits,
job_queue_arn,
preemption_configuration,
quota_share_arn,
quota_share_name,
resource_sharing_configuration,
state,
status
FROM aws.batch.quota_shares
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_quota_share

Creates an Batch quota share. Each quota share operates as a virtual queue with a configured compute capacity, resource sharing strategy, and borrow limits.

INSERT INTO aws.batch.quota_shares (
quotaShareName,
jobQueue,
capacityLimits,
resourceSharingConfiguration,
preemptionConfiguration,
state,
tags,
region
)
SELECT 
'{{ quotaShareName }}' /* required */,
'{{ jobQueue }}' /* required */,
'{{ capacityLimits }}' /* required */,
'{{ resourceSharingConfiguration }}' /* required */,
'{{ preemptionConfiguration }}' /* required */,
'{{ state }}',
'{{ tags }}',
'{{ region }}'
RETURNING
quota_share_arn,
quota_share_name
;

Manifest

# Description fields are for documentation purposes
- name: quota_shares
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the quota_shares resource.
  - name: quotaShareName
    value: "{{ quotaShareName }}"
  - name: jobQueue
    value: "{{ jobQueue }}"
  - name: capacityLimits
    value:
      - maxCapacity: {{ maxCapacity }}
        capacityUnit: "{{ capacityUnit }}"
  - name: resourceSharingConfiguration
    description: |
      Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.
    value:
      strategy: "{{ strategy }}"
      borrowLimit: {{ borrowLimit }}
  - name: preemptionConfiguration
    description: |
      Specifies the preemption behavior for jobs in a quota share.
    value:
      inSharePreemption: "{{ inSharePreemption }}"
  - name: state
    value: "{{ state }}"
    valid_values: ['ENABLED', 'DISABLED']
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_quota_share

Updates a quota share.

UPDATE aws.batch.quota_shares
SET 
quotaShareArn = '{{ quotaShareArn }}',
capacityLimits = '{{ capacityLimits }}',
resourceSharingConfiguration = '{{ resourceSharingConfiguration }}',
preemptionConfiguration = '{{ preemptionConfiguration }}',
state = '{{ state }}'
WHERE 
region = '{{ region }}' --required
AND quotaShareArn = '{{ quotaShareArn }}' --required
RETURNING
quota_share_arn,
quota_share_name;

DELETE examples

delete_quota_share

Deletes the specified quota share. You must first disable submissions for the share by updating the state to DISABLED using the UpdateQuotaShare operation. All jobs in the share are eventually terminated when you delete a quota share.

DELETE FROM aws.batch.quota_shares
WHERE region = '{{ region }}' --required
;