Class StopExperimentCommandProtected

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

Example

Use a bare-bones client and the command you need to make an API call.

import { EvidentlyClient, StopExperimentCommand } from "@aws-sdk/client-evidently"; // ES Modules import
// const { EvidentlyClient, StopExperimentCommand } = require("@aws-sdk/client-evidently"); // CommonJS import
const client = new EvidentlyClient(config);
const input = { // StopExperimentRequest
  project: "STRING_VALUE", // required
  experiment: "STRING_VALUE", // required
  desiredState: "STRING_VALUE",
  reason: "STRING_VALUE",
};
const command = new StopExperimentCommand(input);
const response = await client.send(command);
// { // StopExperimentResponse
//   endedTime: new Date("TIMESTAMP"),
// };

Param

StopExperimentCommandInput

Returns

StopExperimentCommandOutput

See

• StopExperimentCommandInput for command's input shape.
• StopExperimentCommandOutput for command's response shape.
• config for EvidentlyClient's config shape.

Throws

AccessDeniedException (client fault)

You do not have sufficient permissions to perform this action.

Throws

ConflictException (client fault)

A resource was in an inconsistent state during an update or a deletion.

Throws

ResourceNotFoundException (client fault)

The request references a resource that does not exist.

Throws

ServiceQuotaExceededException (client fault)

The request would cause a service quota to be exceeded.

Throws

ThrottlingException (client fault)

The request was denied because of request throttling. Retry the request.

Throws

ValidationException (client fault)

The value of a parameter in the request caused an error.

Throws

EvidentlyServiceException

Base exception class for all service exceptions from Evidently service.