Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListAlgorithms

Lists the machine learning algorithms that have been created.

Request Syntax


{
   "CreationTimeAfter": number,
   "CreationTimeBefore": number,
   "MaxResults": number,
   "NameContains": "string",
   "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.

CreationTimeAfter

A filter that returns only algorithms created after the specified time (timestamp).

Type: Timestamp

Required: No

CreationTimeBefore

A filter that returns only algorithms created before the specified time (timestamp).

Type: Timestamp

Required: No

MaxResults

The maximum number of algorithms to return in the response.

Type: Integer

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

Required: No

NameContains

A string in the algorithm name. This filter returns only algorithms whose name contains the specified string.

Type: String

Length Constraints: Maximum length of 63.

Pattern: [a-zA-Z0-9\-]+

Required: No

NextToken

If the response to a previous ListAlgorithms request was truncated, the response includes a NextToken. To retrieve the next set of algorithms, use the token in the next request.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Required: No

SortBy

The parameter by which to sort the results. The default is CreationTime.

Type: String

Valid Values: Name | CreationTime

Required: No

SortOrder

The sort order for the results. The default is Ascending.

Type: String

Valid Values: Ascending | Descending

Required: No

Response Syntax


{
   "AlgorithmSummaryList": [ 
      { 
         "AlgorithmArn": "string",
         "AlgorithmDescription": "string",
         "AlgorithmName": "string",
         "AlgorithmStatus": "string",
         "CreationTime": 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.

AlgorithmSummaryList

>An array of AlgorithmSummary objects, each of which lists an algorithm.

Type: Array of AlgorithmSummary objects

NextToken

If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Errors

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