Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListExperiments

Lists all the experiments in your account. The list can be filtered to show only experiments that were created in a specific time range. The list can be sorted by experiment name or creation time.

Request Syntax


{
   "MaxResults": number,
   "NextToken": "string",
   "SortBy": "string",
   "SortOrder": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MaxResults

The maximum number of experiments to return in the response. The default value is 10.

Type: Integer

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

Required: No

NextToken

If the previous call to ListExperiments didn't return the full set of experiments, the call returns a token for getting the next set of experiments.

Type: String

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

Pattern: .*

Required: No

SortBy

The property used to sort results. The default value is CreationTime.

Type: String

Valid Values: Name | CreationTime

Required: No

SortOrder

The sort order. The default value is Descending.

Type: String

Valid Values: Ascending | Descending

Required: No

Response Syntax


{
   "ExperimentSummaries": [ 
      { 
         "DisplayName": "string",
         "ExperimentArn": "string",
         "ExperimentName": "string",
         "ExperimentSource": { 
            "SourceArn": "string",
            "SourceType": "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.

ExperimentSummaries

A list of the summaries of your experiments.

Type: Array of ExperimentSummary objects

NextToken

A token for getting the next set of experiments, if there are any.

Type: String

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

Pattern: .*

Errors

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