workflow_versions

Creates, updates, deletes or gets a workflow_version resource or lists workflow_versions in a region

Overview

Name	workflow_versions
Type	Resource
Description	Definition of AWS::Omics::WorkflowVersion Resource Type.
Id	awscc.omics.workflow_versions

Fields

get (all properties)

Name	Datatype	Description
arn	string
workflow_id	string
version_name	string
creation_time	string
definition_uri	string
description	string
engine	string
main	string
parameter_template	object
status	string
accelerators	string
storage_type	string
storage_capacity	number
tags	object	A map of resource tags
type	string
uuid	string
workflow_bucket_owner_id	string
parameter_template_path	string	Path to the primary workflow parameter template JSON file inside the repository
▶definition_repository	object
readme_path	string	The path to the workflow README markdown file within the repository. This file provides documentation and usage information for the workflow. If not specified, the README.md file from the root directory of the repository will be used.
readme_uri	string	The S3 URI of the README file for the workflow. This file provides documentation and usage information for the workflow. The S3 URI must begin with s3://USER-OWNED-BUCKET/. The requester must have access to the S3 bucket and object. The max README content length is 500 KiB.
readme_markdown	string	The markdown content for the workflow's README file. This provides documentation and usage information for users of the workflow.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string
region	string	AWS region.

For more information, see AWS::Omics::WorkflowVersion.

Methods

Name	Resource	Accessible by	Required Params
create_resource	workflow_versions	INSERT	WorkflowId, VersionName, region
delete_resource	workflow_versions	DELETE	Identifier, region
update_resource	workflow_versions	UPDATE	Identifier, PatchDocument, region
list_resources	workflow_versions_list_only	SELECT	region
get_resource	workflow_versions	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual workflow_version.

SELECT
  region,
  arn,
  workflow_id,
  version_name,
  creation_time,
  definition_uri,
  description,
  engine,
  main,
  parameter_template,
  status,
  accelerators,
  storage_type,
  storage_capacity,
  tags,
  type,
  uuid,
  workflow_bucket_owner_id,
  parameter_template_path,
  definition_repository,
  readme_path,
  readme_uri,
  readme_markdown
FROM awscc.omics.workflow_versions
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all workflow_versions in a region.

SELECT
  region,
  arn
FROM awscc.omics.workflow_versions_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.omics.workflow_versions (
  WorkflowId,
  VersionName,
  region
)
SELECT
  '{{ workflow_id }}',
  '{{ version_name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.omics.workflow_versions (
  WorkflowId,
  VersionName,
  DefinitionUri,
  Description,
  Engine,
  Main,
  ParameterTemplate,
  Accelerators,
  StorageType,
  StorageCapacity,
  Tags,
  WorkflowBucketOwnerId,
  ParameterTemplatePath,
  DefinitionRepository,
  readmePath,
  readmeUri,
  readmeMarkdown,
  region
)
SELECT
  '{{ workflow_id }}',
  '{{ version_name }}',
  '{{ definition_uri }}',
  '{{ description }}',
  '{{ engine }}',
  '{{ main }}',
  '{{ parameter_template }}',
  '{{ accelerators }}',
  '{{ storage_type }}',
  '{{ storage_capacity }}',
  '{{ tags }}',
  '{{ workflow_bucket_owner_id }}',
  '{{ parameter_template_path }}',
  '{{ definition_repository }}',
  '{{ readme_path }}',
  '{{ readme_uri }}',
  '{{ readme_markdown }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: workflow_version
    props:
      - name: workflow_id
        value: '{{ workflow_id }}'
      - name: version_name
        value: '{{ version_name }}'
      - name: definition_uri
        value: '{{ definition_uri }}'
      - name: description
        value: '{{ description }}'
      - name: engine
        value: '{{ engine }}'
      - name: main
        value: '{{ main }}'
      - name: parameter_template
        value: {}
      - name: accelerators
        value: '{{ accelerators }}'
      - name: storage_type
        value: '{{ storage_type }}'
      - name: storage_capacity
        value: null
      - name: tags
        value: {}
      - name: workflow_bucket_owner_id
        value: '{{ workflow_bucket_owner_id }}'
      - name: parameter_template_path
        value: '{{ parameter_template_path }}'
      - name: definition_repository
        value:
          connection_arn: '{{ connection_arn }}'
          full_repository_id: '{{ full_repository_id }}'
          source_reference:
            type: '{{ type }}'
            value: '{{ value }}'
          exclude_file_patterns:
            - '{{ exclude_file_patterns[0] }}'
      - name: readme_path
        value: '{{ readme_path }}'
      - name: readme_uri
        value: '{{ readme_uri }}'
      - name: readme_markdown
        value: '{{ readme_markdown }}'

UPDATE example

Use the following StackQL query and manifest file to update a workflow_version resource, using stack-deploy.

/*+ update */
UPDATE awscc.omics.workflow_versions
SET PatchDocument = string('{{ {
    "Description": description,
    "StorageType": storage_type,
    "StorageCapacity": storage_capacity,
    "Tags": tags,
    "readmeMarkdown": readme_markdown
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.omics.workflow_versions
WHERE
  Identifier = '{{ arn }}' AND
  region = 'us-east-1';

Permissions

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

Create

omics:CreateWorkflow,
omics:GetWorkflow,
omics:CreateWorkflowVersion,
omics:GetWorkflowVersion,
omics:TagResource,
s3:PutObject,
s3:GetObject,
s3:GetObjectAttributes,
s3:HeadObject,
s3:GetEncryptionConfiguration,
kms:Decrypt,
kms:GenerateDataKey,
kms:GenerateDataKeyPair,
kms:GenerateDataKeyPairWithoutPlaintext,
kms:GenerateDataKeyWithoutPlaintext,
codeconnections:UseConnection,
codeconnections:GetConnection,
codeconnections:GetHost

Read

omics:GetWorkflowVersion,
omics:ListTagsForResource

Update

omics:UpdateWorkflowVersion,
omics:GetWorkflowVersion,
omics:TagResource,
omics:ListTagsForResource,
omics:UntagResource

Delete

omics:DeleteWorkflowVersion,
omics:GetWorkflowVersion

List

omics:ListWorkflowVersions