ResilienceHubV2 / Client / list_test_runs

list_test_runs

ResilienceHubV2.Client.list_test_runs(**kwargs)

Lists the runs of a test, or all test runs for a service.

See also: AWS API Documentation

Request Syntax

response = client.list_test_runs(
    serviceArn='string',
    testId='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • serviceArn (string) –

    [REQUIRED]

    The ARN of the service to list test runs for.

  • testId (string) – Filter test runs by test identifier.

  • maxResults (integer) – Pagination page size.

  • nextToken (string) – Pagination token.

Return type:

dict

Returns:

Response Syntax

{
    'testRuns': [
        {
            'testRunId': 'string',
            'status': 'INITIALIZING'|'RUNNING'|'STOPPING'|'PASSED'|'FAILED'|'STOPPED'|'ERROR',
            'startedAt': datetime(2015, 1, 1),
            'endedAt': datetime(2015, 1, 1),
            'testTemplateArn': 'string',
            'serviceArn': 'string',
            'errorMessage': 'string',
            'accountTargeting': 'SINGLE_ACCOUNT'|'MULTI_ACCOUNT'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • testRuns (list) –

      The list of test run summaries.

      • (dict) –

        Contains summary information about a test run.

        • testRunId (string) –

          The unique identifier of the test run.

        • status (string) –

          The current status of the test run.

        • startedAt (datetime) –

          The timestamp when the test run started.

        • endedAt (datetime) –

          The timestamp when the test run ended.

        • testTemplateArn (string) –

          The ARN of the test template the test run was based on.

        • serviceArn (string) –

          The ARN of the service the test run belongs to.

        • errorMessage (string) –

          A human-readable reason for test run failure. Only present when the status is FAILED or ERROR.

        • accountTargeting (string) –

          Indicates whether this test run targets a single account or multiple accounts.

    • nextToken (string) –

      Pagination token.

Exceptions