View a markdown version of this page

TestRun - Next generation Resilience Hub

TestRun

Represents a single run of a test. Configuration is snapshotted from the test and service at the time the run is started.

Contents

startedAt

The timestamp when the test run started.

Type: Timestamp

Required: Yes

status

The current status of the test run.

Type: String

Valid Values: INITIALIZING | RUNNING | STOPPING | PASSED | FAILED | STOPPED | ERROR

Required: Yes

testId

The identifier of the test that was run.

Type: String

Required: Yes

testRunId

The unique identifier of the test run.

Type: String

Required: Yes

testTemplateArn

The ARN of the test template snapshotted from the test when the run was started.

Type: String

Length Constraints: Minimum length of 31.

Pattern: arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):([0-9]{12}|aws):[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}

Required: Yes

accountTargeting

Indicates whether the test run targets resources in a single AWS account or across multiple accounts.

Type: String

Valid Values: SINGLE_ACCOUNT | MULTI_ACCOUNT

Required: No

endedAt

The timestamp when the test run ended.

Type: Timestamp

Required: No

errorMessage

A human-readable reason for test run failure. Only present when the status is FAILED or ERROR.

Type: String

Required: No

eventCount

The number of events recorded for the test run. Use ListTestRunEvents to retrieve the details.

Type: Integer

Required: No

experiments

The AWS Fault Injection Service (AWS FIS) experiments run as part of the test run.

Type: Array of ExperimentDetails objects

Required: No

loggingConfiguration

The logging configuration snapshotted from the test when the run was started.

Type: LoggingConfiguration object

Required: No

parameters

The parameter values used for the test run.

Type: String to array of strings map

Map Entries: Minimum number of 0 items. Maximum number of 20 items.

Key Length Constraints: Minimum length of 1. Maximum length of 256.

Key Pattern: [\w.-]+

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

permissionModel

The permission model snapshotted from the service when the run was started.

Type: PermissionModel object

Required: No

policy

The resilience policy snapshotted from the service when the run was started.

Type: TestRunPolicySnapshot object

Required: No

regions

The Regions snapshotted from the service when the run was started.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Length Constraints: Minimum length of 6.

Pattern: [a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]

Required: No

regionSwitchExecutionId

The identifier of the ARC Region switch execution detected during the test run.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-z]{2}(-[a-z]+)+-[0-9]+/[0-9a-fA-F]{16}

Required: No

regionSwitchPlanArn

The ARN of the ARC Region switch plan associated with the test run.

Type: String

Length Constraints: Minimum length of 31.

Pattern: arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}

Required: No

reportConfiguration

The report configuration snapshotted from the service when the run was started.

Type: TestRunReportConfiguration object

Required: No

reportOutput

The report generation result for the test run. Present after report generation completes or fails.

Type: ReportGenerationResult object

Required: No

roleName

The IAM execution role name snapshotted from the test when the run was started.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 60.

Pattern: [A-Za-z0-9][A-Za-z0-9_\-]{1,59}

Required: No

serviceArn

The ARN of the service the test run belongs to.

Type: String

Length Constraints: Minimum length of 31.

Pattern: arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+.-]{0,1023}

Required: No

stopConditions

The stop conditions snapshotted from the test when the run was started.

Type: Array of StopCondition objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: