DefaultRunSetting

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.

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: arn:.+

Required: Yes

workflowId

The identifier of the workflow to run.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 18.

Pattern: [0-9]+

Required: Yes

cacheBehavior

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Valid Values: CACHE_ON_FAILURE | CACHE_ALWAYS

Required: No

cacheId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 18.

Pattern: [0-9]+

Required: No

configurationName

Optional configuration name to use for the workflow run.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [A-Za-z0-9][A-Za-z0-9\-\._]*

Required: No

engineSettings

Engine-specific settings for the workflow run. Use this field to specify configuration options that are specific to the workflow engine (for example, Nextflow profiles).

Type: JSON value

Required: No

logLevel

The verbosity level for CloudWatch Logs emitted during each run.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Valid Values: OFF | FATAL | ERROR | ALL

Required: No

name

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+

Required: No

networkingMode

Optional configuration for run networking behavior. If not specified, this will default to RESTRICTED.

Type: String

Valid Values: RESTRICTED | VPC

Required: No

outputBucketOwnerId

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

Type: String

Length Constraints: Fixed length of 12.

Pattern: [0-9]+

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 750.

Pattern: [\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+

Required: No

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.

Type: JSON value

Required: No

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.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 100000.

Required: No

retentionMode

The retention behavior for runs after completion.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Valid Values: RETAIN | REMOVE

Required: No

runGroupId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 18.

Pattern: [0-9]+

Required: No

runTags

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

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

scratchStorageMode

Optional configuration for enabling scratch ephemeral storage mounted at /tmp. If not specified, this will default to SHARED. This configuration is applicable only for CPU tasks. For tasks using GPUs, scratch storage is always LOCAL.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Valid Values: LOCAL | SHARED

Required: No

sessionPolicy

Optional inline IAM policy document to scope down the permissions granted to the run. The policy restricts the permissions of the IAM role specified in roleArn. The effective permissions are the intersection of the role's permissions and the session policy. The session policy must be a valid JSON document with a maximum length of 2,048 characters.

The session policy must include permissions for CloudWatch Logs (logs:CreateLogStream and logs:PutLogEvents) because the service uses the run's credentials to create and write to log groups.

For more information about session policies, see Session policies in the IAM User Guide.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}\t\n\r]+

Required: No

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.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 100000.

Required: No

storageType

The storage type for the workflow runs.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Valid Values: STATIC | DYNAMIC

Required: No

workflowOwnerId

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

Type: String

Pattern: [0-9]{12}

Required: No

workflowType

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Valid Values: PRIVATE | READY2RUN

Required: No

workflowVersionName

The version name of the specified workflow.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9][A-Za-z0-9\-\._]*

Required: No

DefaultRunSetting

Contents

See Also