ListExperiments - CloudWatch Evidently

ListExperiments

Returns configuration details about all the experiments in the specified project.

Request Syntax

GET /projects/project/experiments?maxResults=maxResults&nextToken=nextToken&status=status HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of results to include in the response.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken

The token to use when requesting the next set of results. You received this token from a previous ListExperiments operation.

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

Pattern: .*

project

The name or ARN of the project to return the experiment list from.

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

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

Required: Yes

status

Use this optional parameter to limit the returned results to only the experiments with the status that you specify here.

Valid Values: CREATED | UPDATING | RUNNING | COMPLETED | CANCELLED

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "experiments": [ { "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 }, "status": "string", "statusReason": "string", "tags": { "string" : "string" }, "treatments": [ { "description": "string", "featureVariations": { "string" : "string" }, "name": "string" } ], "type": "string" } ], "nextToken": "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.

experiments

An array of structures that contain the configuration details of the experiments in the specified project.

Type: Array of Experiment objects

nextToken

The token to use in a subsequent ListExperiments operation to return the next set of results.

Type: String

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

Pattern: .*

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

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

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: