runs_in_batches

Creates, updates, deletes, gets or lists a runs_in_batches resource.

Overview

Name	runs_in_batches
Type	Resource
Id	aws.omics.runs_in_batches

Fields

The following fields are returned by SELECT queries:

list_runs_in_batch

Name	Datatype	Description
run_arn	string	The unique ARN of the workflow run. (pattern: <code>arn:.+</code>)
run_id	string	The HealthOmics-generated identifier for the workflow run. Empty if submission failed. (pattern: <code>[0-9]+</code>)
run_internal_uuid	string	The universally unique identifier (UUID) for the run. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
run_setting_id	string	The customer-provided identifier for the run configuration. Use this to correlate results back to the input configuration provided in inlineSettings or s3UriSettings. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
submission_failure_message	string	A detailed message describing the submission failure. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
submission_failure_reason	string	The error category for a failed submission. See the run-level failure table in the HealthOmics User Guide for details on each value. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
submission_status	string	The submission outcome for this run. (SUCCESS, FAILED, CANCEL_SUCCESS, CANCEL_FAILED, DELETE_SUCCESS, DELETE_FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_runs_in_batch	select	batch_id, region	maxItems, startingToken, submissionStatus, runSettingId, runId	Returns a paginated list of individual workflow runs within a specific batch. Use this operation to map each runSettingId to its HealthOmics-generated runId, and to check the submission status of each run. Only one filter per call is supported.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
batch_id	string	The identifier portion of the run batch ARN.
region	string	AWS region (default: us-east-1)
maxItems	integer	The maximum number of runs to return.
runId	string	Filter runs by the HealthOmics-generated run ID.
runSettingId	string	Filter runs by the customer-provided run setting ID.
startingToken	string	A pagination token returned from a prior ListRunsInBatch call.
submissionStatus	string	Filter runs by submission status.

SELECT examples

list_runs_in_batch

Returns a paginated list of individual workflow runs within a specific batch. Use this operation to map each runSettingId to its HealthOmics-generated runId, and to check the submission status of each run. Only one filter per call is supported.

SELECT
run_arn,
run_id,
run_internal_uuid,
run_setting_id,
submission_failure_message,
submission_failure_reason,
submission_status
FROM aws.omics.runs_in_batches
WHERE batch_id = '{{ batch_id }}' -- required
AND region = '{{ region }}' -- required
AND maxItems = '{{ maxItems }}'
AND startingToken = '{{ startingToken }}'
AND submissionStatus = '{{ submissionStatus }}'
AND runSettingId = '{{ runSettingId }}'
AND runId = '{{ runId }}'
;