ResilienceHubV2 / Client / list_test_run_sources

list_test_run_sources¶

ResilienceHubV2.Client.list_test_run_sources(**kwargs)¶

Lists the monitoring source snapshots captured for a test run, optionally filtered by type.

Request Syntax

response = client.list_test_run_sources(
    testRunId='string',
    serviceArn='string',
    type='SUCCESS_CRITERIA'|'OBSERVABILITY',
    maxResults=123,
    nextToken='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.
maxResults (integer) – Pagination page size.
nextToken (string) – Pagination token.

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) –
  
  Pagination token.

Exceptions

ResilienceHubV2.Client.exceptions.InternalServerException
ResilienceHubV2.Client.exceptions.ResourceNotFoundException
ResilienceHubV2.Client.exceptions.ValidationException
ResilienceHubV2.Client.exceptions.AccessDeniedException