[ aws . evidently ]

stop-experiment

Description

Stops an experiment that is currently running. If you stop an experiment, you can’t resume it or restart it.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  stop-experiment
[--desired-state <value>]
--experiment <value>
--project <value>
[--reason <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--desired-state (string)

Specify whether the experiment is to be considered COMPLETED or CANCELLED after it stops.

Possible values:

• COMPLETED

• CANCELLED

--experiment (string)

The name of the experiment to stop.

--project (string)

The name or ARN of the project that contains the experiment to stop.

--reason (string)

A string that describes why you are stopping the experiment.

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

endedTime -> (timestamp)

The date and time that the experiment stopped.