Class: Aws::Omics::Types::StartRunRequest

Inherits:

Struct

• Object
• Struct
• Aws::Omics::Types::StartRunRequest

Defined in:

gems/aws-sdk-omics/lib/aws-sdk-omics/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #log_level ⇒ String

  A log level for the run.

• #name ⇒ String

  A name for the run.

• #output_uri ⇒ String

  An output URI for the run.

• #parameters ⇒ Hash, ...

  Parameters for the run.

• #priority ⇒ Integer

  A priority for the run.

• #request_id ⇒ String

  To ensure that requests don't run multiple times, specify a unique ID for each request.

• #retention_mode ⇒ String

  The retention mode for the run.

• #role_arn ⇒ String

  A service role for the run.

• #run_group_id ⇒ String

  The run's group ID.

• #run_id ⇒ String

  The ID of a run to duplicate.

• #storage_capacity ⇒ Integer

  A storage capacity for the run in gibibytes.

• #storage_type ⇒ String

  The run's storage type.

• #tags ⇒ Hash<String,String>

  Tags for the run.

• #workflow_id ⇒ String

  The run's workflow ID.

• #workflow_owner_id ⇒ String

  The ID of the workflow owner.

• #workflow_type ⇒ String

  The run's workflow type.

Instance Attribute Details

#log_level ⇒ String

A log level for the run.

Returns:

• (String)

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

class StartRunRequest < Struct.new(
  :workflow_id,
  :workflow_type,
  :run_id,
  :role_arn,
  :name,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :tags,
  :request_id,
  :retention_mode,
  :storage_type,
  :workflow_owner_id)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

A name for the run.

Returns:

• (String)

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

class StartRunRequest < Struct.new(
  :workflow_id,
  :workflow_type,
  :run_id,
  :role_arn,
  :name,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :tags,
  :request_id,
  :retention_mode,
  :storage_type,
  :workflow_owner_id)
  SENSITIVE = []
  include Aws::Structure
end

#output_uri ⇒ String

An output URI for the run.

Returns:

• (String)

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

class StartRunRequest < Struct.new(
  :workflow_id,
  :workflow_type,
  :run_id,
  :role_arn,
  :name,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :tags,
  :request_id,
  :retention_mode,
  :storage_type,
  :workflow_owner_id)
  SENSITIVE = []
  include Aws::Structure
end

#parameters ⇒ Hash, ...

Parameters for the run.

Returns:

• (Hash, Array, String, Numeric, Boolean)

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

class StartRunRequest < Struct.new(
  :workflow_id,
  :workflow_type,
  :run_id,
  :role_arn,
  :name,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :tags,
  :request_id,
  :retention_mode,
  :storage_type,
  :workflow_owner_id)
  SENSITIVE = []
  include Aws::Structure
end

#priority ⇒ Integer

A priority for the run.

Returns:

• (Integer)

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

class StartRunRequest < Struct.new(
  :workflow_id,
  :workflow_type,
  :run_id,
  :role_arn,
  :name,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :tags,
  :request_id,
  :retention_mode,
  :storage_type,
  :workflow_owner_id)
  SENSITIVE = []
  include Aws::Structure
end

#request_id ⇒ String

To ensure that requests don't run multiple times, specify a unique ID for each request.

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

Returns:

• (String)

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

class StartRunRequest < Struct.new(
  :workflow_id,
  :workflow_type,
  :run_id,
  :role_arn,
  :name,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :tags,
  :request_id,
  :retention_mode,
  :storage_type,
  :workflow_owner_id)
  SENSITIVE = []
  include Aws::Structure
end

#retention_mode ⇒ String

The retention mode for the run.

Returns:

• (String)

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

class StartRunRequest < Struct.new(
  :workflow_id,
  :workflow_type,
  :run_id,
  :role_arn,
  :name,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :tags,
  :request_id,
  :retention_mode,
  :storage_type,
  :workflow_owner_id)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

A service role for the run.

Returns:

• (String)

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

class StartRunRequest < Struct.new(
  :workflow_id,
  :workflow_type,
  :run_id,
  :role_arn,
  :name,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :tags,
  :request_id,
  :retention_mode,
  :storage_type,
  :workflow_owner_id)
  SENSITIVE = []
  include Aws::Structure
end

#run_group_id ⇒ String

The run's group ID.

Returns:

• (String)

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

class StartRunRequest < Struct.new(
  :workflow_id,
  :workflow_type,
  :run_id,
  :role_arn,
  :name,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :tags,
  :request_id,
  :retention_mode,
  :storage_type,
  :workflow_owner_id)
  SENSITIVE = []
  include Aws::Structure
end

#run_id ⇒ String

The ID of a run to duplicate.

Returns:

• (String)

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

class StartRunRequest < Struct.new(
  :workflow_id,
  :workflow_type,
  :run_id,
  :role_arn,
  :name,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :tags,
  :request_id,
  :retention_mode,
  :storage_type,
  :workflow_owner_id)
  SENSITIVE = []
  include Aws::Structure
end

#storage_capacity ⇒ Integer

A storage capacity for the run in gibibytes. This field is not required if the storage type is dynamic (the system ignores any value that you enter).

Returns:

• (Integer)

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

class StartRunRequest < Struct.new(
  :workflow_id,
  :workflow_type,
  :run_id,
  :role_arn,
  :name,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :tags,
  :request_id,
  :retention_mode,
  :storage_type,
  :workflow_owner_id)
  SENSITIVE = []
  include Aws::Structure
end

#storage_type ⇒ String

The run's storage type. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. If you set the storage type to DYNAMIC, HealthOmics dynamically scales the storage up or down, based on file system utilization.

Returns:

• (String)

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

class StartRunRequest < Struct.new(
  :workflow_id,
  :workflow_type,
  :run_id,
  :role_arn,
  :name,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :tags,
  :request_id,
  :retention_mode,
  :storage_type,
  :workflow_owner_id)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Tags for the run.

Returns:

• (Hash<String,String>)

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

class StartRunRequest < Struct.new(
  :workflow_id,
  :workflow_type,
  :run_id,
  :role_arn,
  :name,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :tags,
  :request_id,
  :retention_mode,
  :storage_type,
  :workflow_owner_id)
  SENSITIVE = []
  include Aws::Structure
end

#workflow_id ⇒ String

The run's workflow ID.

Returns:

• (String)

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

class StartRunRequest < Struct.new(
  :workflow_id,
  :workflow_type,
  :run_id,
  :role_arn,
  :name,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :tags,
  :request_id,
  :retention_mode,
  :storage_type,
  :workflow_owner_id)
  SENSITIVE = []
  include Aws::Structure
end

#workflow_owner_id ⇒ String

The ID of the workflow owner.

Returns:

• (String)

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

class StartRunRequest < Struct.new(
  :workflow_id,
  :workflow_type,
  :run_id,
  :role_arn,
  :name,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :tags,
  :request_id,
  :retention_mode,
  :storage_type,
  :workflow_owner_id)
  SENSITIVE = []
  include Aws::Structure
end

#workflow_type ⇒ String

The run's workflow type.

Returns:

• (String)

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

class StartRunRequest < Struct.new(
  :workflow_id,
  :workflow_type,
  :run_id,
  :role_arn,
  :name,
  :run_group_id,
  :priority,
  :parameters,
  :storage_capacity,
  :output_uri,
  :log_level,
  :tags,
  :request_id,
  :retention_mode,
  :storage_type,
  :workflow_owner_id)
  SENSITIVE = []
  include Aws::Structure
end