Stop Experiment

cloudwatchevidently_stop_experiment

R Documentation

Stops an experiment that is currently running

Description

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

Usage

cloudwatchevidently_stop_experiment(desiredState, experiment, project,
  reason)

Arguments

desiredState

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

experiment

[required] The name of the experiment to stop.

project

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

reason

A string that describes why you are stopping the experiment.

Value

A list with the following syntax:

list(
  endedTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$stop_experiment(
  desiredState = "COMPLETED"|"CANCELLED",
  experiment = "string",
  project = "string",
  reason = "string"
)