Start Run

omics_start_run

R Documentation

Starts a new run or duplicates an existing run¶

Description¶

Starts a new run or duplicates an existing run.

For a new run, specify a unique requestId, the workflowId, and a role ARN. If you're using static run storage (the default), specify the required storageCapacity.

You duplicate a run by specifing a unique requestId, the runID of the run to duplicate, and a role ARN.

For more information about the optional parameters in the StartRun request, see Starting a run in the Amazon Web Services HealthOmics User Guide.

Usage¶

omics_start_run(workflowId, workflowType, runId, roleArn, name, cacheId,
  cacheBehavior, runGroupId, priority, parameters, storageCapacity,
  outputUri, logLevel, tags, requestId, retentionMode, storageType,
  workflowOwnerId, workflowVersionName)

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.

cacheId

Identifier of the cache associated with this run. If you don't specify a cache ID, no task outputs are cached for this run.

cacheBehavior

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.

runGroupId

The run's group ID.

priority

A priority for the run.

parameters

Parameters for the run.

storageCapacity

The static storage capacity (in gibibytes) for this run. 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. 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.

storageType

The storage type for the run. By default, the run uses STATIC storage type, which allocates a fixed amount of storage. If you set the storage type to DYNAMIC, Amazon Web Services HealthOmics dynamically scales the storage up or down, based on file system utilization. For more information about static and dynamic storage, see Running workflows in the Amazon Web Services HealthOmics User Guide.

workflowOwnerId

The ID of the workflow owner.

workflowVersionName

The name of the workflow version.

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",
  cacheId = "string",
  cacheBehavior = "CACHE_ON_FAILURE"|"CACHE_ALWAYS",
  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",
  workflowVersionName = "string"
)