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 ]
update-test¶
Synopsis¶
update-test
--test-id <value>
--service-arn <value>
[--logging-configuration <value>]
[--stop-conditions <value>]
[--role-name <value>]
[--parameters <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-id (string)
The identifier of the test to update.
--service-arn (string)
The ARN of the service the test belongs to.
--logging-configuration (structure)
The updated logging configuration for the test.
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.
Shorthand Syntax:
s3BucketName=string,cloudWatchLogGroupArn=string,logSchemaVersion=string
JSON Syntax:
{
"s3BucketName": "string",
"cloudWatchLogGroupArn": "string",
"logSchemaVersion": "string"
}
--stop-conditions (list)
The updated stop conditions for the test.
(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.
Shorthand Syntax:
source=string,value=string ...
JSON Syntax:
[
{
"source": "aws:cloudwatch:alarm"|"none",
"value": "string"
}
...
]
--role-name (string)
The updated IAM execution role name.
--parameters (map)
The updated parameter values for the test.
key -> (string)
The key of a test parameter.value -> (list)
(string)
A value of a test parameter.
Shorthand Syntax:
KeyName1=string,string,KeyName2=string,string
JSON Syntax:
{"string": ["string", ...]
...}
--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¶
test -> (structure)
The updated test.
testId -> (string)
The unique identifier of the test.testTemplateArn -> (string)
The ARN of the test template the test was created from.serviceArn -> (string)
The ARN of the service the test belongs to.name -> (string)
The name of the test.actions -> (list)
The fault actions the test runs.
(structure)
Represents a fault action that a test runs, along with the resource type it targets.
actionId -> (string)
The identifier of the fault action.description -> (string)
A description of the fault action.resourceType -> (string)
The resource type that the action targets.loggingConfiguration -> (structure)
The logging configuration for the test.
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.stopConditions -> (list)
The stop conditions for the test.
(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.roleName -> (string)
The name of the IAM execution role used to run the test.parameters -> (map)
The parameter values configured for the test.
key -> (string)
The key of a test parameter.value -> (list)
(string)
A value of a test parameter.totalTestRuns -> (integer)
The total number of runs of the test.successfulTestRuns -> (integer)
The number of successful runs of the test.creationTime -> (timestamp)
The timestamp when the test was created.