Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . fis ]

stop-experiment

Description

Stops the specified experiment.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  stop-experiment
--id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--id (string)

The ID of the experiment.

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

See 'aws help' for descriptions of global parameters.

Examples

To stop an experiment

The following stop-experiment example stops the specified experiment from running.

aws fis stop-experiment \
    --id ABC12DeFGhI3jKLMNOP

Output:

{
    "experiment": {
        "id": "ABC12DeFGhI3jKLMNOP",
        "experimentTemplateId": "ABCDE1fgHIJkLmNop",
        "roleArn": "arn:aws:iam::123456789012:role/myRole",
        "state": {
            "status": "stopping",
            "reason": "Stopping Experiment."
        },
        "targets": {
            "Instances-Target-1": {
                "resourceType": "aws:ec2:instance",
                "resourceArns": [
                    "arn:aws:ec2:us-west-2:123456789012:instance/i-12a3b4c56d78e9012"
                ],
                "selectionMode": "ALL"
            }
        },
        "actions": {
            "reboot": {
                "actionId": "aws:ec2:reboot-instances",
                "parameters": {},
                "targets": {
                    "Instances": "Instances-Target-1"
                },
                "startAfter": [
                    "wait"
                ],
                "state": {
                    "status": "pending",
                    "reason": "Initial state."
                }
            },
            "wait": {
                "actionId": "aws:fis:wait",
                "parameters": {
                    "duration": "PT5M"
                },
                "state": {
                    "status": "running",
                    "reason": ""
                }
            }
        },
        "stopConditions": [
            {
                "source": "none"
            }
        ],
        "creationTime": 1616432680.927,
        "startTime": 1616432681.177,
        "tags": {}
    }
}

For more information, see Experiments for AWS FIS in the AWS Fault Injection Simulator User Guide.

Output

experiment -> (structure)

Information about the experiment.

id -> (string)

The ID of the experiment.

experimentTemplateId -> (string)

The ID of the experiment template.

roleArn -> (string)

The Amazon Resource Name (ARN) of an IAM role that grants the AWS FIS service permission to perform service actions on your behalf.

state -> (structure)

The state of the experiment.

status -> (string)

The state of the experiment.

reason -> (string)

The reason for the state.

targets -> (map)

The targets for the experiment.

key -> (string)

value -> (structure)

Describes a target for an experiment.

resourceType -> (string)

The resource type.

resourceArns -> (list)

The Amazon Resource Names (ARNs) of the resources.

(string)

resourceTags -> (map)

The tags for the target resources.

key -> (string)

value -> (string)

filters -> (list)

The filters to apply to identify target resources using specific attributes.

(structure)

Describes a filter used for the target resources in an experiment.

path -> (string)

The attribute path for the filter.

values -> (list)

The attribute values for the filter.

(string)

selectionMode -> (string)

Scopes the identified resources to a specific count or percentage.

actions -> (map)

The actions for the experiment.

key -> (string)

value -> (structure)

Describes the action for an experiment.

actionId -> (string)

The ID of the action.

description -> (string)

The description for the action.

parameters -> (map)

The parameters for the action.

key -> (string)

value -> (string)

targets -> (map)

The targets for the action.

key -> (string)

value -> (string)

startAfter -> (list)

The name of the action that must be completed before this action starts.

(string)

state -> (structure)

The state of the action.

status -> (string)

The state of the action.

reason -> (string)

The reason for the state.

stopConditions -> (list)

The stop conditions for the experiment.

(structure)

Describes the stop condition for an experiment.

source -> (string)

The source for the stop condition.

value -> (string)

The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.

creationTime -> (timestamp)

The time the experiment was created.

startTime -> (timestamp)

The time that the experiment was started.

endTime -> (timestamp)

The time that the experiment ended.

tags -> (map)

The tags for the experiment.

key -> (string)

value -> (string)