ListExperiments - Amazon SageMaker Service

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

{ "CreatedAfter": number, "CreatedBefore": number, "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.

CreatedAfter

A filter that returns only experiments created after the specified time.

Type: Timestamp

Required: No

CreatedBefore

A filter that returns only experiments created before the specified time.

Type: Timestamp

Required: No

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: 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": [ { "CreationTime": number, "DisplayName": "string", "ExperimentArn": "string", "ExperimentName": "string", "ExperimentSource": { "SourceArn": "string", "SourceType": "string" }, "LastModifiedTime": number } ], "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: Maximum length of 8192.

Pattern: .*

Errors

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

See Also

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