Omics / Paginator / ListRunsInBatch

ListRunsInBatch

class Omics.Paginator.ListRunsInBatch

paginator = client.get_paginator('list_runs_in_batch')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Omics.Client.list_runs_in_batch().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    batchId='string',
    submissionStatus='SUCCESS'|'FAILED'|'CANCEL_SUCCESS'|'CANCEL_FAILED'|'DELETE_SUCCESS'|'DELETE_FAILED',
    runSettingId='string',
    runId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• batchId (string) –

  [REQUIRED]

  The identifier portion of the run batch ARN.

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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 token to resume pagination.