Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListExperiments

Lists your experiments.

Request Syntax


GET /experiments?experimentTemplateId=experimentTemplateId&maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

experimentTemplateId

The ID of the experiment template.

Length Constraints: Maximum length of 64.

Pattern: [\S]+

maxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

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

nextToken

The token for the next page of results.

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

Pattern: [\S]+

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "experiments": [ 
      { 
         "arn": "string",
         "creationTime": number,
         "experimentOptions": { 
            "accountTargeting": "string",
            "actionsMode": "string",
            "emptyTargetResolutionMode": "string"
         },
         "experimentTemplateId": "string",
         "id": "string",
         "state": { 
            "error": { 
               "accountId": "string",
               "code": "string",
               "location": "string"
            },
            "reason": "string",
            "status": "string"
         },
         "tags": { 
            "string" : "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

The experiments.

Type: Array of ExperimentSummary objects

nextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

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

Pattern: [\S]+

Errors

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

ValidationException

The specified input is not valid, or fails to satisfy the constraints for the request.

HTTP Status Code: 400