---
title: "GET /runBatch/{batchId}"
method: GET
path: "/runBatch/{batchId}"
---

# GET /runBatch/{batchId}

`GET /runBatch/{batchId}`

Retrieves details and current status for a specific run batch, including submission progress and run execution counts.

## Path parameters

- `batchId` string, required

## Response `200`

Success

- GetBatchResponse
  - `id` string — The identifier portion of the run batch ARN.
  - `arn` string — The unique ARN of the run batch.
  - `uuid` string — The universally unique identifier (UUID) for the run batch.
  - `name` string — The optional user-friendly name of the batch.
  - `status` 'CREATING' | 'PENDING' | 'SUBMITTING' | 'INPROGRESS' | 'STOPPING' | 'CANCELLED' | 'FAILED' | 'PROCESSED' | 'RUNS_DELETING' | 'RUNS_DELETED' — The current status of the run batch. Possible values: <code>CREATING</code> (initial setup), <code>PENDING</code> (ready to submit runs), <code>SUBMITTING</code> (submitting runs), <code>INPROGRESS</code> (runs executing), <code>STOPPING</code> (cancellation in progress), <code>PROCESSED</code> (all runs completed), <code>CANCELLED</code> (batch cancelled), <code>FAILED</code> (batch failed), <code>RUNS_DELETING</code> (deleting runs), <code>RUNS_DELETED</code> (runs deleted).
  - `tags` object — AWS tags associated with the run batch.
  - `totalRuns` integer — The total number of runs in the batch.
  - `defaultRunSetting` object — The shared configuration applied to all runs in the batch. See <code>DefaultRunSetting</code>.
    - `workflowId` string, required — The identifier of the workflow to run.
    - `workflowType` 'PRIVATE' | 'READY2RUN' — The type of the originating workflow. Batch runs are not supported with <code>READY2RUN</code> workflows.
    - `roleArn` string, required — 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 <code>StartRun</code> 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` 'CACHE_ON_FAILURE' | 'CACHE_ALWAYS' — The cache behavior for the runs. Requires <code>cacheId</code> 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` object — 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 <code>s3://</code>. The <code>roleArn</code> must grant write permissions to this bucket. Can be overridden per run.
    - `logLevel` 'OFF' | 'FATAL' | 'ERROR' | 'ALL' — The verbosity level for CloudWatch Logs emitted during each run.
    - `runTags` object — AWS tags to associate with each workflow run. Merged with per-run <code>runTags</code>; run-specific values take precedence when keys overlap.
    - `retentionMode` 'RETAIN' | 'REMOVE' — The retention behavior for runs after completion.
    - `storageType` 'STATIC' | 'DYNAMIC' — 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.
    - `networkingMode` 'RESTRICTED' | 'VPC' — Optional configuration for run networking behavior. If not specified, this will default to RESTRICTED.
    - `configurationName` string — Optional configuration name to use for the workflow run.
    - `engineSettings` object — 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` 'LOCAL' | 'SHARED' — 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.
  - `submissionSummary` object — A summary of run submission outcomes. See <code>SubmissionSummary</code>.
    - `successfulStartSubmissionCount` integer — The number of successful start submissions.
    - `failedStartSubmissionCount` integer — The number of failed start submissions.
    - `pendingStartSubmissionCount` integer — The number of pending start submissions.
    - `successfulCancelSubmissionCount` integer — The number of successful cancel submissions.
    - `failedCancelSubmissionCount` integer — The number of failed cancel submissions.
    - `successfulDeleteSubmissionCount` integer — The number of successful delete submissions.
    - `failedDeleteSubmissionCount` integer — The number of failed delete submissions.
  - `runSummary` object — A summary of run execution states. Run execution counts are eventually consistent and may lag behind actual run states. Final counts are accurate once the batch reaches <code>PROCESSED</code> status. See <code>RunSummary</code>.
    - `pendingRunCount` integer — The number of pending runs.
    - `startingRunCount` integer — The number of starting runs.
    - `runningRunCount` integer — The number of running runs.
    - `stoppingRunCount` integer — The number of stopping runs.
    - `completedRunCount` integer — The number of completed runs.
    - `deletedRunCount` integer — The number of deleted runs.
    - `failedRunCount` integer — The number of failed runs.
    - `cancelledRunCount` integer — The number of cancelled runs.
  - `creationTime` string, date-time — The timestamp when the batch was created.
  - `submittedTime` string, date-time — The timestamp when all run submissions completed.
  - `processedTime` string, date-time — The timestamp when all run executions completed.
  - `failedTime` string, date-time — The timestamp when the batch transitioned to a <code>FAILED</code> status.
  - `failureReason` string — A description of the batch failure. Present only when status is <code>FAILED</code>.

## Other responses

- `480` — InternalServerException
- `481` — ThrottlingException
- `482` — ValidationException
- `483` — ResourceNotFoundException
- `484` — AccessDeniedException
- `485` — RequestTimeoutException

---

[API](https://skmtc.net/aws/apis/omics.md) · [All operations](https://skmtc.net/aws/apis/omics/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/omics/versions/e9df1bcc0813/schema)