Amazon Omics

{'items': {'workflowName': 'string'}}

Retrieves a list of runs and returns each run's metadata and status.

Amazon Web Services HealthOmics stores a configurable number of runs, as determined by service limits, that are available to the console and API. If the ListRuns response doesn't include specific runs that you expected, you can find all run logs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logs in the Amazon Web Services HealthOmics User Guide.

See also: AWS API Documentation

Request Syntax

client.list_runs(
    name='string',
    runGroupId='string',
    batchId='string',
    startingToken='string',
    maxResults=123,
    status='PENDING'|'STARTING'|'RUNNING'|'STOPPING'|'COMPLETED'|'DELETED'|'CANCELLED'|'FAILED'
)

type name:

string

param name:

Filter the list by run name.

type runGroupId:

string

param runGroupId:

Filter the list by run group ID.

type batchId:

string

param batchId:

Filter by batch ID.

type startingToken:

string

param startingToken:

Specify the pagination token from a previous request to retrieve the next page of results.

type maxResults:

integer

param maxResults:

The maximum number of runs to return in one page of results.

type status:

string

param status:

The status of a run.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'arn': 'string',
            'id': 'string',
            'status': 'PENDING'|'STARTING'|'RUNNING'|'STOPPING'|'COMPLETED'|'DELETED'|'CANCELLED'|'FAILED',
            'workflowId': 'string',
            'batchId': 'string',
            'name': 'string',
            'priority': 123,
            'storageCapacity': 123,
            'creationTime': datetime(2015, 1, 1),
            'startTime': datetime(2015, 1, 1),
            'stopTime': datetime(2015, 1, 1),
            'storageType': 'STATIC'|'DYNAMIC',
            'workflowVersionName': 'string',
            'workflowName': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • items (list) --

    A list of runs.

    • (dict) --

      A workflow run.

      • arn (string) --

        The run's ARN.

      • id (string) --

        The run's ID.

      • status (string) --

        The run's status.

      • workflowId (string) --

        The run's workflow ID.

      • batchId (string) --

        The run's batch ID.

      • name (string) --

        The run's name.

      • priority (integer) --

        The run's priority.

      • storageCapacity (integer) --

        The run's storage capacity in gibibytes. For dynamic storage, after the run has completed, this value is the maximum amount of storage used during the run.

      • creationTime (datetime) --

        When the run was created.

      • startTime (datetime) --

        When the run started.

      • stopTime (datetime) --

        When the run stopped.

      • storageType (string) --

        The run's storage type.

      • workflowVersionName (string) --

        The name of the workflow version.

      • workflowName (string) --

        The name of the workflow.

  • nextToken (string) --

    A pagination token that's included if more results are available.