ResilienceHubV2 / Paginator / ListTestRunSources

ListTestRunSources

class ResilienceHubV2.Paginator.ListTestRunSources

paginator = client.get_paginator('list_test_run_sources')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    testRunId='string',
    serviceArn='string',
    type='SUCCESS_CRITERIA'|'OBSERVABILITY',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• testRunId (string) –

  [REQUIRED]

  The identifier of the test run to list sources for.

• serviceArn (string) –

  [REQUIRED]

  The ARN of the service the test run belongs to.

• type (string) – Filter sources by type.

• 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

{
    'testRunSources': [
        {
            'successCriteriaAlarm': {
                'alarmArn': 'string',
                'alarmName': 'string',
                'region': 'string',
                'accountId': 'string',
                'outcome': 'PASSED'|'FAILED'|'ERROR',
                'outcomeReason': 'string'
            },
            'observabilityAlarm': {
                'alarmArn': 'string',
                'alarmName': 'string',
                'region': 'string',
                'accountId': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • testRunSources (list) –

    The list of monitoring source snapshots.

    • (dict) –

      A monitoring-source snapshot captured for a test run. Exactly one member is set.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: successCriteriaAlarm, observabilityAlarm. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      

      • successCriteriaAlarm (dict) –

        A success criteria alarm snapshot captured for the test run.

        • alarmArn (string) –

          The ARN of the CloudWatch alarm.

        • alarmName (string) –

          The name of the CloudWatch alarm.

        • region (string) –

          The Region of the CloudWatch alarm.

        • accountId (string) –

          The account ID that owns the CloudWatch alarm.

        • outcome (string) –

          The evaluation outcome of the source. Absent while the source has not yet been evaluated; set to the terminal outcome afterwards.

        • outcomeReason (string) –

          A human-readable reason for the outcome.

      • observabilityAlarm (dict) –

        An observability alarm snapshot captured for the test run.

        • alarmArn (string) –

          The ARN of the CloudWatch alarm.

        • alarmName (string) –

          The name of the CloudWatch alarm.

        • region (string) –

          The Region of the CloudWatch alarm.

        • accountId (string) –

          The account ID that owns the CloudWatch alarm.

  • NextToken (string) –

    A token to resume pagination.