run_groups

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

Overview

Name	run_groups
Type	Resource
Id	aws.omics.run_groups

Fields

The following fields are returned by SELECT queries:

get_run_group

Name	Datatype	Description
id	string	The group's ID. (pattern: <code>[0-9]+</code>)
name	string	The group's name. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
arn	string	The group's ARN. (pattern: <code>arn:.+</code>)
creation_time	string (date-time)	When the group was created.
max_cpus	integer	The group's maximum number of CPUs to use.
max_duration	integer	The group's maximum run time in minutes.
max_gpus	integer	The maximum GPUs that can be used by a run group.
max_runs	integer	The maximum number of concurrent runs for the group.
tags	object	The group's tags.

list_run_groups

Name	Datatype	Description
id	string	The group's ID. (pattern: <code>[0-9]+</code>)
name	string	The group's name. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
arn	string	The group's ARN. (pattern: <code>arn:.+</code>)
creation_time	string (date-time)	When the group was created.
max_cpus	integer	The group's maximum CPU count setting.
max_duration	integer	The group's maximum duration setting in minutes.
max_gpus	integer	The maximum GPUs that can be used by a run group.
max_runs	integer	The group's maximum concurrent run setting.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_run_group	select	id, region		Gets information about a run group and returns its metadata.
list_run_groups	select	region	name, startingToken, maxResults	Retrieves a list of all run groups and returns the metadata for each run group.
create_run_group	insert	region, requestId		Creates a run group to limit the compute resources for the runs that are added to the group. Returns an ARN, ID, and tags for the run group.
update_run_group	update	id, region		Updates the settings of a run group and returns a response with no body if the operation is successful. You can update the following settings with UpdateRunGroup: Maximum number of CPUs Run time (measured in minutes) Number of GPUs Number of concurrent runs Group name To confirm that the settings have been successfully updated, use the ListRunGroups or GetRunGroup API operations to verify that the desired changes have been made.
delete_run_group	delete	id, region		Deletes a run group and returns a response with no body if the operation is successful. To verify that the run group is deleted: Use ListRunGroups to confirm the workflow no longer appears in the list. Use GetRunGroup to verify the workflow cannot be found.

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
id	string	The run group's ID.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of run groups to return in one page of results.
name	string	The run groups' name.
startingToken	string	Specify the pagination token from a previous request to retrieve the next page of results.

SELECT examples

get_run_group

Gets information about a run group and returns its metadata.

SELECT
id,
name,
arn,
creation_time,
max_cpus,
max_duration,
max_gpus,
max_runs,
tags
FROM aws.omics.run_groups
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_run_groups

Retrieves a list of all run groups and returns the metadata for each run group.

SELECT
id,
name,
arn,
creation_time,
max_cpus,
max_duration,
max_gpus,
max_runs
FROM aws.omics.run_groups
WHERE region = '{{ region }}' -- required
AND name = '{{ name }}'
AND startingToken = '{{ startingToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_run_group

Creates a run group to limit the compute resources for the runs that are added to the group. Returns an ARN, ID, and tags for the run group.

INSERT INTO aws.omics.run_groups (
name,
maxCpus,
maxRuns,
maxDuration,
tags,
requestId,
maxGpus,
region
)
SELECT 
'{{ name }}',
{{ maxCpus }},
{{ maxRuns }},
{{ maxDuration }},
'{{ tags }}',
'{{ requestId }}' /* required */,
{{ maxGpus }},
'{{ region }}'
RETURNING
id,
arn,
tags
;

Manifest

# Description fields are for documentation purposes
- name: run_groups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the run_groups resource.
  - name: name
    value: "{{ name }}"
  - name: maxCpus
    value: {{ maxCpus }}
  - name: maxRuns
    value: {{ maxRuns }}
  - name: maxDuration
    value: {{ maxDuration }}
  - name: tags
    value: "{{ tags }}"
  - name: requestId
    value: "{{ requestId }}"
  - name: maxGpus
    value: {{ maxGpus }}

UPDATE examples

update_run_group

Updates the settings of a run group and returns a response with no body if the operation is successful. You can update the following settings with UpdateRunGroup: Maximum number of CPUs Run time (measured in minutes) Number of GPUs Number of concurrent runs Group name To confirm that the settings have been successfully updated, use the ListRunGroups or GetRunGroup API operations to verify that the desired changes have been made.

UPDATE aws.omics.run_groups
SET 
name = '{{ name }}',
maxCpus = {{ maxCpus }},
maxRuns = {{ maxRuns }},
maxDuration = {{ maxDuration }},
maxGpus = {{ maxGpus }}
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_run_group

Deletes a run group and returns a response with no body if the operation is successful. To verify that the run group is deleted: Use ListRunGroups to confirm the workflow no longer appears in the list. Use GetRunGroup to verify the workflow cannot be found.

DELETE FROM aws.omics.run_groups
WHERE id = '{{ id }}' --required
AND region = '{{ region }}' --required
;