ResilienceHubV2 / Paginator / ListTestRuns

ListTestRuns¶

class ResilienceHubV2.Paginator.ListTestRuns¶

paginator = client.get_paginator('list_test_runs')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from ResilienceHubV2.Client.list_test_runs().

Request Syntax

response_iterator = paginator.paginate(
    serviceArn='string',
    testId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

serviceArn (string) –
[REQUIRED]

The ARN of the service to list test runs for.
testId (string) – Filter test runs by test identifier.
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

{
    '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) –
  
  A token to resume pagination.