StartExperiment - CloudWatch Evidently

StartExperiment

Starts an existing experiment. To create an experiment, use CreateExperiment.

Request Syntax

POST /projects/project/experiments/experiment/start HTTP/1.1 Content-type: application/json { "analysisCompleteTime": number }

URI Request Parameters

The request uses the following URI parameters.

experiment

The name of the experiment to start.

Length Constraints: Minimum length of 1. Maximum length of 127.

Pattern: ^[-a-zA-Z0-9._]*$

Required: Yes

project

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

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: ([-a-zA-Z0-9._]*)|(arn:[^:]*:[^:]*:[^:]*:[^:]*:project/[-a-zA-Z0-9._]*)

Required: Yes

Request Body

The request accepts the following data in JSON format.

analysisCompleteTime

The date and time to end the experiment. This must be no more than 30 days after the experiment starts.

Type: Timestamp

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "startedTime": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

startedTime

A timestamp that indicates when the experiment started.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

ConflictException

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

HTTP Status Code: 409

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

HTTP Status Code: 402

ThrottlingException

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

HTTP Status Code: 429

ValidationException

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

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: