[ aws . fis ]

list-experiments

Description

Lists your experiments.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-experiments
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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

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.

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)

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.