listAlgorithms method

Future<ListAlgorithmsOutput> listAlgorithms({ DateTime? creationTimeAfter, DateTime? creationTimeBefore, int? maxResults, String? nameContains, String? nextToken, AlgorithmSortBy? sortBy, SortOrder? sortOrder, })

Lists the machine learning algorithms that have been created.

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

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

Parameter maxResults : The maximum number of algorithms to return in the response.

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

Parameter 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.

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

Parameter sortOrder : The sort order for the results. The default is Ascending.

Implementation

Future<ListAlgorithmsOutput> listAlgorithms({
  DateTime? creationTimeAfter,
  DateTime? creationTimeBefore,
  int? maxResults,
  String? nameContains,
  String? nextToken,
  AlgorithmSortBy? sortBy,
  SortOrder? sortOrder,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  _s.validateStringLength(
    'nameContains',
    nameContains,
    0,
    63,
  );
  _s.validateStringLength(
    'nextToken',
    nextToken,
    0,
    8192,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'SageMaker.ListAlgorithms'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (creationTimeAfter != null)
        'CreationTimeAfter': unixTimestampToJson(creationTimeAfter),
      if (creationTimeBefore != null)
        'CreationTimeBefore': unixTimestampToJson(creationTimeBefore),
      if (maxResults != null) 'MaxResults': maxResults,
      if (nameContains != null) 'NameContains': nameContains,
      if (nextToken != null) 'NextToken': nextToken,
      if (sortBy != null) 'SortBy': sortBy.toValue(),
      if (sortOrder != null) 'SortOrder': sortOrder.toValue(),
    },
  );

  return ListAlgorithmsOutput.fromJson(jsonResponse.body);
}