ListTrials - Amazon SageMaker Service

ListTrials

Lists the trials in your account. Specify an experiment name to limit the list to the trials that are part of that experiment. Specify a trial component name to limit the list to the trials that associated with that trial component. The list can be filtered to show only trials that were created in a specific time range. The list can be sorted by trial name or creation time.

Request Syntax

{ "CreatedAfter": number, "CreatedBefore": number, "ExperimentName": "string", "MaxResults": number, "NextToken": "string", "SortBy": "string", "SortOrder": "string", "TrialComponentName": "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 trials created after the specified time.

Type: Timestamp

Required: No

CreatedBefore

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

Type: Timestamp

Required: No

ExperimentName

A filter that returns only trials that are part of the specified experiment.

Type: String

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

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

Required: No

MaxResults

The maximum number of trials 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 ListTrials didn't return the full set of trials, the call returns a token for getting the next set of trials.

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

TrialComponentName

A filter that returns only trials that are associated with the specified trial component.

Type: String

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

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

Required: No

Response Syntax

{ "NextToken": "string", "TrialSummaries": [ { "CreationTime": number, "DisplayName": "string", "LastModifiedTime": number, "TrialArn": "string", "TrialName": "string", "TrialSource": { "SourceArn": "string", "SourceType": "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.

NextToken

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

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

TrialSummaries

A list of the summaries of your trials.

Type: Array of TrialSummary objects

Errors

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

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400

See Also

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