<a id="cli-aws-omics-start-run-batch"></a>

# start-run-batch

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

> `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](https://docs.aws.amazon.com/goto/WebAPI/omics-2022-11-28/StartRunBatch)

`start-run-batch` uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type `document` must be provided as JSON. Shorthand syntax does not support document types.

## Synopsis

```
  start-run-batch
[--batch-name <value>]
[--request-id <value>]
[--tags <value>]
--default-run-setting <value>
--batch-run-settings <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]
```

## Options

`--batch-name` (string)

> An optional user-friendly name for the run batch.

> Constraints:

> * min: `1`
> * max: `64`
> * pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`

`--request-id` (string)

> A client token used to deduplicate retry requests and prevent duplicate batches from being created.

> Constraints:

> * min: `1`
> * max: `128`
> * pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`

`--tags` (map)

> Amazon Web Services tags to associate with the batch resource. These tags are not inherited by individual runs. To tag individual runs, use `defaultRunSetting.runTags` .

> key -> (string)

> > Constraints:

> > * min: `1`
> > * max: `128`

> value -> (string)

> > Constraints:

> > * min: `0`
> > * max: `256`

Shorthand Syntax:

```
KeyName1=string,KeyName2=string
```

JSON Syntax:

```json
{"string": "string"
  ...}
```

`--default-run-setting` (structure) [required]

> Shared configuration applied to all runs in the batch. See `DefaultRunSetting` .

> workflowId -> (string) [required]

> > The identifier of the workflow to run.

> > Constraints:

> > * min: `1`
> > * max: `18`
> > * pattern: `[0-9]+`

> workflowType -> (string)

> > The type of the originating workflow. Batch runs are not supported with `READY2RUN` workflows.

> > Possible values:

> > * `PRIVATE`
> > * `READY2RUN`

> > Constraints:

> > * min: `1`
> > * max: `64`

> roleArn -> (string) [required]

> > The IAM role ARN that grants HealthOmics permissions to access required Amazon Web Services resources such as Amazon S3 and CloudWatch. The role must have the same permissions required for individual `StartRun` calls.

> > Constraints:

> > * min: `1`
> > * max: `128`
> > * pattern: `arn:.+`

> name -> (string)

> > An optional user-friendly name applied to each workflow run. Can be overridden per run.

> > Constraints:

> > * min: `1`
> > * max: `128`
> > * pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`

> cacheId -> (string)

> > The identifier of the run cache to associate with the runs.

> > Constraints:

> > * min: `1`
> > * max: `18`
> > * pattern: `[0-9]+`

> cacheBehavior -> (string)

> > The cache behavior for the runs. Requires `cacheId` to be set.

> > Possible values:

> > * `CACHE_ON_FAILURE`
> > * `CACHE_ALWAYS`

> > Constraints:

> > * min: `1`
> > * max: `64`

> runGroupId -> (string)

> > The ID of the run group to contain all workflow runs in the batch.

> > Constraints:

> > * min: `1`
> > * max: `18`
> > * pattern: `[0-9]+`

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

> > Constraints:

> > * min: `0`
> > * max: `100000`

> parameters -> (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.

> > Constraints:

> > * min: `0`
> > * max: `100000`

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

> > Constraints:

> > * min: `1`
> > * max: `750`
> > * pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`

> logLevel -> (string)

> > The verbosity level for CloudWatch Logs emitted during each run.

> > Possible values:

> > * `OFF`
> > * `FATAL`
> > * `ERROR`
> > * `ALL`

> > Constraints:

> > * min: `1`
> > * max: `64`

> runTags -> (map)

> > Amazon Web Services tags to associate with each workflow run. Merged with per-run `runTags` ; run-specific values take precedence when keys overlap.

> > key -> (string)

> > > Constraints:

> > > * min: `1`
> > > * max: `128`

> > value -> (string)

> > > Constraints:

> > > * min: `0`
> > > * max: `256`

> retentionMode -> (string)

> > The retention behavior for runs after completion.

> > Possible values:

> > * `RETAIN`
> > * `REMOVE`

> > Constraints:

> > * min: `1`
> > * max: `64`

> storageType -> (string)

> > The storage type for the workflow runs.

> > Possible values:

> > * `STATIC`
> > * `DYNAMIC`

> > Constraints:

> > * min: `1`
> > * max: `64`

> workflowOwnerId -> (string)

> > The Amazon Web Services account ID of the workflow owner, used for cross-account workflow sharing.

> > Constraints:

> > * pattern: `[0-9]{12}`

> outputBucketOwnerId -> (string)

> > The expected Amazon Web Services account ID of the owner of the output S3 bucket. Can be overridden per run.

> > Constraints:

> > * min: `12`
> > * max: `12`
> > * pattern: `[0-9]+`

> workflowVersionName -> (string)

> > The version name of the specified workflow.

> > Constraints:

> > * min: `1`
> > * max: `64`
> > * pattern: `[A-Za-z0-9][A-Za-z0-9\-\._]*`

> networkingMode -> (string)

> > Optional configuration for run networking behavior. If not specified, this will default to RESTRICTED.

> > Possible values:

> > * `RESTRICTED`
> > * `VPC`

> configurationName -> (string)

> > Optional configuration name to use for the workflow run.

> > Constraints:

> > * min: `1`
> > * max: `128`
> > * pattern: `[A-Za-z0-9][A-Za-z0-9\-\._]*`

> sessionPolicy -> (string)

> > Optional inline policy json for scoping down permissions via a session policy on the IAM role provided in the roleArn parameter.

> > Constraints:

> > * min: `1`
> > * max: `2048`
> > * pattern: `[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}\t\n\r]+`

> engineSettings -> (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.

> > Possible values:

> > * `LOCAL`
> > * `SHARED`

> > Constraints:

> > * min: `1`
> > * max: `64`

Shorthand Syntax:

```
workflowId=string,workflowType=string,roleArn=string,name=string,cacheId=string,cacheBehavior=string,runGroupId=string,priority=integer,storageCapacity=integer,outputUri=string,logLevel=string,runTags={KeyName1=string,KeyName2=string},retentionMode=string,storageType=string,workflowOwnerId=string,outputBucketOwnerId=string,workflowVersionName=string,networkingMode=string,configurationName=string,sessionPolicy=string,scratchStorageMode=string
```

JSON Syntax:

```json
{
  "workflowId": "string",
  "workflowType": "PRIVATE"|"READY2RUN",
  "roleArn": "string",
  "name": "string",
  "cacheId": "string",
  "cacheBehavior": "CACHE_ON_FAILURE"|"CACHE_ALWAYS",
  "runGroupId": "string",
  "priority": integer,
  "parameters": {...},
  "storageCapacity": integer,
  "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",
  "sessionPolicy": "string",
  "engineSettings": {...},
  "scratchStorageMode": "LOCAL"|"SHARED"
}
```

`--batch-run-settings` (tagged union structure) [required]

> The individual run configurations. Specify exactly one of `inlineSettings` or `s3UriSettings` . See `BatchRunSettings` .

> #### NOTE
> This is a Tagged Union structure. Only one of the following top level keys can be set: `inlineSettings`, `s3UriSettings`.

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

> > Constraints:

> > * min: `1`
> > * max: `100`

> > (structure)

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

> > > > Constraints:

> > > > * min: `1`
> > > > * max: `128`
> > > > * pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`

> > > name -> (string)

> > > > An optional user-friendly name for this run.

> > > > Constraints:

> > > > * min: `1`
> > > > * max: `128`
> > > > * pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`

> > > outputUri -> (string)

> > > > Override the destination S3 URI for this run’s outputs.

> > > > Constraints:

> > > > * min: `1`
> > > > * max: `750`
> > > > * pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`

> > > priority -> (integer)

> > > > Override the priority for this run.

> > > > Constraints:

> > > > * min: `0`
> > > > * max: `100000`

> > > parameters -> (document)

> > > > Per-run workflow parameters. Merged with `defaultRunSetting.parameters` ; values in this object take precedence when keys overlap.

> > > outputBucketOwnerId -> (string)

> > > > The expected Amazon Web Services account ID of the owner of the output S3 bucket for this run.

> > > > Constraints:

> > > > * min: `12`
> > > > * max: `12`
> > > > * pattern: `[0-9]+`

> > > runTags -> (map)

> > > > Per-run Amazon Web Services tags. Merged with `defaultRunSetting.runTags` ; values in this object take precedence when keys overlap.

> > > > key -> (string)

> > > > > Constraints:

> > > > > * min: `1`
> > > > > * max: `128`

> > > > value -> (string)

> > > > > Constraints:

> > > > > * min: `0`
> > > > > * max: `256`

> > > engineSettings -> (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.

> > Constraints:

> > * min: `1`
> > * max: `750`
> > * pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`

JSON Syntax:

```json
{
  "inlineSettings": [
    {
      "runSettingId": "string",
      "name": "string",
      "outputUri": "string",
      "priority": integer,
      "parameters": {...},
      "outputBucketOwnerId": "string",
      "runTags": {"string": "string"
        ...},
      "engineSettings": {...}
    }
    ...
  ],
  "s3UriSettings": "string"
}
```

`--cli-input-json` | `--cli-input-yaml` (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with `--cli-input-yaml`.

`--generate-cli-skeleton` (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value `input`, prints a sample input JSON that can be used as an argument for `--cli-input-json`. Similarly, if provided `yaml-input` it will print a sample input YAML that can be used with `--cli-input-yaml`. If provided with the value `output`, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

## Global Options

`--debug` (boolean)

Turn on debug logging.

`--endpoint-url` (string)

Override command’s default URL with the given URL.

`--no-verify-ssl` (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

`--no-paginate` (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

`--output` (string)

The formatting style for command output.

* json
* text
* table
* yaml
* yaml-stream
* off

`--query` (string)

A JMESPath query to use in filtering the response data.

`--profile` (string)

Use a specific profile from your credential file.

`--region` (string)

The region to use. Overrides config/env settings.

`--version` (string)

Display the version of this tool.

`--color` (string)

Turn on/off color output.

* on
* off
* auto

`--no-sign-request` (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

`--ca-bundle` (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

`--cli-read-timeout` (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

`--cli-connect-timeout` (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

`--cli-binary-format` (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`.

* base64
* raw-in-base64-out

`--no-cli-pager` (boolean)

Disable cli pager for output.

`--cli-auto-prompt` (boolean)

Automatically prompt for CLI input parameters.

`--no-cli-auto-prompt` (boolean)

Disable automatically prompt for CLI input parameters.

`--cli-error-format` (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

* legacy
* json
* yaml
* text
* table
* enhanced

`--help` (boolean)

Display help for the command/subcommand.

## Output

id -> (string)

> The identifier portion of the run batch ARN.

> Constraints:

> * min: `1`
> * max: `18`
> * pattern: `[0-9]+`

arn -> (string)

> The unique ARN of the run batch.

> Constraints:

> * min: `1`
> * max: `128`
> * pattern: `arn:.+`

status -> (string)

> The initial status of the run batch. Returns `CREATING` while the batch is being initialized.

> Possible values:

> * `CREATING`
> * `PENDING`
> * `SUBMITTING`
> * `INPROGRESS`
> * `STOPPING`
> * `CANCELLED`
> * `FAILED`
> * `PROCESSED`
> * `RUNS_DELETING`
> * `RUNS_DELETE_FAILED`
> * `RUNS_DELETED`

> Constraints:

> * min: `1`
> * max: `64`

uuid -> (string)

> The universally unique identifier (UUID) for the run batch.

> Constraints:

> * min: `1`
> * max: `128`
> * pattern: `[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+`

tags -> (map)

> Amazon Web Services tags associated with the run batch.

> key -> (string)

> > Constraints:

> > * min: `1`
> > * max: `128`

> value -> (string)

> > Constraints:

> > * min: `0`
> > * max: `256`