ResilienceHubV2 / Paginator / ListTestRunEvents

ListTestRunEvents

class ResilienceHubV2.Paginator.ListTestRunEvents

paginator = client.get_paginator('list_test_run_events')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    testRunId='string',
    serviceArn='string',
    startedAt=datetime(2015, 1, 1),
    endedAt=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• testRunId (string) –

  [REQUIRED]

  The identifier of the test run to list events for.

• serviceArn (string) –

  [REQUIRED]

  The ARN of the service the test run belongs to.

• startedAt (datetime) – Return events at or after this timestamp.

• endedAt (datetime) – Return events at or before this timestamp.

• 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

{
    'events': [
        {
            'eventId': 'string',
            'eventType': 'string',
            'message': 'string',
            'timestamp': datetime(2015, 1, 1),
            'attributes': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • events (list) –

    The list of test run events.

    • (dict) –

      A single event in a test run’s timeline.

      • eventId (string) –

        The unique identifier of the event.

      • eventType (string) –

        The type of the event, such as action_started, action_completed, or rto_recovery_detected.

      • message (string) –

        A human-readable description of what happened.

      • timestamp (datetime) –

        The timestamp when the event occurred.

      • attributes (dict) –

        Machine-parseable key-value attributes for the event.

        • (string) –

          The key of a test run event attribute.

          • (string) –

            The value of a test run event attribute.

  • NextToken (string) –

    A token to resume pagination.