v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14107682538.8 KB

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.

get/run

Query parameters

namestring

Filter the list by run name.

runGroupIdstring

Filter the list by run group ID.

batchIdstring

Filter by batch ID.

startingTokenstring

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

maxResultsinteger

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

status'PENDING' | 'STARTING' | 'RUNNING' | 'STOPPING' | 'COMPLETED' | 'DELETED' | 'CANCELLED' | 'FAILED'

The status of a run.

Response

Success

nextTokenstring

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