workflow_versions

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

Overview

Name	workflow_versions
Type	Resource
Id	aws.omics.workflow_versions

Fields

The following fields are returned by SELECT queries:

get_workflow_version

Name	Datatype	Description
accelerators	string	The accelerator for this workflow version. (GPU)
arn	string	ARN of the workflow version. (pattern: <code>arn:.+</code>)
container_registry_map	object	Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries. For more information, see Container images in the Amazon Web Services HealthOmics User Guide.
creation_time	string (date-time)	When the workflow version was created.
definition	string	Definition of the workflow version. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
definition_repository_details	object	Details about the source code repository that hosts the workflow version definition files.
description	string	Description of the workflow version. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
digest	string	The workflow version's digest.
engine	string	The workflow engine for this workflow version. (WDL, NEXTFLOW, CWL, WDL_LENIENT)
main	string	The path of the main definition file for the workflow. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
metadata	object	The metadata for the workflow version.
parameter_template	object	The parameter template for the workflow version.
profile_parameter_templates	object	A mapping of profile names to their parameter templates. Each profile defines its own set of parameters that you can use when starting a run with that profile.
profiles	array	The list of Nextflow profiles that are available for this workflow version. Profiles allow you to select predefined configuration settings at runtime.
readme	string	The README content for the workflow version, providing documentation and usage information specific to this version. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
readme_path	string	The path to the workflow version 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. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
status	string	The workflow version status (CREATING, ACTIVE, UPDATING, DELETED, FAILED, INACTIVE)
status_message	string	The workflow version status message (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
storage_capacity	integer	The default run storage capacity for static storage.
storage_type	string	The default storage type for the run. (STATIC, DYNAMIC)
tags	object	The workflow version tags
type_	string	The workflow version type (PRIVATE, READY2RUN)
uuid	string	The universally unique identifier (UUID) value for this workflow version (pattern: <code>[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}</code>)
version_name	string	The workflow version name. (pattern: <code>[A-Za-z0-9][A-Za-z0-9-._]*</code>)
workflow_bucket_owner_id	string	Amazon Web Services Id of the owner of the bucket. (pattern: <code>[0-9]{12}</code>)
workflow_id	string	The workflow's ID. (pattern: <code>[0-9]+</code>)

list_workflow_versions

Name	Datatype	Description
arn	string	ARN of the workflow version. (pattern: <code>arn:.+</code>)
creation_time	string (date-time)	The creation time of the workflow version.
description	string	The description of the workflow version. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
digest	string	The digist of the workflow version.
metadata	object	Metadata for the workflow version.
status	string	The status of the workflow version. (CREATING, ACTIVE, UPDATING, DELETED, FAILED, INACTIVE)
type_	string	The type of the workflow version. (PRIVATE, READY2RUN)
version_name	string	The name of the workflow version. (pattern: <code>[A-Za-z0-9][A-Za-z0-9-._]*</code>)
workflow_id	string	The workflow's ID. (pattern: <code>[0-9]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_workflow_version	select	workflow_id, version_name, region	type, export, workflowOwnerId	Gets information about a workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.
list_workflow_versions	select	workflow_id, region	type, workflowOwnerId, startingToken, maxResults	Lists the workflow versions for the specified workflow. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.
create_workflow_version	insert	workflow_id, region, versionName, requestId		Creates a new workflow version for the workflow that you specify with the workflowId parameter. When you create a new version of a workflow, you need to specify the configuration for the new version. It doesn't inherit any configuration values from the workflow. Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version. Don't include any personally identifiable information (PII) in the version name. Version names appear in the workflow version ARN. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.
update_workflow_version	update	workflow_id, version_name, region		Updates information about the workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.
delete_workflow_version	delete	workflow_id, version_name, region		Deletes a workflow version. Deleting a workflow version doesn't affect any ongoing runs that are using the workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

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)
version_name	string	The workflow version name.
workflow_id	string	The workflow's ID.
export	array	The export format for the workflow.
maxResults	integer	The maximum number of workflows to return in one page of results.
startingToken	string	Specify the pagination token from a previous request to retrieve the next page of results.
type	string	The workflow type.
workflowOwnerId	string	The 12-digit account ID of the workflow owner. The workflow owner ID can be retrieved using the GetShare API operation. If you are the workflow owner, you do not need to include this ID.

SELECT examples

get_workflow_version

Gets information about a workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

SELECT
accelerators,
arn,
container_registry_map,
creation_time,
definition,
definition_repository_details,
description,
digest,
engine,
main,
metadata,
parameter_template,
profile_parameter_templates,
profiles,
readme,
readme_path,
status,
status_message,
storage_capacity,
storage_type,
tags,
type_,
uuid,
version_name,
workflow_bucket_owner_id,
workflow_id
FROM aws.omics.workflow_versions
WHERE workflow_id = '{{ workflow_id }}' -- required
AND version_name = '{{ version_name }}' -- required
AND region = '{{ region }}' -- required
AND type = '{{ type }}'
AND export = '{{ export }}'
AND workflowOwnerId = '{{ workflowOwnerId }}'
;

list_workflow_versions

Lists the workflow versions for the specified workflow. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

SELECT
arn,
creation_time,
description,
digest,
metadata,
status,
type_,
version_name,
workflow_id
FROM aws.omics.workflow_versions
WHERE workflow_id = '{{ workflow_id }}' -- required
AND region = '{{ region }}' -- required
AND type = '{{ type }}'
AND workflowOwnerId = '{{ workflowOwnerId }}'
AND startingToken = '{{ startingToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_workflow_version

Creates a new workflow version for the workflow that you specify with the workflowId parameter. When you create a new version of a workflow, you need to specify the configuration for the new version. It doesn't inherit any configuration values from the workflow. Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version. Don't include any personally identifiable information (PII) in the version name. Version names appear in the workflow version ARN. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

INSERT INTO aws.omics.workflow_versions (
versionName,
definitionZip,
definitionUri,
accelerators,
description,
engine,
main,
parameterTemplate,
requestId,
storageType,
storageCapacity,
tags,
workflowBucketOwnerId,
containerRegistryMap,
containerRegistryMapUri,
readmeMarkdown,
parameterTemplatePath,
readmePath,
definitionRepository,
readmeUri,
workflow_id,
region
)
SELECT 
'{{ versionName }}' /* required */,
'{{ definitionZip }}',
'{{ definitionUri }}',
'{{ accelerators }}',
'{{ description }}',
'{{ engine }}',
'{{ main }}',
'{{ parameterTemplate }}',
'{{ requestId }}' /* required */,
'{{ storageType }}',
{{ storageCapacity }},
'{{ tags }}',
'{{ workflowBucketOwnerId }}',
'{{ containerRegistryMap }}',
'{{ containerRegistryMapUri }}',
'{{ readmeMarkdown }}',
'{{ parameterTemplatePath }}',
'{{ readmePath }}',
'{{ definitionRepository }}',
'{{ readmeUri }}',
'{{ workflow_id }}',
'{{ region }}'
RETURNING
arn,
status,
tags,
uuid,
version_name,
workflow_id
;

Manifest

# Description fields are for documentation purposes
- name: workflow_versions
props:
  - name: workflow_id
    value: "{{ workflow_id }}"
    description: Required parameter for the workflow_versions resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the workflow_versions resource.
  - name: versionName
    value: "{{ versionName }}"
  - name: definitionZip
    value: "{{ definitionZip }}"
  - name: definitionUri
    value: "{{ definitionUri }}"
  - name: accelerators
    value: "{{ accelerators }}"
    valid_values: ['GPU']
  - name: description
    value: "{{ description }}"
  - name: engine
    value: "{{ engine }}"
    valid_values: ['WDL', 'NEXTFLOW', 'CWL', 'WDL_LENIENT']
  - name: main
    value: "{{ main }}"
  - name: parameterTemplate
    value: "{{ parameterTemplate }}"
  - name: requestId
    value: "{{ requestId }}"
  - name: storageType
    value: "{{ storageType }}"
    valid_values: ['STATIC', 'DYNAMIC']
  - name: storageCapacity
    value: {{ storageCapacity }}
  - name: tags
    value: "{{ tags }}"
  - name: workflowBucketOwnerId
    value: "{{ workflowBucketOwnerId }}"
  - name: containerRegistryMap
    description: |
      Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries. For more information, see Container images in the Amazon Web Services HealthOmics User Guide.
    value:
      registryMappings:
        - upstreamRegistryUrl: "{{ upstreamRegistryUrl }}"
          ecrRepositoryPrefix: "{{ ecrRepositoryPrefix }}"
          upstreamRepositoryPrefix: "{{ upstreamRepositoryPrefix }}"
          ecrAccountId: "{{ ecrAccountId }}"
      imageMappings:
        - sourceImage: "{{ sourceImage }}"
          destinationImage: "{{ destinationImage }}"
  - name: containerRegistryMapUri
    value: "{{ containerRegistryMapUri }}"
  - name: readmeMarkdown
    value: "{{ readmeMarkdown }}"
  - name: parameterTemplatePath
    value: "{{ parameterTemplatePath }}"
  - name: readmePath
    value: "{{ readmePath }}"
  - name: definitionRepository
    description: |
      Contains information about a source code repository that hosts the workflow definition files.
    value:
      connectionArn: "{{ connectionArn }}"
      fullRepositoryId: "{{ fullRepositoryId }}"
      sourceReference:
        type_: "{{ type_ }}"
        value: "{{ value }}"
      excludeFilePatterns:
        - "{{ excludeFilePatterns }}"
  - name: readmeUri
    value: "{{ readmeUri }}"

UPDATE examples

update_workflow_version

Updates information about the workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

UPDATE aws.omics.workflow_versions
SET 
description = '{{ description }}',
storageType = '{{ storageType }}',
storageCapacity = {{ storageCapacity }},
readmeMarkdown = '{{ readmeMarkdown }}'
WHERE 
workflow_id = '{{ workflow_id }}' --required
AND version_name = '{{ version_name }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_workflow_version

Deletes a workflow version. Deleting a workflow version doesn't affect any ongoing runs that are using the workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

DELETE FROM aws.omics.workflow_versions
WHERE workflow_id = '{{ workflow_id }}' --required
AND version_name = '{{ version_name }}' --required
AND region = '{{ region }}' --required
;