2026/06/22 - Amazon Omics - 4 updated api methods
Changes Adds support for scratch ephemeral storage mounted at tmp
{'defaultRunSetting': {'scratchStorageMode': 'LOCAL | SHARED'}}
Retrieves details and current status for a specific run batch, including submission progress and run execution counts.
See also: AWS API Documentation
Request Syntax
client.get_batch(
batchId='string'
)
string
[REQUIRED]
The identifier portion of the run batch ARN.
dict
Response Syntax
{
'id': 'string',
'arn': 'string',
'uuid': 'string',
'name': 'string',
'status': 'CREATING'|'PENDING'|'SUBMITTING'|'INPROGRESS'|'STOPPING'|'CANCELLED'|'FAILED'|'PROCESSED'|'RUNS_DELETING'|'RUNS_DELETED',
'tags': {
'string': 'string'
},
'totalRuns': 123,
'defaultRunSetting': {
'workflowId': 'string',
'workflowType': 'PRIVATE'|'READY2RUN',
'roleArn': 'string',
'name': 'string',
'cacheId': 'string',
'cacheBehavior': 'CACHE_ON_FAILURE'|'CACHE_ALWAYS',
'runGroupId': 'string',
'priority': 123,
'parameters': {...}|[...]|123|123.4|'string'|True|None,
'storageCapacity': 123,
'outputUri': 'string',
'logLevel': 'OFF'|'FATAL'|'ERROR'|'ALL',
'runTags': {
'string': 'string'
},
'retentionMode': 'RETAIN'|'REMOVE',
'storageType': 'STATIC'|'DYNAMIC',
'workflowOwnerId': 'string',
'outputBucketOwnerId': 'string',
'workflowVersionName': 'string',
'networkingMode': 'RESTRICTED'|'VPC',
'configurationName': 'string',
'engineSettings': {...}|[...]|123|123.4|'string'|True|None,
'scratchStorageMode': 'LOCAL'|'SHARED'
},
'submissionSummary': {
'successfulStartSubmissionCount': 123,
'failedStartSubmissionCount': 123,
'pendingStartSubmissionCount': 123,
'successfulCancelSubmissionCount': 123,
'failedCancelSubmissionCount': 123,
'successfulDeleteSubmissionCount': 123,
'failedDeleteSubmissionCount': 123
},
'runSummary': {
'pendingRunCount': 123,
'startingRunCount': 123,
'runningRunCount': 123,
'stoppingRunCount': 123,
'completedRunCount': 123,
'deletedRunCount': 123,
'failedRunCount': 123,
'cancelledRunCount': 123
},
'creationTime': datetime(2015, 1, 1),
'submittedTime': datetime(2015, 1, 1),
'processedTime': datetime(2015, 1, 1),
'failedTime': datetime(2015, 1, 1),
'failureReason': 'string'
}
Response Structure
(dict) --
id (string) --
The identifier portion of the run batch ARN.
arn (string) --
The unique ARN of the run batch.
uuid (string) --
The universally unique identifier (UUID) for the run batch.
name (string) --
The optional user-friendly name of the batch.
status (string) --
The current status of the run batch. Possible values: CREATING (initial setup), PENDING (ready to submit runs), SUBMITTING (submitting runs), INPROGRESS (runs executing), STOPPING (cancellation in progress), PROCESSED (all runs completed), CANCELLED (batch cancelled), FAILED (batch failed), RUNS_DELETING (deleting runs), RUNS_DELETED (runs deleted).
tags (dict) --
AWS tags associated with the run batch.
(string) --
(string) --
totalRuns (integer) --
The total number of runs in the batch.
defaultRunSetting (dict) --
The shared configuration applied to all runs in the batch. See DefaultRunSetting.
workflowId (string) --
The identifier of the workflow to run.
workflowType (string) --
The type of the originating workflow. Batch runs are not supported with READY2RUN workflows.
roleArn (string) --
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.
name (string) --
An optional user-friendly name applied to each workflow run. Can be overridden per run.
cacheId (string) --
The identifier of the run cache to associate with the runs.
cacheBehavior (string) --
The cache behavior for the runs. Requires cacheId to be set.
runGroupId (string) --
The ID of the run group to contain all workflow runs in the batch.
priority (integer) --
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.
parameters (:ref:`document<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.
storageCapacity (integer) --
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.
outputUri (string) --
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.
logLevel (string) --
The verbosity level for CloudWatch Logs emitted during each run.
runTags (dict) --
AWS tags to associate with each workflow run. Merged with per-run runTags; run-specific values take precedence when keys overlap.
(string) --
(string) --
retentionMode (string) --
The retention behavior for runs after completion.
storageType (string) --
The storage type for the workflow runs.
workflowOwnerId (string) --
The AWS account ID of the workflow owner, used for cross-account workflow sharing.
outputBucketOwnerId (string) --
The expected AWS account ID of the owner of the output S3 bucket. Can be overridden per run.
workflowVersionName (string) --
The version name of the specified workflow.
networkingMode (string) --
Optional configuration for run networking behavior. If not specified, this will default to RESTRICTED.
configurationName (string) --
Optional configuration name to use for the workflow run.
engineSettings (:ref:`document<document>`) --
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).
scratchStorageMode (string) --
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.
submissionSummary (dict) --
A summary of run submission outcomes. See SubmissionSummary.
successfulStartSubmissionCount (integer) --
The number of successful start submissions.
failedStartSubmissionCount (integer) --
The number of failed start submissions.
pendingStartSubmissionCount (integer) --
The number of pending start submissions.
successfulCancelSubmissionCount (integer) --
The number of successful cancel submissions.
failedCancelSubmissionCount (integer) --
The number of failed cancel submissions.
successfulDeleteSubmissionCount (integer) --
The number of successful delete submissions.
failedDeleteSubmissionCount (integer) --
The number of failed delete submissions.
runSummary (dict) --
A summary of run execution states. Run execution counts are eventually consistent and may lag behind actual run states. Final counts are accurate once the batch reaches PROCESSED status. See RunSummary.
pendingRunCount (integer) --
The number of pending runs.
startingRunCount (integer) --
The number of starting runs.
runningRunCount (integer) --
The number of running runs.
stoppingRunCount (integer) --
The number of stopping runs.
completedRunCount (integer) --
The number of completed runs.
deletedRunCount (integer) --
The number of deleted runs.
failedRunCount (integer) --
The number of failed runs.
cancelledRunCount (integer) --
The number of cancelled runs.
creationTime (datetime) --
The timestamp when the batch was created.
submittedTime (datetime) --
The timestamp when all run submissions completed.
processedTime (datetime) --
The timestamp when all run executions completed.
failedTime (datetime) --
The timestamp when the batch transitioned to a FAILED status.
failureReason (string) --
A description of the batch failure. Present only when status is FAILED.
{'scratchStorageMode': 'LOCAL | SHARED'}
Gets detailed information about a specific run using its ID.
Amazon Web Services HealthOmics stores a configurable number of runs, as determined by service limits, that are available to the console and API. If GetRun does not return the requested run, you can find all run logs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logs in the Amazon Web Services HealthOmics User Guide.
See also: AWS API Documentation
Request Syntax
client.get_run(
id='string',
export=[
'DEFINITION',
]
)
string
[REQUIRED]
The run's ID.
list
The run's export format.
(string) --
dict
Response Syntax
{
'arn': 'string',
'id': 'string',
'cacheId': 'string',
'cacheBehavior': 'CACHE_ON_FAILURE'|'CACHE_ALWAYS',
'engineVersion': 'string',
'status': 'PENDING'|'STARTING'|'RUNNING'|'STOPPING'|'COMPLETED'|'DELETED'|'CANCELLED'|'FAILED',
'workflowId': 'string',
'workflowType': 'PRIVATE'|'READY2RUN',
'runId': 'string',
'roleArn': 'string',
'name': 'string',
'runGroupId': 'string',
'batchId': 'string',
'priority': 123,
'definition': 'string',
'digest': 'string',
'parameters': {...}|[...]|123|123.4|'string'|True|None,
'storageCapacity': 123,
'outputUri': 'string',
'logLevel': 'OFF'|'FATAL'|'ERROR'|'ALL',
'resourceDigests': {
'string': 'string'
},
'startedBy': 'string',
'creationTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1),
'stopTime': datetime(2015, 1, 1),
'statusMessage': 'string',
'tags': {
'string': 'string'
},
'accelerators': 'GPU',
'retentionMode': 'RETAIN'|'REMOVE',
'failureReason': 'string',
'logLocation': {
'engineLogStream': 'string',
'runLogStream': 'string'
},
'uuid': 'string',
'runOutputUri': 'string',
'storageType': 'STATIC'|'DYNAMIC',
'workflowOwnerId': 'string',
'workflowVersionName': 'string',
'workflowUuid': 'string',
'networkingMode': 'RESTRICTED'|'VPC',
'scratchStorageMode': 'LOCAL'|'SHARED',
'configuration': {
'name': 'string',
'arn': 'string',
'uuid': 'string'
},
'vpcConfig': {
'securityGroupIds': [
'string',
],
'subnetIds': [
'string',
],
'vpcId': 'string'
},
'engineSettings': {...}|[...]|123|123.4|'string'|True|None
}
Response Structure
(dict) --
arn (string) --
The run's ARN.
id (string) --
The run's ID.
cacheId (string) --
The run cache associated with the run.
cacheBehavior (string) --
The run cache behavior for the run.
engineVersion (string) --
The actual Nextflow engine version that Amazon Web Services HealthOmics used for the run. The other workflow definition languages don't provide a value for this field.
status (string) --
The run's status.
workflowId (string) --
The run's workflow ID.
workflowType (string) --
The run's workflow type.
runId (string) --
The run's ID.
roleArn (string) --
The run's service role ARN.
name (string) --
The run's name.
runGroupId (string) --
The run's group ID.
batchId (string) --
The run's batch ID.
priority (integer) --
The run's priority.
definition (string) --
The run's definition.
digest (string) --
The run's digest.
parameters (:ref:`document<document>`) --
The run's parameters.
storageCapacity (integer) --
The run's storage capacity in gibibytes. For dynamic storage, after the run has completed, this value is the maximum amount of storage used during the run.
outputUri (string) --
The run's output URI.
logLevel (string) --
The run's log level.
resourceDigests (dict) --
The run's resource digests.
(string) --
(string) --
startedBy (string) --
Who started the run.
creationTime (datetime) --
When the run was created.
startTime (datetime) --
When the run started.
stopTime (datetime) --
The run's stop time.
statusMessage (string) --
The run's status message.
tags (dict) --
The run's tags.
(string) --
(string) --
accelerators (string) --
The computational accelerator used to run the workflow.
retentionMode (string) --
The run's retention mode.
failureReason (string) --
The reason a run has failed.
logLocation (dict) --
The location of the run log.
engineLogStream (string) --
The log stream ARN for the engine log.
runLogStream (string) --
The log stream ARN for the run log.
uuid (string) --
The universally unique identifier for a run.
runOutputUri (string) --
The destination for workflow outputs.
storageType (string) --
The run's storage type.
workflowOwnerId (string) --
The ID of the workflow owner.
workflowVersionName (string) --
The workflow version name.
workflowUuid (string) --
The universally unique identifier (UUID) value for the workflow.
networkingMode (string) --
Configuration for run networking behavior. If absent, this will default to RESTRICTED.
scratchStorageMode (string) --
Optional configuration for enabling scratch ephemeral storage mounted at /tmp. If absent, this will default to SHARED. This configuration is applicable only for CPU tasks. For tasks using GPUs, scratch storage is always LOCAL.
configuration (dict) --
Configuration details for the workflow run.
name (string) --
User-friendly name for the configuration.
arn (string) --
Unique resource identifier for the configuration.
uuid (string) --
Unique identifier for the configuration.
vpcConfig (dict) --
VPC configuration for the workflow run.
securityGroupIds (list) --
List of security group IDs.
(string) --
subnetIds (list) --
List of subnet IDs.
(string) --
vpcId (string) --
VPC ID computed from the provided subnet IDs.
engineSettings (:ref:`document<document>`) --
The engine-specific settings for the workflow run.
{'scratchStorageMode': 'LOCAL | SHARED'}
Starts a new run and returns details about the run, or duplicates an existing run. A run is a single invocation of a workflow. If you provide request IDs, Amazon Web Services HealthOmics identifies duplicate requests and starts the run only once. Monitor the progress of the run by calling the GetRun API operation.
To start a new run, the following inputs are required:
A service role ARN ( roleArn).
The run's workflow ID ( workflowId, not the uuid or runId).
An Amazon S3 location ( outputUri) where the run outputs will be saved.
All required workflow parameters ( parameter), which can include optional parameters from the parameter template. The run cannot include any parameters that are not defined in the parameter template. To see all possible parameters, use the GetRun API operation.
For runs with a STATIC (default) storage type, specify the required storage capacity (in gibibytes). A storage capacity value is not required for runs that use DYNAMIC storage.
StartRun can also duplicate an existing run using the run's default values. You can modify these default values and/or add other optional inputs. To duplicate a run, the following inputs are required:
A service role ARN ( roleArn).
The ID of the run to duplicate ( runId).
An Amazon S3 location where the run outputs will be saved ( outputUri).
To learn more about the optional parameters for StartRun, see Starting a run in the Amazon Web Services HealthOmics User Guide.
Use the retentionMode input to control how long the metadata for each run is stored in CloudWatch. There are two retention modes:
Specify REMOVE to automatically remove the oldest runs when you reach the maximum service retention limit for runs. It is recommended that you use the REMOVE mode to initiate major run requests so that your runs do not fail when you reach the limit.
The retentionMode is set to the RETAIN mode by default, which allows you to manually remove runs after reaching the maximum service retention limit. Under this setting, you cannot create additional runs until you remove the excess runs.
To learn more about the retention modes, see Run retention mode in the Amazon Web Services HealthOmics User Guide.
You can use Amazon Q CLI to analyze run logs and make performance optimization recommendations. To get started, see the Amazon Web Services HealthOmics MCP server on GitHub.
See also: AWS API Documentation
Request Syntax
client.start_run(
workflowId='string',
workflowType='PRIVATE'|'READY2RUN',
runId='string',
roleArn='string',
name='string',
cacheId='string',
cacheBehavior='CACHE_ON_FAILURE'|'CACHE_ALWAYS',
runGroupId='string',
priority=123,
parameters={...}|[...]|123|123.4|'string'|True|None,
storageCapacity=123,
outputUri='string',
logLevel='OFF'|'FATAL'|'ERROR'|'ALL',
tags={
'string': 'string'
},
requestId='string',
retentionMode='RETAIN'|'REMOVE',
storageType='STATIC'|'DYNAMIC',
workflowOwnerId='string',
workflowVersionName='string',
networkingMode='RESTRICTED'|'VPC',
scratchStorageMode='LOCAL'|'SHARED',
configurationName='string',
engineSettings={...}|[...]|123|123.4|'string'|True|None
)
string
The run's workflow ID. The workflowId is not the UUID.
string
The run's workflow type. The workflowType must be specified if you are running a READY2RUN workflow. If you are running a PRIVATE workflow (default), you do not need to include the workflow type.
string
The ID of a run to duplicate.
string
[REQUIRED]
A service role for the run. The roleArn requires access to Amazon Web Services HealthOmics, S3, Cloudwatch logs, and EC2. An example roleArn is arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ. In this example, the AWS account ID is 123456789012 and the role name is omics-service-role-serviceRole-W8O1XMPL7QZ.
string
A name for the run. This is recommended to view and organize runs in the Amazon Web Services HealthOmics console and CloudWatch logs.
string
Identifier of the cache associated with this run. If you don't specify a cache ID, no task outputs are cached for this run.
string
The cache behavior for the run. You specify this value if you want to override the default behavior for the cache. You had set the default value when you created the cache. For more information, see Run cache behavior in the Amazon Web Services HealthOmics User Guide.
string
The run's group ID. Use a run group to cap the compute resources (and number of concurrent runs) for the runs that you add to the run group.
integer
Use the run priority (highest: 1) to establish the order of runs in a run group when you start a run. If multiple runs share the same priority, the run that was initiated first will have the higher priority. Runs that do not belong to a run group can be assigned a priority. The priorities of these runs are ranked among other runs that are not in a run group. For more information, see Run priority in the Amazon Web Services HealthOmics User Guide.
:ref:`document<document>`
Parameters for the run. The run needs all required parameters and can include optional parameters. The run cannot include any parameters that are not defined in the parameter template. To retrieve parameters from the run, use the GetRun API operation.
integer
The STATIC storage capacity (in gibibytes, GiB) for this run. The default run storage capacity is 1200 GiB. If your requested storage capacity is unavailable, the system rounds up the value to the nearest 1200 GiB multiple. If the requested storage capacity is still unavailable, the system rounds up the value to the nearest 2400 GiB multiple. This field is not required if the storage type is DYNAMIC (the system ignores any value that you enter).
string
[REQUIRED]
An output S3 URI for the run. The S3 bucket must be in the same region as the workflow. The role ARN must have permission to write to this S3 bucket.
string
A log level for the run.
dict
Tags for the run. You can add up to 50 tags per run. For more information, see Adding a tag in the Amazon Web Services HealthOmics User Guide.
(string) --
(string) --
string
[REQUIRED]
An idempotency token used to dedupe retry requests so that duplicate runs are not created.
This field is autopopulated if not provided.
string
The retention mode for the run. The default value is RETAIN.
Amazon Web Services HealthOmics stores a fixed number of runs that are available to the console and API. In the default mode ( RETAIN), you need to remove runs manually when the number of run exceeds the maximum. If you set the retention mode to REMOVE, Amazon Web Services HealthOmics automatically removes runs (that have mode set to REMOVE) when the number of run exceeds the maximum. All run logs are available in CloudWatch logs, if you need information about a run that is no longer available to the API.
For more information about retention mode, see Specifying run retention mode in the Amazon Web Services HealthOmics User Guide.
string
The storage type for the run. If you set the storage type to DYNAMIC, Amazon Web Services HealthOmics dynamically scales the storage up or down, based on file system utilization. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. For more information about DYNAMIC and STATIC storage, see Run storage types in the Amazon Web Services HealthOmics User Guide.
string
The 12-digit account ID of the workflow owner that is used for running a shared workflow. 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.
string
The name of the workflow version. Use workflow versions to track and organize changes to the workflow. If your workflow has multiple versions, the run uses the default version unless you specify a version name. To learn more, see Workflow versioning in the Amazon Web Services HealthOmics User Guide.
string
Optional configuration for run networking behavior. If not specified, this will default to RESTRICTED.
string
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.
string
Optional configuration name to use for the workflow run.
:ref:`document<document>`
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).
dict
Response Syntax
{
'arn': 'string',
'id': 'string',
'status': 'PENDING'|'STARTING'|'RUNNING'|'STOPPING'|'COMPLETED'|'DELETED'|'CANCELLED'|'FAILED',
'tags': {
'string': 'string'
},
'uuid': 'string',
'runOutputUri': 'string',
'configuration': {
'name': 'string',
'arn': 'string',
'uuid': 'string'
},
'networkingMode': 'string'
}
Response Structure
(dict) --
arn (string) --
Unique resource identifier for the run.
id (string) --
The run's ID.
status (string) --
The run's status.
tags (dict) --
The run's tags.
(string) --
(string) --
uuid (string) --
The universally unique identifier for a run.
runOutputUri (string) --
The destination for workflow outputs.
configuration (dict) --
Configuration details for the workflow run.
name (string) --
User-friendly name for the configuration.
arn (string) --
Unique resource identifier for the configuration.
uuid (string) --
Unique identifier for the configuration.
networkingMode (string) --
Networking mode for the workflow run.
{'defaultRunSetting': {'scratchStorageMode': 'LOCAL | SHARED'}}
Starts a batch of workflow runs. You can group up to 100,000 runs into a single batch that share a common configuration defined in defaultRunSetting. Per-run overrides can be provided either inline via inlineSettings (up to 100 runs) or via a JSON file stored in Amazon S3 via s3UriSettings (up to 100,000 runs).
StartRunBatch validates common fields synchronously and returns immediately with a batch ID and status CREATING. The batch transitions to PENDING once initial setup completes. Runs are then submitted gradually and asynchronously at a rate governed by your StartRun throughput quota.
See also: AWS API Documentation
Request Syntax
client.start_run_batch(
batchName='string',
requestId='string',
tags={
'string': 'string'
},
defaultRunSetting={
'workflowId': 'string',
'workflowType': 'PRIVATE'|'READY2RUN',
'roleArn': 'string',
'name': 'string',
'cacheId': 'string',
'cacheBehavior': 'CACHE_ON_FAILURE'|'CACHE_ALWAYS',
'runGroupId': 'string',
'priority': 123,
'parameters': {...}|[...]|123|123.4|'string'|True|None,
'storageCapacity': 123,
'outputUri': 'string',
'logLevel': 'OFF'|'FATAL'|'ERROR'|'ALL',
'runTags': {
'string': 'string'
},
'retentionMode': 'RETAIN'|'REMOVE',
'storageType': 'STATIC'|'DYNAMIC',
'workflowOwnerId': 'string',
'outputBucketOwnerId': 'string',
'workflowVersionName': 'string',
'networkingMode': 'RESTRICTED'|'VPC',
'configurationName': 'string',
'engineSettings': {...}|[...]|123|123.4|'string'|True|None,
'scratchStorageMode': 'LOCAL'|'SHARED'
},
batchRunSettings={
'inlineSettings': [
{
'runSettingId': 'string',
'name': 'string',
'outputUri': 'string',
'priority': 123,
'parameters': {...}|[...]|123|123.4|'string'|True|None,
'outputBucketOwnerId': 'string',
'runTags': {
'string': 'string'
},
'engineSettings': {...}|[...]|123|123.4|'string'|True|None
},
],
's3UriSettings': 'string'
}
)
string
An optional user-friendly name for the run batch.
string
[REQUIRED]
A client token used to deduplicate retry requests and prevent duplicate batches from being created.
This field is autopopulated if not provided.
dict
AWS tags to associate with the batch resource. These tags are not inherited by individual runs. To tag individual runs, use defaultRunSetting.runTags.
(string) --
(string) --
dict
[REQUIRED]
Shared configuration applied to all runs in the batch. See DefaultRunSetting.
workflowId (string) -- [REQUIRED]
The identifier of the workflow to run.
workflowType (string) --
The type of the originating workflow. Batch runs are not supported with READY2RUN workflows.
roleArn (string) -- [REQUIRED]
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.
name (string) --
An optional user-friendly name applied to each workflow run. Can be overridden per run.
cacheId (string) --
The identifier of the run cache to associate with the runs.
cacheBehavior (string) --
The cache behavior for the runs. Requires cacheId to be set.
runGroupId (string) --
The ID of the run group to contain all workflow runs in the batch.
priority (integer) --
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.
parameters (:ref:`document<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.
storageCapacity (integer) --
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.
outputUri (string) --
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.
logLevel (string) --
The verbosity level for CloudWatch Logs emitted during each run.
runTags (dict) --
AWS tags to associate with each workflow run. Merged with per-run runTags; run-specific values take precedence when keys overlap.
(string) --
(string) --
retentionMode (string) --
The retention behavior for runs after completion.
storageType (string) --
The storage type for the workflow runs.
workflowOwnerId (string) --
The AWS account ID of the workflow owner, used for cross-account workflow sharing.
outputBucketOwnerId (string) --
The expected AWS account ID of the owner of the output S3 bucket. Can be overridden per run.
workflowVersionName (string) --
The version name of the specified workflow.
networkingMode (string) --
Optional configuration for run networking behavior. If not specified, this will default to RESTRICTED.
configurationName (string) --
Optional configuration name to use for the workflow run.
engineSettings (:ref:`document<document>`) --
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).
scratchStorageMode (string) --
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.
dict
[REQUIRED]
The individual run configurations. Specify exactly one of inlineSettings or s3UriSettings. See BatchRunSettings.
inlineSettings (list) --
A list of per-run configurations provided inline in the request. Each entry must include a unique runSettingId. Supports up to 100 entries. For batches with more than 100 runs, use s3UriSettings.
(dict) --
A per-run configuration that overrides or merges with fields from DefaultRunSetting for a specific run.
runSettingId (string) -- [REQUIRED]
A customer-provided unique identifier for this run configuration within the batch. After submission, use ListRunsInBatch to map each runSettingId to the HealthOmics-generated runId.
name (string) --
An optional user-friendly name for this run.
outputUri (string) --
Override the destination S3 URI for this run's outputs.
priority (integer) --
Override the priority for this run.
parameters (:ref:`document<document>`) --
Per-run workflow parameters. Merged with defaultRunSetting.parameters; values in this object take precedence when keys overlap.
outputBucketOwnerId (string) --
The expected AWS account ID of the owner of the output S3 bucket for this run.
runTags (dict) --
Per-run AWS tags. Merged with defaultRunSetting.runTags; values in this object take precedence when keys overlap.
(string) --
(string) --
engineSettings (:ref:`document<document>`) --
Per-run engine-specific settings. Use this field to specify configuration options that are specific to the workflow engine (for example, Nextflow profiles). Overrides defaultRunSetting.engineSettings for this run.
s3UriSettings (string) --
An Amazon S3 URI pointing to a JSON file containing per-run configurations. The file must be a JSON array in the same format as inlineSettings. Supports up to 100,000 run configurations. The maximum file size is 6 GB.
The IAM service role in roleArn must have read access to this S3 object. HealthOmics validates access to the file during the synchronous API call and records the file's ETag. If the file is modified after submission, the batch fails.
dict
Response Syntax
{
'id': 'string',
'arn': 'string',
'status': 'CREATING'|'PENDING'|'SUBMITTING'|'INPROGRESS'|'STOPPING'|'CANCELLED'|'FAILED'|'PROCESSED'|'RUNS_DELETING'|'RUNS_DELETED',
'uuid': 'string',
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
id (string) --
The identifier portion of the run batch ARN.
arn (string) --
The unique ARN of the run batch.
status (string) --
The initial status of the run batch. Returns CREATING while the batch is being initialized.
uuid (string) --
The universally unique identifier (UUID) for the run batch.
tags (dict) --
AWS tags associated with the run batch.
(string) --
(string) --