AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . resiliencehubv2 ]

get-test-run

Description

Retrieves a test run by ID, including its status, results, and the configuration snapshotted when the run started.

See also: AWS API Documentation

Synopsis

  get-test-run
--test-run-id <value>
--service-arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--test-run-id (string)

The identifier of the test run to retrieve.

--service-arn (string)

The ARN of the service the test run belongs to.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

testRun -> (structure)

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 -> (timestamp)

The timestamp when the test run started.

endedAt -> (timestamp)

The timestamp when the test run ended.

experiments -> (list)

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

(structure)

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 -> (map)

The parameter values used for the test run.

key -> (string)

The key of a test parameter.

value -> (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.

(structure)

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 -> (structure)

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 -> (structure)

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

reportOutput -> (list)

The output destinations for generated reports.

(tagged union structure)

Configuration for a report output destination.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: s3.

s3 -> (structure)

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 -> (structure)

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 -> (structure)

The availability SLO targets.

target -> (double)

The target availability percentage, expressed as a value between 0 and 100.

multiAz -> (structure)

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 -> (structure)

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 -> (structure)

The data recovery targets.

timeBetweenBackupsInMinutes -> (integer)

The target time between backups, in minutes.

reportOutput -> (structure)

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 -> (timestamp)

The timestamp when the report was created.

reportOutput -> (tagged union structure)

Present when status is SUCCEEDED or FAILED.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: s3ReportOutput, failedReportOutput.

s3ReportOutput -> (structure)

The S3 location where the report was written.

s3ObjectKey -> (string)

The S3 object key for the generated report.

failedReportOutput -> (structure)

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 -> (structure)

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.

(structure)

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 this test run targets a single account or multiple accounts.