Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14107682538.8 KB

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.

get/run/{id}

Path parameters

idstring required

The run's ID.

Query parameters

exportRunExport[]

The run's export format.

Response

Success

arnstring

The run's ARN.

idstring

The run's ID.

cacheIdstring

The run cache associated with the run.

cacheBehavior'CACHE_ON_FAILURE' | 'CACHE_ALWAYS'

The run cache behavior for the run.

engineVersionstring

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'PENDING' | 'STARTING' | 'RUNNING' | 'STOPPING' | 'COMPLETED' | 'DELETED' | 'CANCELLED' | 'FAILED'

The run's status.

workflowIdstring

The run's workflow ID.

workflowType'PRIVATE' | 'READY2RUN'

The run's workflow type.

runIdstring

The run's ID.

roleArnstring

The run's service role ARN.

namestring

The run's name.

runGroupIdstring

The run's group ID.

batchIdstring

The run's batch ID.

priorityinteger

The run's priority.

definitionstring

The run's definition.

digeststring

The run's digest.

parametersobject

The run's parameters.

storageCapacityinteger

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.

outputUristring

The run's output URI.

logLevel'OFF' | 'FATAL' | 'ERROR' | 'ALL'

The run's log level.

resourceDigestsobject

The run's resource digests.

startedBystring

Who started the run.

creationTimestring date-time

When the run was created.

startTimestring date-time

When the run started.

stopTimestring date-time

The run's stop time.

statusMessagestring

The run's status message.

tagsobject

The run's tags.

accelerators'GPU'

The computational accelerator used to run the workflow.

retentionMode'RETAIN' | 'REMOVE'

The run's retention mode.

failureReasonstring

The reason a run has failed.

uuidstring

The universally unique identifier for a run.

runOutputUristring

The destination for workflow outputs.

storageType'STATIC' | 'DYNAMIC'

The run's storage type.

workflowOwnerIdstring

The ID of the workflow owner.

workflowVersionNamestring

The workflow version name.

workflowUuidstring

The universally unique identifier (UUID) value for the workflow.

networkingMode'RESTRICTED' | 'VPC'

Configuration for run networking behavior. If absent, this will default to RESTRICTED.

scratchStorageMode'LOCAL' | 'SHARED'

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.

engineSettingsobject

The engine-specific settings for the workflow run.