listRetrainingSchedulers method

Future<ListRetrainingSchedulersResponse> listRetrainingSchedulers({
  1. int? maxResults,
  2. String? modelNameBeginsWith,
  3. String? nextToken,
  4. RetrainingSchedulerStatus? status,
})

Lists all retraining schedulers in your account, filtering by model name prefix and status.

May throw AccessDeniedException. May throw InternalServerException. May throw ThrottlingException. May throw ValidationException.

Parameter maxResults : Specifies the maximum number of retraining schedulers to list.

Parameter modelNameBeginsWith : Specify this field to only list retraining schedulers whose machine learning models begin with the value you specify.

Parameter nextToken : If the number of results exceeds the maximum, a pagination token is returned. Use the token in the request to show the next page of retraining schedulers.

Parameter status : Specify this field to only list retraining schedulers whose status matches the value you specify.

Implementation

Future<ListRetrainingSchedulersResponse> listRetrainingSchedulers({
  int? maxResults,
  String? modelNameBeginsWith,
  String? nextToken,
  RetrainingSchedulerStatus? status,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    500,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.0',
    'X-Amz-Target':
        'AWSLookoutEquipmentFrontendService.ListRetrainingSchedulers'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (maxResults != null) 'MaxResults': maxResults,
      if (modelNameBeginsWith != null)
        'ModelNameBeginsWith': modelNameBeginsWith,
      if (nextToken != null) 'NextToken': nextToken,
      if (status != null) 'Status': status.value,
    },
  );

  return ListRetrainingSchedulersResponse.fromJson(jsonResponse.body);
}