ListTrialComponents - Amazon SageMaker Service

ListTrialComponents

Lists the trial components in your account. You can sort the list by trial component name or creation time. You can filter the list to show only components that were created in a specific time range. You can also filter on one of the following:

  • ExperimentName

  • SourceArn

  • TrialName

Request Syntax

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

Type: Timestamp

Required: No

CreatedBefore

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

Type: Timestamp

Required: No

ExperimentName

A filter that returns only components that are part of the specified experiment. If you specify ExperimentName, you can't filter by SourceArn or TrialName.

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 components 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 ListTrialComponents didn't return the full set of components, the call returns a token for getting the next set of components.

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

SourceArn

A filter that returns only components that have the specified source Amazon Resource Name (ARN). If you specify SourceArn, you can't filter by ExperimentName or TrialName.

Type: String

Length Constraints: Maximum length of 256.

Required: No

TrialName

A filter that returns only components that are part of the specified trial. If you specify TrialName, you can't filter by ExperimentName or SourceArn.

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", "TrialComponentSummaries": [ { "CreatedBy": { "DomainId": "string", "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "DisplayName": "string", "EndTime": number, "LastModifiedBy": { "DomainId": "string", "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "StartTime": number, "Status": { "Message": "string", "PrimaryStatus": "string" }, "TrialComponentArn": "string", "TrialComponentName": "string", "TrialComponentSource": { "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 components, if there are any.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

TrialComponentSummaries

A list of the summaries of your trial components.

Type: Array of TrialComponentSummary 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: