configurations

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

Overview

Name	configurations
Type	Resource
Id	aws.omics.configurations

Fields

The following fields are returned by SELECT queries:

get_configuration

Name	Datatype	Description
name	string	User-friendly name for the configuration. (pattern: <code>[A-Za-z0-9][A-Za-z0-9-._]*</code>)
arn	string	Unique resource identifier for the configuration. (pattern: <code>arn:.+</code>)
creation_time	string (date-time)	Configuration creation timestamp.
description	string	Description for the configuration. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
run_configurations	object	Run-specific configurations.
status	string	Current configuration status. (CREATING, ACTIVE, UPDATING, DELETING, DELETED, FAILED)
tags	object	Tags for the configuration.
uuid	string	Unique identifier for the configuration. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)

list_configurations

Name	Datatype	Description
name	string	User-friendly name for the configuration. (pattern: <code>[A-Za-z0-9][A-Za-z0-9-._]*</code>)
arn	string	Unique resource identifier for the configuration. (pattern: <code>arn:.+</code>)
creation_time	string (date-time)	Configuration creation timestamp.
description	string	Description for the configuration. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
status	string	Current configuration status. (CREATING, ACTIVE, UPDATING, DELETING, DELETED, FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_configuration	select	name, region		Retrieve configuration details for specified name.
list_configurations	select	region	maxResults, startingToken	List all configurations for the account.
create_configuration	insert	region, name, runConfigurations, requestId		Create a new configuration.
delete_configuration	delete	name, region		Delete an existing configuration.

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
name	string	Configuration name to delete.
region	string	AWS region (default: us-east-1)
maxResults	integer	Maximum number of results to return.
startingToken	string	Pagination token for retrieving next page of results.

SELECT examples

get_configuration

Retrieve configuration details for specified name.

SELECT
name,
arn,
creation_time,
description,
run_configurations,
status,
tags,
uuid
FROM aws.omics.configurations
WHERE name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
;

list_configurations

List all configurations for the account.

SELECT
name,
arn,
creation_time,
description,
status
FROM aws.omics.configurations
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND startingToken = '{{ startingToken }}'
;

INSERT examples

create_configuration

Create a new configuration.

INSERT INTO aws.omics.configurations (
name,
description,
runConfigurations,
tags,
requestId,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ runConfigurations }}' /* required */,
'{{ tags }}',
'{{ requestId }}' /* required */,
'{{ region }}'
RETURNING
name,
arn,
creation_time,
description,
run_configurations,
status,
tags,
uuid
;

Manifest

# Description fields are for documentation purposes
- name: configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the configurations resource.
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: runConfigurations
    description: |
      Run-specific configuration settings.
    value:
      vpcConfig:
        securityGroupIds:
          - "{{ securityGroupIds }}"
        subnetIds:
          - "{{ subnetIds }}"
  - name: tags
    value: "{{ tags }}"
  - name: requestId
    value: "{{ requestId }}"

DELETE examples

delete_configuration

Delete an existing configuration.

DELETE FROM aws.omics.configurations
WHERE name = '{{ name }}' --required
AND region = '{{ region }}' --required
;