AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . omics ]

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 PENDING . Runs are submitted gradually and asynchronously at a rate governed by your StartRun throughput quota.

See also: AWS API Documentation

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 <value>]
[--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>]
[--v2-debug]

Options

--batch-name (string)

An optional user-friendly name for the run batch.

--request-id (string)

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

--tags (map)

AWS tags to associate with the batch resource. These tags are not inherited by individual runs. To tag individual runs, use defaultRunSetting.runTags .

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--default-run-setting (structure)

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

workflowId -> (string)

The identifier of the workflow to run.

workflowType -> (string)

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

roleArn -> (string)

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

name -> (string)

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

cacheId -> (string)

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

cacheBehavior -> (string)

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

runGroupId -> (string)

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

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.

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.

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.

logLevel -> (string)

The verbosity level for CloudWatch Logs emitted during each run.

runTags -> (map)

AWS tags to associate with each workflow run. Merged with per-run runTags ; run-specific values take precedence when keys overlap.

key -> (string)

value -> (string)

retentionMode -> (string)

The retention behavior for runs after completion.

storageType -> (string)

The storage type for the workflow runs.

workflowOwnerId -> (string)

The AWS account ID of the workflow owner, used for cross-account workflow sharing.

outputBucketOwnerId -> (string)

The expected AWS account ID of the owner of the output S3 bucket. Can be overridden per run.

workflowVersionName -> (string)

The version name of the specified workflow.

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

JSON Syntax:

{
  "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"
}

--batch-run-settings (tagged union structure)

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 .

(structure)

A per-run configuration that overrides or merges with fields from DefaultRunSetting for a specific run.

runSettingId -> (string)

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 .

name -> (string)

An optional user-friendly name for this run.

outputUri -> (string)

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

priority -> (integer)

Override the priority for this run.

parameters -> (document)

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

outputBucketOwnerId -> (string)

The expected AWS account ID of the owner of the output S3 bucket for this run.

runTags -> (map)

Per-run AWS tags. Merged with defaultRunSetting.runTags ; values in this object take precedence when keys overlap.

key -> (string)

value -> (string)

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.

JSON Syntax:

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

id -> (string)

The identifier portion of the run batch ARN.

arn -> (string)

The unique ARN of the run batch.

status -> (string)

The initial status of the run batch.

uuid -> (string)

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

tags -> (map)

AWS tags associated with the run batch.

key -> (string)

value -> (string)