workflows

Creates, updates, deletes or gets a workflow resource or lists workflows in a region

Overview

Name	workflows
Type	Resource
Description	Definition of AWS::Omics::Workflow Resource Type
Id	aws.omics.workflows

Fields

Name	Datatype	Description
arn	string
creation_time	string
definition_uri	string
description	string
engine	string
id	string
main	string
name	string
parameter_template	object
status	string
accelerators	string
storage_capacity	number
tags	object	A map of resource tags
type	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all workflows in a region.

SELECT
region,
arn,
creation_time,
definition_uri,
description,
engine,
id,
main,
name,
parameter_template,
status,
accelerators,
storage_capacity,
tags,
type
FROM aws.omics.workflows
WHERE region = 'us-east-1';

Gets all properties from an individual workflow.

SELECT
region,
arn,
creation_time,
definition_uri,
description,
engine,
id,
main,
name,
parameter_template,
status,
accelerators,
storage_capacity,
tags,
type
FROM aws.omics.workflows
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

Use the following StackQL query and manifest file to create a new workflow resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.omics.workflows (
 DefinitionUri,
 Description,
 Engine,
 Main,
 Name,
 ParameterTemplate,
 Accelerators,
 StorageCapacity,
 Tags,
 region
)
SELECT 
'{{ DefinitionUri }}',
 '{{ Description }}',
 '{{ Engine }}',
 '{{ Main }}',
 '{{ Name }}',
 '{{ ParameterTemplate }}',
 '{{ Accelerators }}',
 '{{ StorageCapacity }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.omics.workflows (
 DefinitionUri,
 Description,
 Engine,
 Main,
 Name,
 ParameterTemplate,
 Accelerators,
 StorageCapacity,
 Tags,
 region
)
SELECT 
 '{{ DefinitionUri }}',
 '{{ Description }}',
 '{{ Engine }}',
 '{{ Main }}',
 '{{ Name }}',
 '{{ ParameterTemplate }}',
 '{{ Accelerators }}',
 '{{ StorageCapacity }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: workflow
    props:
      - name: DefinitionUri
        value: '{{ DefinitionUri }}'
      - name: Description
        value: '{{ Description }}'
      - name: Engine
        value: '{{ Engine }}'
      - name: Main
        value: '{{ Main }}'
      - name: Name
        value: '{{ Name }}'
      - name: ParameterTemplate
        value: {}
      - name: Accelerators
        value: '{{ Accelerators }}'
      - name: StorageCapacity
        value: null
      - name: Tags
        value: {}

DELETE example

/*+ delete */
DELETE FROM aws.omics.workflows
WHERE data__Identifier = '<Id>'
AND region = 'us-east-1';

Permissions

To operate on the workflows resource, the following permissions are required:

Create

omics:CreateWorkflow,
omics:GetWorkflow,
omics:TagResource,
s3:PutObject,
s3:GetObject,
s3:GetObjectAttributes,
s3:HeadObject,
s3:GetEncryptionConfiguration,
kms:Decrypt,
kms:GenerateDataKey,
kms:GenerateDataKeyPair,
kms:GenerateDataKeyPairWithoutPlaintext,
kms:GenerateDataKeyWithoutPlaintext

Read

omics:GetWorkflow

Update

omics:UpdateWorkflow,
omics:GetWorkflow,
omics:TagResource,
omics:ListTagsForResource,
omics:UntagResource

Delete

omics:DeleteWorkflow,
omics:GetWorkflow

List

omics:ListWorkflows