Start Run
omics_start_run | R Documentation |
Starts a workflow run¶
Description¶
Starts a workflow run. To duplicate a run, specify the run's ID and a role ARN. The remaining parameters are copied from the previous run.
StartRun will not support re-run for a workflow that is shared with you.
The total number of runs in your account is subject to a quota per
Region. To avoid needing to delete runs manually, you can set the
retention mode to REMOVE
. Runs with this setting are deleted
automatically when the run quoata is exceeded.
By default, the run uses STATIC storage. For STATIC storage, set the
storageCapacity
field. You can set the storage type to DYNAMIC. You do
not set storageCapacity
, because HealthOmics dynamically scales the
storage up or down as required. For more information about static and
dynamic storage, see Running
workflows in the AWS
HealthOmics User Guide.
Usage¶
omics_start_run(workflowId, workflowType, runId, roleArn, name,
runGroupId, priority, parameters, storageCapacity, outputUri, logLevel,
tags, requestId, retentionMode, storageType, workflowOwnerId)
Arguments¶
workflowId
The run's workflow ID.
workflowType
The run's workflow type.
runId
The ID of a run to duplicate.
roleArn
[required] A service role for the run.
name
A name for the run.
runGroupId
The run's group ID.
priority
A priority for the run.
parameters
Parameters for the run.
storageCapacity
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).
outputUri
An output URI for the run.
logLevel
A log level for the run.
tags
Tags for the run.
requestId
[required] To ensure that requests don't run multiple times, specify a unique ID for each request.
retentionMode
The retention mode for the run.
storageType
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.
workflowOwnerId
The ID of the workflow owner.
Value¶
A list with the following syntax:
list(
arn = "string",
id = "string",
status = "PENDING"|"STARTING"|"RUNNING"|"STOPPING"|"COMPLETED"|"DELETED"|"CANCELLED"|"FAILED",
tags = list(
"string"
),
uuid = "string",
runOutputUri = "string"
)
Request syntax¶
svc$start_run(
workflowId = "string",
workflowType = "PRIVATE"|"READY2RUN",
runId = "string",
roleArn = "string",
name = "string",
runGroupId = "string",
priority = 123,
parameters = list(),
storageCapacity = 123,
outputUri = "string",
logLevel = "OFF"|"FATAL"|"ERROR"|"ALL",
tags = list(
"string"
),
requestId = "string",
retentionMode = "RETAIN"|"REMOVE",
storageType = "STATIC"|"DYNAMIC",
workflowOwnerId = "string"
)