Omics / Client / list_runs_in_batch

list_runs_in_batch¶

Omics.Client.list_runs_in_batch(**kwargs)¶

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.

Request Syntax

response = client.list_runs_in_batch(
    batchId='string',
    maxItems=123,
    startingToken='string',
    submissionStatus='SUCCESS'|'FAILED'|'CANCEL_SUCCESS'|'CANCEL_FAILED'|'DELETE_SUCCESS'|'DELETE_FAILED',
    runSettingId='string',
    runId='string'
)

Parameters:

batchId (string) –
[REQUIRED]

The identifier portion of the run batch ARN.
maxItems (integer) – The maximum number of runs to return.
startingToken (string) – A pagination token returned from a prior ListRunsInBatch call.
submissionStatus (string) – Filter runs by submission status.
runSettingId (string) – Filter runs by the customer-provided run setting ID.
runId (string) – Filter runs by the HealthOmics-generated run ID.

Return type:

dict

Returns:

Response Syntax

{
    'runs': [
        {
            'runSettingId': 'string',
            'runId': 'string',
            'runInternalUuid': 'string',
            'runArn': 'string',
            'submissionStatus': 'SUCCESS'|'FAILED'|'CANCEL_SUCCESS'|'CANCEL_FAILED'|'DELETE_SUCCESS'|'DELETE_FAILED',
            'submissionFailureReason': 'string',
            'submissionFailureMessage': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- runs (list) –
  
  A list of run entries in the batch. See RunBatchListItem.
  - (dict) –
    
    A single run entry returned by ListRunsInBatch.
    - runSettingId (string) –
      
      The customer-provided identifier for the run configuration. Use this to correlate results back to the input configuration provided in inlineSettings or s3UriSettings.
    - runId (string) –
      
      The HealthOmics-generated identifier for the workflow run. Empty if submission failed.
    - runInternalUuid (string) –
      
      The universally unique identifier (UUID) for the run.
    - runArn (string) –
      
      The unique ARN of the workflow run.
    - submissionStatus (string) –
      
      The submission outcome for this run.
    - submissionFailureReason (string) –
      
      The error category for a failed submission. See the run-level failure table in the HealthOmics User Guide for details on each value.
    - submissionFailureMessage (string) –
      
      A detailed message describing the submission failure.
- nextToken (string) –
  
  A pagination token to retrieve the next page of results. Absent when the last run has been returned.

Exceptions

Omics.Client.exceptions.InternalServerException
Omics.Client.exceptions.ServiceQuotaExceededException
Omics.Client.exceptions.ThrottlingException
Omics.Client.exceptions.ValidationException
Omics.Client.exceptions.ConflictException
Omics.Client.exceptions.ResourceNotFoundException
Omics.Client.exceptions.AccessDeniedException
Omics.Client.exceptions.RequestTimeoutException