/AWS1/CL_OMXDEFAULTRUNSETTING

Shared configuration applied to all runs in a batch. Fields specified in a per-run InlineSetting entry override the corresponding fields in this object for that run. The parameters and runTags fields are merged rather than replaced — run-specific values take precedence when keys overlap.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_workflowid TYPE /AWS1/OMXWORKFLOWID /AWS1/OMXWORKFLOWID

The identifier of the workflow to run.

iv_rolearn TYPE /AWS1/OMXRUNROLEARN /AWS1/OMXRUNROLEARN

The IAM role ARN that grants HealthOmics permissions to access required AWS resources such as Amazon S3 and CloudWatch. The role must have the same permissions required for individual StartRun calls.

Optional arguments:

iv_workflowtype TYPE /AWS1/OMXWORKFLOWTYPE /AWS1/OMXWORKFLOWTYPE

The type of the originating workflow. Batch runs are not supported with READY2RUN workflows.

iv_name TYPE /AWS1/OMXRUNNAME /AWS1/OMXRUNNAME

An optional user-friendly name applied to each workflow run. Can be overridden per run.

iv_cacheid TYPE /AWS1/OMXNUMERICIDINARN /AWS1/OMXNUMERICIDINARN

The identifier of the run cache to associate with the runs.

iv_cachebehavior TYPE /AWS1/OMXCACHEBEHAVIOR /AWS1/OMXCACHEBEHAVIOR

The cache behavior for the runs. Requires cacheId to be set.

iv_rungroupid TYPE /AWS1/OMXRUNGROUPID /AWS1/OMXRUNGROUPID

The ID of the run group to contain all workflow runs in the batch.

iv_priority TYPE /AWS1/OMXINTEGER /AWS1/OMXINTEGER

An integer priority for the workflow runs. Higher values correspond to higher priority. A value of 0 corresponds to the lowest priority. Can be overridden per run.

io_parameters TYPE REF TO /AWS1/CL_RT_DOCUMENT /AWS1/CL_RT_DOCUMENT

Workflow parameter names and values shared across all runs. Merged with per-run parameters; run-specific values take precedence when keys overlap. Can be overridden per run.

iv_storagecapacity TYPE /AWS1/OMXINTEGER /AWS1/OMXINTEGER

The filesystem size in gibibytes (GiB) provisioned for each workflow run and shared by all tasks in that run. Defaults to 1200 GiB if not specified.

iv_outputuri TYPE /AWS1/OMXRUNOUTPUTURI /AWS1/OMXRUNOUTPUTURI

The destination S3 URI for workflow outputs. Must begin with s3://. The roleArn must grant write permissions to this bucket. Can be overridden per run.

iv_loglevel TYPE /AWS1/OMXRUNLOGLEVEL /AWS1/OMXRUNLOGLEVEL

The verbosity level for CloudWatch Logs emitted during each run.

it_runtags TYPE /AWS1/CL_OMXTAGMAP_W=>TT_TAGMAP TT_TAGMAP

AWS tags to associate with each workflow run. Merged with per-run runTags; run-specific values take precedence when keys overlap.

iv_retentionmode TYPE /AWS1/OMXRUNRETENTIONMODE /AWS1/OMXRUNRETENTIONMODE

The retention behavior for runs after completion.

iv_storagetype TYPE /AWS1/OMXSTORAGETYPE /AWS1/OMXSTORAGETYPE

The storage type for the workflow runs.

iv_workflowownerid TYPE /AWS1/OMXWORKFLOWOWNERID /AWS1/OMXWORKFLOWOWNERID

The AWS account ID of the workflow owner, used for cross-account workflow sharing.

iv_outputbucketownerid TYPE /AWS1/OMXAWSACCOUNTID /AWS1/OMXAWSACCOUNTID

The expected AWS account ID of the owner of the output S3 bucket. Can be overridden per run.

iv_workflowversionname TYPE /AWS1/OMXWORKFLOWVERSIONNAME /AWS1/OMXWORKFLOWVERSIONNAME

The version name of the specified workflow.

---

Queryable Attributes

workflowId

The identifier of the workflow to run.

Accessible with the following methods

Method	Description
GET_WORKFLOWID()	Getter for WORKFLOWID, with configurable default
ASK_WORKFLOWID()	Getter for WORKFLOWID w/ exceptions if field has no value
HAS_WORKFLOWID()	Determine if WORKFLOWID has a value

workflowType

The type of the originating workflow. Batch runs are not supported with READY2RUN workflows.

Accessible with the following methods

Method	Description
GET_WORKFLOWTYPE()	Getter for WORKFLOWTYPE, with configurable default
ASK_WORKFLOWTYPE()	Getter for WORKFLOWTYPE w/ exceptions if field has no value
HAS_WORKFLOWTYPE()	Determine if WORKFLOWTYPE has a value

roleArn

The IAM role ARN that grants HealthOmics permissions to access required AWS resources such as Amazon S3 and CloudWatch. The role must have the same permissions required for individual StartRun calls.

Accessible with the following methods

Method	Description
GET_ROLEARN()	Getter for ROLEARN, with configurable default
ASK_ROLEARN()	Getter for ROLEARN w/ exceptions if field has no value
HAS_ROLEARN()	Determine if ROLEARN has a value

name

An optional user-friendly name applied to each workflow run. Can be overridden per run.

Accessible with the following methods

Method	Description
GET_NAME()	Getter for NAME, with configurable default
ASK_NAME()	Getter for NAME w/ exceptions if field has no value
HAS_NAME()	Determine if NAME has a value

cacheId

The identifier of the run cache to associate with the runs.

Accessible with the following methods

Method	Description
GET_CACHEID()	Getter for CACHEID, with configurable default
ASK_CACHEID()	Getter for CACHEID w/ exceptions if field has no value
HAS_CACHEID()	Determine if CACHEID has a value

cacheBehavior

The cache behavior for the runs. Requires cacheId to be set.

Accessible with the following methods

Method	Description
GET_CACHEBEHAVIOR()	Getter for CACHEBEHAVIOR, with configurable default
ASK_CACHEBEHAVIOR()	Getter for CACHEBEHAVIOR w/ exceptions if field has no value
HAS_CACHEBEHAVIOR()	Determine if CACHEBEHAVIOR has a value

runGroupId

The ID of the run group to contain all workflow runs in the batch.

Accessible with the following methods

Method	Description
GET_RUNGROUPID()	Getter for RUNGROUPID, with configurable default
ASK_RUNGROUPID()	Getter for RUNGROUPID w/ exceptions if field has no value
HAS_RUNGROUPID()	Determine if RUNGROUPID has a value

priority

An integer priority for the workflow runs. Higher values correspond to higher priority. A value of 0 corresponds to the lowest priority. Can be overridden per run.

Accessible with the following methods

Method	Description
GET_PRIORITY()	Getter for PRIORITY, with configurable default
ASK_PRIORITY()	Getter for PRIORITY w/ exceptions if field has no value
HAS_PRIORITY()	Determine if PRIORITY has a value

parameters

Workflow parameter names and values shared across all runs. Merged with per-run parameters; run-specific values take precedence when keys overlap. Can be overridden per run.

Accessible with the following methods

Method	Description
GET_PARAMETERS()	Getter for PARAMETERS, with configurable default
ASK_PARAMETERS()	Getter for PARAMETERS w/ exceptions if field has no value
HAS_PARAMETERS()	Determine if PARAMETERS has a value

storageCapacity

The filesystem size in gibibytes (GiB) provisioned for each workflow run and shared by all tasks in that run. Defaults to 1200 GiB if not specified.

Accessible with the following methods

Method	Description
GET_STORAGECAPACITY()	Getter for STORAGECAPACITY, with configurable default
ASK_STORAGECAPACITY()	Getter for STORAGECAPACITY w/ exceptions if field has no val
HAS_STORAGECAPACITY()	Determine if STORAGECAPACITY has a value

outputUri

The destination S3 URI for workflow outputs. Must begin with s3://. The roleArn must grant write permissions to this bucket. Can be overridden per run.

Accessible with the following methods

Method	Description
GET_OUTPUTURI()	Getter for OUTPUTURI, with configurable default
ASK_OUTPUTURI()	Getter for OUTPUTURI w/ exceptions if field has no value
HAS_OUTPUTURI()	Determine if OUTPUTURI has a value

logLevel

The verbosity level for CloudWatch Logs emitted during each run.

Accessible with the following methods

Method	Description
GET_LOGLEVEL()	Getter for LOGLEVEL, with configurable default
ASK_LOGLEVEL()	Getter for LOGLEVEL w/ exceptions if field has no value
HAS_LOGLEVEL()	Determine if LOGLEVEL has a value

runTags

AWS tags to associate with each workflow run. Merged with per-run runTags; run-specific values take precedence when keys overlap.

Accessible with the following methods

Method	Description
GET_RUNTAGS()	Getter for RUNTAGS, with configurable default
ASK_RUNTAGS()	Getter for RUNTAGS w/ exceptions if field has no value
HAS_RUNTAGS()	Determine if RUNTAGS has a value

retentionMode

The retention behavior for runs after completion.

Accessible with the following methods

Method	Description
GET_RETENTIONMODE()	Getter for RETENTIONMODE, with configurable default
ASK_RETENTIONMODE()	Getter for RETENTIONMODE w/ exceptions if field has no value
HAS_RETENTIONMODE()	Determine if RETENTIONMODE has a value

storageType

The storage type for the workflow runs.

Accessible with the following methods

Method	Description
GET_STORAGETYPE()	Getter for STORAGETYPE, with configurable default
ASK_STORAGETYPE()	Getter for STORAGETYPE w/ exceptions if field has no value
HAS_STORAGETYPE()	Determine if STORAGETYPE has a value

workflowOwnerId

The AWS account ID of the workflow owner, used for cross-account workflow sharing.

Accessible with the following methods

Method	Description
GET_WORKFLOWOWNERID()	Getter for WORKFLOWOWNERID, with configurable default
ASK_WORKFLOWOWNERID()	Getter for WORKFLOWOWNERID w/ exceptions if field has no val
HAS_WORKFLOWOWNERID()	Determine if WORKFLOWOWNERID has a value

outputBucketOwnerId

The expected AWS account ID of the owner of the output S3 bucket. Can be overridden per run.

Accessible with the following methods

Method	Description
GET_OUTPUTBUCKETOWNERID()	Getter for OUTPUTBUCKETOWNERID, with configurable default
ASK_OUTPUTBUCKETOWNERID()	Getter for OUTPUTBUCKETOWNERID w/ exceptions if field has no
HAS_OUTPUTBUCKETOWNERID()	Determine if OUTPUTBUCKETOWNERID has a value

workflowVersionName

The version name of the specified workflow.

Accessible with the following methods

Method	Description
GET_WORKFLOWVERSIONNAME()	Getter for WORKFLOWVERSIONNAME, with configurable default
ASK_WORKFLOWVERSIONNAME()	Getter for WORKFLOWVERSIONNAME w/ exceptions if field has no
HAS_WORKFLOWVERSIONNAME()	Determine if WORKFLOWVERSIONNAME has a value