batches

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

Overview

Name	batches
Type	Resource
Id	aws.omics.batches

Fields

The following fields are returned by SELECT queries:

get_batch

Name	Datatype	Description
id	string	The identifier portion of the run batch ARN. (pattern: <code>[0-9]+</code>)
name	string	The optional user-friendly name of the batch. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
arn	string	The unique ARN of the run batch. (pattern: <code>arn:.+</code>)
creation_time	string (date-time)	The timestamp when the batch was created.
default_run_setting	object	The shared configuration applied to all runs in the batch. See DefaultRunSetting.
failed_time	string (date-time)	The timestamp when the batch transitioned to a FAILED status.
failure_reason	string	A description of the batch failure. Present only when status is FAILED.
processed_time	string (date-time)	The timestamp when all run executions completed.
run_summary	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 PROCESSED status. See RunSummary.
status	string	The current status of the run batch. Possible values: CREATING (initial setup), PENDING (ready to submit runs), SUBMITTING (submitting runs), INPROGRESS (runs executing), STOPPING (cancellation in progress), PROCESSED (all runs completed), CANCELLED (batch cancelled), FAILED (batch failed), RUNS_DELETING (deleting runs), RUNS_DELETED (runs deleted). (CREATING, PENDING, SUBMITTING, INPROGRESS, STOPPING, CANCELLED, FAILED, PROCESSED, RUNS_DELETING, RUNS_DELETED)
submission_summary	object	A summary of run submission outcomes. See SubmissionSummary.
submitted_time	string (date-time)	The timestamp when all run submissions completed.
tags	object	AWS tags associated with the run batch.
total_runs	integer	The total number of runs in the batch.
uuid	string	The universally unique identifier (UUID) for the run batch. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)

list_batch

Name	Datatype	Description
id	string	The batch identifier. (pattern: <code>[0-9]+</code>)
name	string	The batch name. (pattern: <code>[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+</code>)
created_at	string (date-time)	The timestamp when the batch was created.
status	string	The current batch status. (CREATING, PENDING, SUBMITTING, INPROGRESS, STOPPING, CANCELLED, FAILED, PROCESSED, RUNS_DELETING, RUNS_DELETED)
total_runs	integer	The total number of runs in the batch.
workflow_id	string	The identifier of the workflow used for the batch. (pattern: <code>[0-9]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_batch	select	batch_id, region		Retrieves details and current status for a specific run batch, including submission progress and run execution counts.
list_batch	select	region	maxItems, startingToken, status, name, runGroupId	Returns a list of run batches in your account, with optional filtering by status, name, or run group. Results are paginated. Only one filter per call is supported.
delete_batch	delete	batch_id, region		Deletes a run batch resource and its associated metadata. This operation does not delete the individual workflow runs. To delete the runs, call DeleteRunBatch before calling DeleteBatch. DeleteBatch requires the batch to be in a terminal state: PROCESSED, FAILED, CANCELLED, or RUNS_DELETED. After DeleteBatch completes, the batch metadata is no longer accessible. You cannot call GetBatch, ListRunsInBatch, DeleteRunBatch, or CancelRunBatch on a deleted batch.
delete_run_batch	delete	region		Deletes the individual workflow runs within a batch. This operation is separate from DeleteBatch, which removes the batch metadata. Delete is only allowed on batches in PROCESSED or CANCELLED state. Delete operations are non-atomic and may be partially successful. Use GetBatch to review successfulDeleteSubmissionCount and failedDeleteSubmissionCount in the submissionSummary. Only one cancel or delete operation per batch is allowed at a time.
batch_delete_read_set	exec	sequence_store_id, region, ids		Deletes one or more read sets. If the operation is successful, it returns a response with no body. If there is an error with deleting one of the read sets, the operation returns an error list. If the operation successfully deletes only a subset of files, it will return an error list for the remaining files that fail to be deleted. There is a limit of 100 read sets that can be deleted in each BatchDeleteReadSet API call.

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)
sequence_store_id	string	The read sets' sequence store ID.
maxItems	integer	The maximum number of batches to return. If not specified, defaults to 100.
name	string	Filter batches by name.
runGroupId	string	Filter batches by run group ID.
startingToken	string	A pagination token returned from a prior ListBatch call.
status	string	Filter batches by status.

SELECT examples

get_batch

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

SELECT
id,
name,
arn,
creation_time,
default_run_setting,
failed_time,
failure_reason,
processed_time,
run_summary,
status,
submission_summary,
submitted_time,
tags,
total_runs,
uuid
FROM aws.omics.batches
WHERE batch_id = '{{ batch_id }}' -- required
AND region = '{{ region }}' -- required
;

list_batch

Returns a list of run batches in your account, with optional filtering by status, name, or run group. Results are paginated. Only one filter per call is supported.

SELECT
id,
name,
created_at,
status,
total_runs,
workflow_id
FROM aws.omics.batches
WHERE region = '{{ region }}' -- required
AND maxItems = '{{ maxItems }}'
AND startingToken = '{{ startingToken }}'
AND status = '{{ status }}'
AND name = '{{ name }}'
AND runGroupId = '{{ runGroupId }}'
;

DELETE examples

delete_batch

Deletes a run batch resource and its associated metadata. This operation does not delete the individual workflow runs. To delete the runs, call DeleteRunBatch before calling DeleteBatch. DeleteBatch requires the batch to be in a terminal state: PROCESSED, FAILED, CANCELLED, or RUNS_DELETED. After DeleteBatch completes, the batch metadata is no longer accessible. You cannot call GetBatch, ListRunsInBatch, DeleteRunBatch, or CancelRunBatch on a deleted batch.

DELETE FROM aws.omics.batches
WHERE batch_id = '{{ batch_id }}' --required
AND region = '{{ region }}' --required
;

delete_run_batch

Deletes the individual workflow runs within a batch. This operation is separate from DeleteBatch, which removes the batch metadata. Delete is only allowed on batches in PROCESSED or CANCELLED state. Delete operations are non-atomic and may be partially successful. Use GetBatch to review successfulDeleteSubmissionCount and failedDeleteSubmissionCount in the submissionSummary. Only one cancel or delete operation per batch is allowed at a time.

DELETE FROM aws.omics.batches
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

batch_delete_read_set

Deletes one or more read sets. If the operation is successful, it returns a response with no body. If there is an error with deleting one of the read sets, the operation returns an error list. If the operation successfully deletes only a subset of files, it will return an error list for the remaining files that fail to be deleted. There is a limit of 100 read sets that can be deleted in each BatchDeleteReadSet API call.

EXEC aws.omics.batches.batch_delete_read_set 
@sequence_store_id='{{ sequence_store_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"ids": "{{ ids }}"
}'
;