Class: Aws::Omics::Types::CreateWorkflowVersionRequest

Inherits:

Struct

Object
Struct
Aws::Omics::Types::CreateWorkflowVersionRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-omics/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#accelerators ⇒ String

The computational accelerator for this workflow version.
#container_registry_map ⇒ Types::ContainerRegistryMap

(Optional) Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries.
#container_registry_map_uri ⇒ String

(Optional) URI of the S3 location for the registry mapping file.
#definition_repository ⇒ Types::DefinitionRepository

The repository information for the workflow version definition.
#definition_uri ⇒ String

The S3 URI of a definition for this workflow version.
#definition_zip ⇒ String

A ZIP archive containing the main workflow definition file and dependencies that it imports for this workflow version.
#description ⇒ String

A description for this workflow version.
#engine ⇒ String

The workflow engine for this workflow version.
#main ⇒ String

The path of the main definition file for this workflow version.
#parameter_template ⇒ Hash<String,Types::WorkflowParameter>

A parameter template for this workflow version.
#parameter_template_path ⇒ String

The path to the workflow version parameter template JSON file within the repository.
#readme_markdown ⇒ String

The markdown content for the workflow version’s README file.
#readme_path ⇒ String

The path to the workflow version README markdown file within the repository.
#readme_uri ⇒ String

The S3 URI of the README file for the workflow version.
#request_id ⇒ String

An idempotency token to ensure that duplicate workflows are not created when Amazon Web Services HealthOmics submits retry requests.
#storage_capacity ⇒ Integer

The default static storage capacity (in gibibytes) for runs that use this workflow version.
#storage_type ⇒ String

The default storage type for runs that use this workflow version.
#tags ⇒ Hash<String,String>

Tags for this workflow version.
#version_name ⇒ String

A name for the workflow version.
#workflow_bucket_owner_id ⇒ String

Amazon Web Services Id of the owner of the S3 bucket that contains the workflow definition.
#workflow_id ⇒ String

The ID of the workflow where you are creating the new version.

Instance Attribute Details

#accelerators ⇒ `String`

The computational accelerator for this workflow version.

Returns:

(String)

# File 'lib/aws-sdk-omics/types.rb', line 1725

class CreateWorkflowVersionRequest < Struct.new(
  :workflow_id,
  :version_name,
  :definition_zip,
  :definition_uri,
  :accelerators,
  :description,
  :engine,
  :main,
  :parameter_template,
  :request_id,
  :storage_type,
  :storage_capacity,
  :tags,
  :workflow_bucket_owner_id,
  :container_registry_map,
  :container_registry_map_uri,
  :readme_markdown,
  :parameter_template_path,
  :readme_path,
  :definition_repository,
  :readme_uri)
  SENSITIVE = []
  include Aws::Structure
end

#container_registry_map ⇒ `Types::ContainerRegistryMap`

(Optional) 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*.

[1]: docs.aws.amazon.com/omics/latest/dev/workflows-ecr.html

Returns:

(Types::ContainerRegistryMap)

# File 'lib/aws-sdk-omics/types.rb', line 1725

class CreateWorkflowVersionRequest < Struct.new(
  :workflow_id,
  :version_name,
  :definition_zip,
  :definition_uri,
  :accelerators,
  :description,
  :engine,
  :main,
  :parameter_template,
  :request_id,
  :storage_type,
  :storage_capacity,
  :tags,
  :workflow_bucket_owner_id,
  :container_registry_map,
  :container_registry_map_uri,
  :readme_markdown,
  :parameter_template_path,
  :readme_path,
  :definition_repository,
  :readme_uri)
  SENSITIVE = []
  include Aws::Structure
end

#container_registry_map_uri ⇒ `String`

(Optional) URI of the S3 location for the registry mapping file.

Returns:

(String)

# File 'lib/aws-sdk-omics/types.rb', line 1725

class CreateWorkflowVersionRequest < Struct.new(
  :workflow_id,
  :version_name,
  :definition_zip,
  :definition_uri,
  :accelerators,
  :description,
  :engine,
  :main,
  :parameter_template,
  :request_id,
  :storage_type,
  :storage_capacity,
  :tags,
  :workflow_bucket_owner_id,
  :container_registry_map,
  :container_registry_map_uri,
  :readme_markdown,
  :parameter_template_path,
  :readme_path,
  :definition_repository,
  :readme_uri)
  SENSITIVE = []
  include Aws::Structure
end

#definition_repository ⇒ `Types::DefinitionRepository`

The repository information for the workflow version definition. This allows you to source your workflow version definition directly from a code repository.

Returns:

(Types::DefinitionRepository)

# File 'lib/aws-sdk-omics/types.rb', line 1725

class CreateWorkflowVersionRequest < Struct.new(
  :workflow_id,
  :version_name,
  :definition_zip,
  :definition_uri,
  :accelerators,
  :description,
  :engine,
  :main,
  :parameter_template,
  :request_id,
  :storage_type,
  :storage_capacity,
  :tags,
  :workflow_bucket_owner_id,
  :container_registry_map,
  :container_registry_map_uri,
  :readme_markdown,
  :parameter_template_path,
  :readme_path,
  :definition_repository,
  :readme_uri)
  SENSITIVE = []
  include Aws::Structure
end

#definition_uri ⇒ `String`

The S3 URI of a definition for this workflow version. The S3 bucket must be in the same region as this workflow version.

Returns:

(String)

# File 'lib/aws-sdk-omics/types.rb', line 1725

class CreateWorkflowVersionRequest < Struct.new(
  :workflow_id,
  :version_name,
  :definition_zip,
  :definition_uri,
  :accelerators,
  :description,
  :engine,
  :main,
  :parameter_template,
  :request_id,
  :storage_type,
  :storage_capacity,
  :tags,
  :workflow_bucket_owner_id,
  :container_registry_map,
  :container_registry_map_uri,
  :readme_markdown,
  :parameter_template_path,
  :readme_path,
  :definition_repository,
  :readme_uri)
  SENSITIVE = []
  include Aws::Structure
end

#definition_zip ⇒ `String`

A ZIP archive containing the main workflow definition file and dependencies that it imports for this workflow version. You can use a file with a ://fileb prefix instead of the Base64 string. For more information, see Workflow definition requirements in the *Amazon Web Services HealthOmics User Guide*.

Returns:

(String)

# File 'lib/aws-sdk-omics/types.rb', line 1725

class CreateWorkflowVersionRequest < Struct.new(
  :workflow_id,
  :version_name,
  :definition_zip,
  :definition_uri,
  :accelerators,
  :description,
  :engine,
  :main,
  :parameter_template,
  :request_id,
  :storage_type,
  :storage_capacity,
  :tags,
  :workflow_bucket_owner_id,
  :container_registry_map,
  :container_registry_map_uri,
  :readme_markdown,
  :parameter_template_path,
  :readme_path,
  :definition_repository,
  :readme_uri)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

A description for this workflow version.

Returns:

(String)

# File 'lib/aws-sdk-omics/types.rb', line 1725

class CreateWorkflowVersionRequest < Struct.new(
  :workflow_id,
  :version_name,
  :definition_zip,
  :definition_uri,
  :accelerators,
  :description,
  :engine,
  :main,
  :parameter_template,
  :request_id,
  :storage_type,
  :storage_capacity,
  :tags,
  :workflow_bucket_owner_id,
  :container_registry_map,
  :container_registry_map_uri,
  :readme_markdown,
  :parameter_template_path,
  :readme_path,
  :definition_repository,
  :readme_uri)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ `String`

The workflow engine for this workflow version. This is only required if you have workflow definition files from more than one engine in your zip file. Otherwise, the service can detect the engine automatically from your workflow definition.

Returns:

(String)

# File 'lib/aws-sdk-omics/types.rb', line 1725

class CreateWorkflowVersionRequest < Struct.new(
  :workflow_id,
  :version_name,
  :definition_zip,
  :definition_uri,
  :accelerators,
  :description,
  :engine,
  :main,
  :parameter_template,
  :request_id,
  :storage_type,
  :storage_capacity,
  :tags,
  :workflow_bucket_owner_id,
  :container_registry_map,
  :container_registry_map_uri,
  :readme_markdown,
  :parameter_template_path,
  :readme_path,
  :definition_repository,
  :readme_uri)
  SENSITIVE = []
  include Aws::Structure
end

#main ⇒ `String`

The path of the main definition file for this workflow version. This parameter is not required if the ZIP archive contains only one workflow definition file, or if the main definition file is named “main”. An example path is: ‘workflow-definition/main-file.wdl`.

Returns:

(String)

# File 'lib/aws-sdk-omics/types.rb', line 1725

class CreateWorkflowVersionRequest < Struct.new(
  :workflow_id,
  :version_name,
  :definition_zip,
  :definition_uri,
  :accelerators,
  :description,
  :engine,
  :main,
  :parameter_template,
  :request_id,
  :storage_type,
  :storage_capacity,
  :tags,
  :workflow_bucket_owner_id,
  :container_registry_map,
  :container_registry_map_uri,
  :readme_markdown,
  :parameter_template_path,
  :readme_path,
  :definition_repository,
  :readme_uri)
  SENSITIVE = []
  include Aws::Structure
end

#parameter_template ⇒ `Hash<String,Types::WorkflowParameter>`

A parameter template for this workflow version. If this field is blank, Amazon Web Services HealthOmics will automatically parse the parameter template values from your workflow definition file. To override these service generated default values, provide a parameter template. To view an example of a parameter template, see [Parameter template files] in the *Amazon Web Services HealthOmics User Guide*.

[1]: docs.aws.amazon.com/omics/latest/dev/parameter-templates.html

Returns:

(Hash<String,Types::WorkflowParameter>)

# File 'lib/aws-sdk-omics/types.rb', line 1725

class CreateWorkflowVersionRequest < Struct.new(
  :workflow_id,
  :version_name,
  :definition_zip,
  :definition_uri,
  :accelerators,
  :description,
  :engine,
  :main,
  :parameter_template,
  :request_id,
  :storage_type,
  :storage_capacity,
  :tags,
  :workflow_bucket_owner_id,
  :container_registry_map,
  :container_registry_map_uri,
  :readme_markdown,
  :parameter_template_path,
  :readme_path,
  :definition_repository,
  :readme_uri)
  SENSITIVE = []
  include Aws::Structure
end

#parameter_template_path ⇒ `String`

The path to the workflow version parameter template JSON file within the repository. This file defines the input parameters for runs that use this workflow version. If not specified, the workflow version will be created without a parameter template.

Returns:

(String)

# File 'lib/aws-sdk-omics/types.rb', line 1725

class CreateWorkflowVersionRequest < Struct.new(
  :workflow_id,
  :version_name,
  :definition_zip,
  :definition_uri,
  :accelerators,
  :description,
  :engine,
  :main,
  :parameter_template,
  :request_id,
  :storage_type,
  :storage_capacity,
  :tags,
  :workflow_bucket_owner_id,
  :container_registry_map,
  :container_registry_map_uri,
  :readme_markdown,
  :parameter_template_path,
  :readme_path,
  :definition_repository,
  :readme_uri)
  SENSITIVE = []
  include Aws::Structure
end

#readme_markdown ⇒ `String`

The markdown content for the workflow version’s README file. This provides documentation and usage information for users of this specific workflow version.

Returns:

(String)

# File 'lib/aws-sdk-omics/types.rb', line 1725

class CreateWorkflowVersionRequest < Struct.new(
  :workflow_id,
  :version_name,
  :definition_zip,
  :definition_uri,
  :accelerators,
  :description,
  :engine,
  :main,
  :parameter_template,
  :request_id,
  :storage_type,
  :storage_capacity,
  :tags,
  :workflow_bucket_owner_id,
  :container_registry_map,
  :container_registry_map_uri,
  :readme_markdown,
  :parameter_template_path,
  :readme_path,
  :definition_repository,
  :readme_uri)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

(String)

# File 'lib/aws-sdk-omics/types.rb', line 1725

class CreateWorkflowVersionRequest < Struct.new(
  :workflow_id,
  :version_name,
  :definition_zip,
  :definition_uri,
  :accelerators,
  :description,
  :engine,
  :main,
  :parameter_template,
  :request_id,
  :storage_type,
  :storage_capacity,
  :tags,
  :workflow_bucket_owner_id,
  :container_registry_map,
  :container_registry_map_uri,
  :readme_markdown,
  :parameter_template_path,
  :readme_path,
  :definition_repository,
  :readme_uri)
  SENSITIVE = []
  include Aws::Structure
end

#readme_uri ⇒ `String`

The S3 URI of the README file for the workflow version. This file provides documentation and usage information for the workflow version. Requirements include:

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.

Returns:

(String)

# File 'lib/aws-sdk-omics/types.rb', line 1725

class CreateWorkflowVersionRequest < Struct.new(
  :workflow_id,
  :version_name,
  :definition_zip,
  :definition_uri,
  :accelerators,
  :description,
  :engine,
  :main,
  :parameter_template,
  :request_id,
  :storage_type,
  :storage_capacity,
  :tags,
  :workflow_bucket_owner_id,
  :container_registry_map,
  :container_registry_map_uri,
  :readme_markdown,
  :parameter_template_path,
  :readme_path,
  :definition_repository,
  :readme_uri)
  SENSITIVE = []
  include Aws::Structure
end

#request_id ⇒ `String`

An idempotency token to ensure that duplicate workflows are not created when Amazon Web Services HealthOmics submits retry requests.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

(String)

# File 'lib/aws-sdk-omics/types.rb', line 1725

class CreateWorkflowVersionRequest < Struct.new(
  :workflow_id,
  :version_name,
  :definition_zip,
  :definition_uri,
  :accelerators,
  :description,
  :engine,
  :main,
  :parameter_template,
  :request_id,
  :storage_type,
  :storage_capacity,
  :tags,
  :workflow_bucket_owner_id,
  :container_registry_map,
  :container_registry_map_uri,
  :readme_markdown,
  :parameter_template_path,
  :readme_path,
  :definition_repository,
  :readme_uri)
  SENSITIVE = []
  include Aws::Structure
end

#storage_capacity ⇒ `Integer`

The default static storage capacity (in gibibytes) for runs that use this workflow version. The ‘storageCapacity` can be overwritten at run time. The storage capacity is not required for runs with a `DYNAMIC` storage type.

Returns:

(Integer)

# File 'lib/aws-sdk-omics/types.rb', line 1725

class CreateWorkflowVersionRequest < Struct.new(
  :workflow_id,
  :version_name,
  :definition_zip,
  :definition_uri,
  :accelerators,
  :description,
  :engine,
  :main,
  :parameter_template,
  :request_id,
  :storage_type,
  :storage_capacity,
  :tags,
  :workflow_bucket_owner_id,
  :container_registry_map,
  :container_registry_map_uri,
  :readme_markdown,
  :parameter_template_path,
  :readme_path,
  :definition_repository,
  :readme_uri)
  SENSITIVE = []
  include Aws::Structure
end

#storage_type ⇒ `String`

The default storage type for runs that use this workflow version. The ‘storageType` can be overridden at run time. `DYNAMIC` storage dynamically scales the storage up or down, based on file system utilization. STATIC storage allocates a fixed amount of storage. For more information about dynamic and static storage types, see [Run storage types] in the *Amazon Web Services HealthOmics User Guide*.

[1]: docs.aws.amazon.com/omics/latest/dev/workflows-run-types.html

Returns:

(String)

# File 'lib/aws-sdk-omics/types.rb', line 1725

class CreateWorkflowVersionRequest < Struct.new(
  :workflow_id,
  :version_name,
  :definition_zip,
  :definition_uri,
  :accelerators,
  :description,
  :engine,
  :main,
  :parameter_template,
  :request_id,
  :storage_type,
  :storage_capacity,
  :tags,
  :workflow_bucket_owner_id,
  :container_registry_map,
  :container_registry_map_uri,
  :readme_markdown,
  :parameter_template_path,
  :readme_path,
  :definition_repository,
  :readme_uri)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Hash<String,String>`

Tags for this workflow version. You can define up to 50 tags for the workflow. For more information, see [Adding a tag] in the *Amazon Web Services HealthOmics User Guide*.

[1]: docs.aws.amazon.com/omics/latest/dev/add-a-tag.html

Returns:

(Hash<String,String>)

# File 'lib/aws-sdk-omics/types.rb', line 1725

class CreateWorkflowVersionRequest < Struct.new(
  :workflow_id,
  :version_name,
  :definition_zip,
  :definition_uri,
  :accelerators,
  :description,
  :engine,
  :main,
  :parameter_template,
  :request_id,
  :storage_type,
  :storage_capacity,
  :tags,
  :workflow_bucket_owner_id,
  :container_registry_map,
  :container_registry_map_uri,
  :readme_markdown,
  :parameter_template_path,
  :readme_path,
  :definition_repository,
  :readme_uri)
  SENSITIVE = []
  include Aws::Structure
end

#version_name ⇒ `String`

A name for the workflow version. Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version.

The version name must start with a letter or number and it can include upper-case and lower-case letters, numbers, hyphens, periods and underscores. The maximum length is 64 characters. You can use a simple naming scheme, such as version1, version2, version3. You can also match your workflow versions with your own internal versioning conventions, such as 2.7.0, 2.7.1, 2.7.2.

Returns:

(String)

# File 'lib/aws-sdk-omics/types.rb', line 1725

class CreateWorkflowVersionRequest < Struct.new(
  :workflow_id,
  :version_name,
  :definition_zip,
  :definition_uri,
  :accelerators,
  :description,
  :engine,
  :main,
  :parameter_template,
  :request_id,
  :storage_type,
  :storage_capacity,
  :tags,
  :workflow_bucket_owner_id,
  :container_registry_map,
  :container_registry_map_uri,
  :readme_markdown,
  :parameter_template_path,
  :readme_path,
  :definition_repository,
  :readme_uri)
  SENSITIVE = []
  include Aws::Structure
end

#workflow_bucket_owner_id ⇒ `String`

Amazon Web Services Id of the owner of the S3 bucket that contains the workflow definition. You need to specify this parameter if your account is not the bucket owner.

Returns:

(String)

# File 'lib/aws-sdk-omics/types.rb', line 1725

class CreateWorkflowVersionRequest < Struct.new(
  :workflow_id,
  :version_name,
  :definition_zip,
  :definition_uri,
  :accelerators,
  :description,
  :engine,
  :main,
  :parameter_template,
  :request_id,
  :storage_type,
  :storage_capacity,
  :tags,
  :workflow_bucket_owner_id,
  :container_registry_map,
  :container_registry_map_uri,
  :readme_markdown,
  :parameter_template_path,
  :readme_path,
  :definition_repository,
  :readme_uri)
  SENSITIVE = []
  include Aws::Structure
end

#workflow_id ⇒ `String`

The ID of the workflow where you are creating the new version. The ‘workflowId` is not the UUID.

Returns:

(String)

# File 'lib/aws-sdk-omics/types.rb', line 1725

class CreateWorkflowVersionRequest < Struct.new(
  :workflow_id,
  :version_name,
  :definition_zip,
  :definition_uri,
  :accelerators,
  :description,
  :engine,
  :main,
  :parameter_template,
  :request_id,
  :storage_type,
  :storage_capacity,
  :tags,
  :workflow_bucket_owner_id,
  :container_registry_map,
  :container_registry_map_uri,
  :readme_markdown,
  :parameter_template_path,
  :readme_path,
  :definition_repository,
  :readme_uri)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::Omics::Types::CreateWorkflowVersionRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#accelerators ⇒ String

#container_registry_map ⇒ Types::ContainerRegistryMap

#container_registry_map_uri ⇒ String

#definition_repository ⇒ Types::DefinitionRepository

#definition_uri ⇒ String

#definition_zip ⇒ String

#description ⇒ String

#engine ⇒ String

#main ⇒ String

#parameter_template ⇒ Hash<String,Types::WorkflowParameter>

#parameter_template_path ⇒ String

#readme_markdown ⇒ String

#readme_path ⇒ String

#readme_uri ⇒ String

#request_id ⇒ String

#storage_capacity ⇒ Integer

#storage_type ⇒ String

#tags ⇒ Hash<String,String>

#version_name ⇒ String

#workflow_bucket_owner_id ⇒ String

#workflow_id ⇒ String

#accelerators ⇒ `String`

#container_registry_map ⇒ `Types::ContainerRegistryMap`

#container_registry_map_uri ⇒ `String`

#definition_repository ⇒ `Types::DefinitionRepository`

#definition_uri ⇒ `String`

#definition_zip ⇒ `String`

#description ⇒ `String`

#engine ⇒ `String`

#main ⇒ `String`

#parameter_template ⇒ `Hash<String,Types::WorkflowParameter>`

#parameter_template_path ⇒ `String`

#readme_markdown ⇒ `String`

#readme_path ⇒ `String`

#readme_uri ⇒ `String`

#request_id ⇒ `String`

#storage_capacity ⇒ `Integer`

#storage_type ⇒ `String`

#tags ⇒ `Hash<String,String>`

#version_name ⇒ `String`

#workflow_bucket_owner_id ⇒ `String`

#workflow_id ⇒ `String`