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 ]

list-experiments

Description

Lists your experiments.

See also: AWS API Documentation

Synopsis

  list-experiments
[--max-results <value>]
[--next-token <value>]
[--experiment-template-id <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>]

Options

--max-results (integer)

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

--next-token (string)

The token for the next page of results.

--experiment-template-id (string)

The ID of the experiment template.

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

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

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To list experiments

The following list-experiments example lists the experiments in your AWS account.

aws fis list-experiments

Output:

{
    "experiments": [
        {
            "id": "ABCdeF1GHiJkLM23NO",
            "experimentTemplateId": "ABCDE1fgHIJkLmNop",
            "state": {
                "status": "running",
                "reason": "Experiment is running."
            },
            "creationTime": 1616017341.197,
            "tags": {
            "key": "value"
            }
        }
    ]
}

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

Output

experiments -> (list)

The experiments.

(structure)

Provides a summary of an experiment.

id -> (string)

The ID of the experiment.

arn -> (string)

The Amazon Resource Name (ARN) of the experiment.

experimentTemplateId -> (string)

The ID of the experiment template.

state -> (structure)

The state of the experiment.

status -> (string)

The state of the experiment.

reason -> (string)

The reason for the state.

creationTime -> (timestamp)

The time that the experiment was created.

tags -> (map)

The tags for the experiment.

key -> (string)

value -> (string)

experimentOptions -> (structure)

The experiment options for the experiment.

accountTargeting -> (string)

The account targeting setting for an experiment.

emptyTargetResolutionMode -> (string)

The empty target resolution mode for an experiment.

actionsMode -> (string)

The actions mode of the experiment that is set from the StartExperiment API command.

nextToken -> (string)

The token to use to retrieve the next page of results. This value is null when there are no more results to return.