2026/11/18 - AWS Resilience Hub V2 - 2 updated api methods
Changes This release includes support for adding new field for the effective policy used in test runs and documentation updates.
{'testRun': {'effectivePolicyValues': {'availabilitySlo': {'policyName': 'string',
'source': 'SELF | '
'CROSS_ACCOUNT',
'value': 'double'},
'dataRecoveryTimeBetweenBackups': {'policyName': 'string',
'source': 'SELF '
'| '
'CROSS_ACCOUNT',
'value': 'integer'},
'multiAzDrApproach': {'policyName': 'string',
'source': 'SELF | '
'CROSS_ACCOUNT',
'value': 'string'},
'multiAzRpo': {'policyName': 'string',
'source': 'SELF | '
'CROSS_ACCOUNT',
'value': 'integer'},
'multiAzRto': {'policyName': 'string',
'source': 'SELF | '
'CROSS_ACCOUNT',
'value': 'integer'},
'multiRegionDrApproach': {'policyName': 'string',
'source': 'SELF '
'| '
'CROSS_ACCOUNT',
'value': 'string'},
'multiRegionRpo': {'policyName': 'string',
'source': 'SELF | '
'CROSS_ACCOUNT',
'value': 'integer'},
'multiRegionRto': {'policyName': 'string',
'source': 'SELF | '
'CROSS_ACCOUNT',
'value': 'integer'}}}}
Retrieves a test run by ID, including its status, results, and the configuration snapshotted when the run started.
See also: AWS API Documentation
Request Syntax
client.get_test_run(
testRunId='string',
serviceArn='string'
)
string
[REQUIRED]
The identifier of the test run to retrieve.
string
[REQUIRED]
The ARN of the service the test run belongs to.
dict
Response Syntax
{
'testRun': {
'testRunId': 'string',
'testId': 'string',
'status': 'INITIALIZING'|'RUNNING'|'STOPPING'|'PASSED'|'FAILED'|'STOPPED'|'ERROR',
'serviceArn': 'string',
'startedAt': datetime(2015, 1, 1),
'endedAt': datetime(2015, 1, 1),
'experiments': [
{
'experimentArn': 'string',
'details': 'string'
},
],
'eventCount': 123,
'parameters': {
'string': [
'string',
]
},
'errorMessage': 'string',
'stopConditions': [
{
'source': 'aws:cloudwatch:alarm'|'none',
'value': 'string'
},
],
'loggingConfiguration': {
's3BucketName': 'string',
'cloudWatchLogGroupArn': 'string',
'logSchemaVersion': 'string'
},
'roleName': 'string',
'testTemplateArn': 'string',
'reportConfiguration': {
'reportOutput': [
{
's3': {
'bucketPath': 'string',
'bucketOwner': 'string'
}
},
]
},
'policy': {
'policyArn': 'string',
'name': 'string',
'availabilitySlo': {
'target': 123.0
},
'multiAz': {
'rtoInMinutes': 123,
'rpoInMinutes': 123,
'disasterRecoveryApproach': 'ACTIVE_ACTIVE'|'HOT_STANDBY'|'WARM_STANDBY'|'PILOT_LIGHT'|'BACKUP_AND_RESTORE'
},
'multiRegion': {
'rtoInMinutes': 123,
'rpoInMinutes': 123,
'disasterRecoveryApproach': 'ACTIVE_ACTIVE'|'HOT_STANDBY'|'WARM_STANDBY'|'PILOT_LIGHT'|'BACKUP_AND_RESTORE'
},
'dataRecovery': {
'timeBetweenBackupsInMinutes': 123
}
},
'effectivePolicyValues': {
'availabilitySlo': {
'value': 123.0,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiAzRto': {
'value': 123,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiAzRpo': {
'value': 123,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiAzDrApproach': {
'value': 'string',
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiRegionRto': {
'value': 123,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiRegionRpo': {
'value': 123,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'multiRegionDrApproach': {
'value': 'string',
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
},
'dataRecoveryTimeBetweenBackups': {
'value': 123,
'policyName': 'string',
'source': 'SELF'|'CROSS_ACCOUNT'
}
},
'reportOutput': {
'reportType': 'FAILURE_MODE'|'TESTING',
'status': 'PENDING'|'SUCCEEDED'|'FAILED',
'serviceArn': 'string',
'assessmentId': 'string',
'testRunId': 'string',
'testTemplateArn': 'string',
'createdAt': datetime(2015, 1, 1),
'reportOutput': {
's3ReportOutput': {
's3ObjectKey': 'string'
},
'failedReportOutput': {
'errorCode': 'INSUFFICIENT_PERMISSIONS'|'CONFIGURATION_ERROR'|'INTERNAL_ERROR',
'errorMessage': 'string'
}
}
},
'regionSwitchPlanArn': 'string',
'regionSwitchExecutionId': 'string',
'permissionModel': {
'invokerRoleName': 'string',
'crossAccountRoles': [
{
'crossAccountRoleArn': 'string',
'externalId': 'string'
},
]
},
'regions': [
'string',
],
'accountTargeting': 'SINGLE_ACCOUNT'|'MULTI_ACCOUNT',
'devOpsAgentInvestigation': {
'verdict': 'PASS'|'FAIL',
'confidence': 'HIGH'|'MEDIUM'|'LOW',
'deepLink': 'string',
'status': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'TIMED_OUT'|'CANCELED',
'summary': 'string'
}
}
}
Response Structure
(dict) --
testRun (dict) --
The requested test run.
testRunId (string) --
The unique identifier of the test run.
testId (string) --
The identifier of the test that was run.
status (string) --
The current status of the test run.
serviceArn (string) --
The ARN of the service the test run belongs to.
startedAt (datetime) --
The timestamp when the test run started.
endedAt (datetime) --
The timestamp when the test run ended.
experiments (list) --
The AWS Fault Injection Service (AWS FIS) experiments run as part of the test run.
(dict) --
Details about an AWS Fault Injection Service (AWS FIS) experiment run as part of a test run.
experimentArn (string) --
The ARN of the AWS FIS experiment.
details (string) --
Additional details about the experiment.
eventCount (integer) --
The number of events recorded for the test run. Use ListTestRunEvents to retrieve the details.
parameters (dict) --
The parameter values used for the test run.
(string) --
The key of a test parameter.
(list) --
(string) --
A value of a test parameter.
errorMessage (string) --
A human-readable reason for test run failure. Only present when the status is FAILED or ERROR.
stopConditions (list) --
The stop conditions snapshotted from the test when the run was started.
(dict) --
A CloudWatch alarm that automatically stops a test run if it breaches its threshold.
source (string) --
The source of the stop condition.
value (string) --
The value of the stop condition, such as the ARN of the CloudWatch alarm.
loggingConfiguration (dict) --
The logging configuration snapshotted from the test when the run was started.
s3BucketName (string) --
The name of the S3 bucket for log delivery.
cloudWatchLogGroupArn (string) --
The ARN of the CloudWatch Logs log group for log delivery.
logSchemaVersion (string) --
The version of the log schema.
roleName (string) --
The IAM execution role name snapshotted from the test when the run was started.
testTemplateArn (string) --
The ARN of the test template snapshotted from the test when the run was started.
reportConfiguration (dict) --
The report configuration snapshotted from the service when the run was started.
reportOutput (list) --
The output destinations for generated reports.
(dict) --
Configuration for a report output destination.
s3 (dict) --
S3 configuration for report output.
bucketPath (string) --
S3 bucket path where reports will be written (e.g., my-bucket/ngrh-reports/).
bucketOwner (string) --
Account ID of the bucket owner for cross-account access verification.
policy (dict) --
The resilience policy snapshotted from the service when the run was started.
policyArn (string) --
The ARN of the policy.
name (string) --
The name of the policy.
availabilitySlo (dict) --
The availability SLO targets.
target (float) --
The target availability percentage, expressed as a value between 0 and 100.
multiAz (dict) --
The multi-AZ resilience targets.
rtoInMinutes (integer) --
The recovery time objective (RTO) target for multi-AZ, in minutes.
rpoInMinutes (integer) --
The recovery point objective (RPO) target for multi-AZ, in minutes.
disasterRecoveryApproach (string) --
The disaster recovery approach for multi-AZ.
multiRegion (dict) --
The multi-Region resilience targets.
rtoInMinutes (integer) --
The recovery time objective (RTO) target for multi-Region, in minutes.
rpoInMinutes (integer) --
The recovery point objective (RPO) target for multi-Region, in minutes.
disasterRecoveryApproach (string) --
The disaster recovery approach for multi-Region.
dataRecovery (dict) --
The data recovery targets.
timeBetweenBackupsInMinutes (integer) --
The target time between backups, in minutes.
effectivePolicyValues (dict) --
The effective resilience policy values snapshotted from the service when the run was started. The test run is evaluated against these values.
availabilitySlo (dict) --
The effective availability SLO value for the test run.
value (float) --
The availability SLO percentage value.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiAzRto (dict) --
The effective multi-AZ RTO value for the test run, in minutes.
value (integer) --
The RTO or RPO value in minutes.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiAzRpo (dict) --
The effective multi-AZ RPO value for the test run, in minutes.
value (integer) --
The RTO or RPO value in minutes.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiAzDrApproach (dict) --
The effective multi-Availability Zone (AZ) disaster recovery approach for the test run.
value (string) --
The disaster recovery approach value.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiRegionRto (dict) --
The effective multi-Region RTO value for the test run, in minutes.
value (integer) --
The RTO or RPO value in minutes.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiRegionRpo (dict) --
The effective multi-Region RPO value for the test run, in minutes.
value (integer) --
The RTO or RPO value in minutes.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
multiRegionDrApproach (dict) --
The effective multi-Region disaster recovery approach for the test run.
value (string) --
The disaster recovery approach value.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
dataRecoveryTimeBetweenBackups (dict) --
The effective data recovery time between backups value for the test run.
value (integer) --
The RTO or RPO value in minutes.
policyName (string) --
Resource name (used in ARN — no spaces allowed).
source (string) --
Indicates whether the value comes from the service's own account or a cross-account policy.
reportOutput (dict) --
The report generation result for the test run. Present after report generation completes or fails.
reportType (string) --
The type of the generated report.
status (string) --
The status of the report generation.
serviceArn (string) --
The service this report was generated for.
assessmentId (string) --
Present for FAILURE_MODE reports.
testRunId (string) --
The unique identifier of a test run.
testTemplateArn (string) --
An ARN owned by the service. Accepts either a standard 12-digit account ID or the literal "aws" for AWS-managed resources, such as AWS-managed test templates.
createdAt (datetime) --
The timestamp when the report was created.
reportOutput (dict) --
Present when status is SUCCEEDED or FAILED.
s3ReportOutput (dict) --
The S3 location where the report was written.
s3ObjectKey (string) --
The S3 object key for the generated report.
failedReportOutput (dict) --
Details when report generation failed.
errorCode (string) --
The error code describing why the report generation failed.
errorMessage (string) --
The error message describing why the report generation failed.
regionSwitchPlanArn (string) --
The ARN of the ARC Region switch plan associated with the test run.
regionSwitchExecutionId (string) --
The identifier of the ARC Region switch execution detected during the test run.
permissionModel (dict) --
The permission model snapshotted from the service when the run was started.
invokerRoleName (string) --
IAM role name (supports up to 64 characters per IAM limits).
crossAccountRoles (list) --
The list of cross-account IAM role ARNs.
(dict) --
Specifies a cross-account IAM role ARN and optional external ID.
crossAccountRoleArn (string) --
ARN of the IAM Role for the profile. Null if the permission profile is the 'Admin' profile.
externalId (string) --
The external ID used for assuming the cross-account role.
regions (list) --
The Regions snapshotted from the service when the run was started.
(string) --
accountTargeting (string) --
Indicates whether the test run targets resources in a single AWS account or across multiple accounts.
devOpsAgentInvestigation (dict) --
The DevOps Agent investigation result for the test run, present when the integration is enabled for the service.
verdict (string) --
The investigation verdict. Valid values:
PASS - The resilience test run passed.
FAIL - The resilience test run failed.
INCONCLUSIVE - The investigation could not determine a clear outcome.
confidence (string) --
The confidence level of the verdict. Valid values:
HIGH - The verdict is highly reliable.
MEDIUM - The verdict has moderate reliability.
LOW - The verdict has low reliability.
deepLink (string) --
A deep link to the interactive DevOps Agent investigation session.
status (string) --
The lifecycle status of the investigation. Valid values:
PENDING - The investigation has been created but has not started.
IN_PROGRESS - The investigation is running.
COMPLETED - The investigation finished successfully.
FAILED - The investigation failed to complete.
TIMED_OUT - The investigation did not complete within the allotted time.
CANCELED - The investigation was canceled.
summary (string) --
The DevOps Agent analysis summary for the investigation.
{'maxResults': 'integer', 'nextToken': 'string'}
Response {'nextToken': 'string'}
Lists the available resilience test templates. A test template is a pre-configured, AWS recommended test that defines which resilience capability to validate.
See also: AWS API Documentation
Request Syntax
client.list_test_templates(
maxResults=123,
nextToken='string'
)
integer
Pagination page size.
string
Pagination token.
dict
Response Syntax
{
'testTemplates': [
{
'testTemplateArn': 'string',
'name': 'string',
'description': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
testTemplates (list) --
The list of test template summaries.
(dict) --
Contains summary information about a test template.
testTemplateArn (string) --
The ARN of the test template.
name (string) --
The name of the test template.
description (string) --
A description of the test template.
nextToken (string) --
Pagination token.