GetExperiment - CloudWatch Evidently


Returns the details about one experiment. You must already know the experiment name. To retrieve a list of experiments in your account, use ListExperiments.

Request Syntax

GET /projects/project/experiments/experiment HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The name of the experiment that you want to see the details of.

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

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

Required: Yes


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

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 does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "experiment": { "arn": "string", "createdTime": number, "description": "string", "execution": { "endedTime": number, "startedTime": number }, "lastUpdatedTime": number, "metricGoals": [ { "desiredChange": "string", "metricDefinition": { "entityIdKey": "string", "eventPattern": "string", "name": "string", "unitLabel": "string", "valueKey": "string" } } ], "name": "string", "onlineAbDefinition": { "controlTreatmentName": "string", "treatmentWeights": { "string" : number } }, "project": "string", "randomizationSalt": "string", "samplingRate": number, "schedule": { "analysisCompleteTime": number }, "segment": "string", "status": "string", "statusReason": "string", "tags": { "string" : "string" }, "treatments": [ { "description": "string", "featureVariations": { "string" : "string" }, "name": "string" } ], "type": "string" } }

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.


A structure containing the configuration details of the experiment.

Type: Experiment object


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


You do not have sufficient permissions to perform this action.

HTTP Status Code: 403


The request references a resource that does not exist.

HTTP Status Code: 404


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

HTTP Status Code: 429


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: