Start Run Batch

omics_start_run_batch

R Documentation

Starts a batch of workflow runs

Description

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).

start_run_batch 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 start_run throughput quota.

Usage

omics_start_run_batch(batchName, requestId, tags, defaultRunSetting,
  batchRunSettings)

Arguments

batchName	An optional user-friendly name for the run batch.
requestId	[required] A client token used to deduplicate retry requests and prevent duplicate batches from being created.
tags	AWS tags to associate with the batch resource. These tags are not inherited by individual runs. To tag individual runs, use defaultRunSetting.runTags.
defaultRunSetting	[required] Shared configuration applied to all runs in the batch. See DefaultRunSetting.
batchRunSettings	[required] The individual run configurations. Specify exactly one of inlineSettings or s3UriSettings. See BatchRunSettings.

Value

A list with the following syntax:

list(
  id = "string",
  arn = "string",
  status = "CREATING"|"PENDING"|"SUBMITTING"|"INPROGRESS"|"STOPPING"|"CANCELLED"|"FAILED"|"PROCESSED"|"RUNS_DELETING"|"RUNS_DELETED",
  uuid = "string",
  tags = list(
    "string"
  )
)

Request syntax

svc$start_run_batch(
  batchName = "string",
  requestId = "string",
  tags = list(
    "string"
  ),
  defaultRunSetting = list(
    workflowId = "string",
    workflowType = "PRIVATE"|"READY2RUN",
    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",
    runTags = list(
      "string"
    ),
    retentionMode = "RETAIN"|"REMOVE",
    storageType = "STATIC"|"DYNAMIC",
    workflowOwnerId = "string",
    outputBucketOwnerId = "string",
    workflowVersionName = "string",
    networkingMode = "RESTRICTED"|"VPC",
    configurationName = "string"
  ),
  batchRunSettings = list(
    inlineSettings = list(
      list(
        runSettingId = "string",
        name = "string",
        outputUri = "string",
        priority = 123,
        parameters = list(),
        outputBucketOwnerId = "string",
        runTags = list(
          "string"
        )
      )
    ),
    s3UriSettings = "string"
  )
)