listInferenceRecommendationsJobs method

Future<ListInferenceRecommendationsJobsResponse> listInferenceRecommendationsJobs({ DateTime? creationTimeAfter, DateTime? creationTimeBefore, DateTime? lastModifiedTimeAfter, DateTime? lastModifiedTimeBefore, int? maxResults, String? modelNameEquals, String? modelPackageVersionArnEquals, String? nameContains, String? nextToken, ListInferenceRecommendationsJobsSortBy? sortBy, SortOrder? sortOrder, RecommendationJobStatus? statusEquals, })

Lists recommendation jobs that satisfy various filters.

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

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

Parameter lastModifiedTimeAfter : A filter that returns only jobs that were last modified after the specified time (timestamp).

Parameter lastModifiedTimeBefore : A filter that returns only jobs that were last modified before the specified time (timestamp).

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

Parameter modelNameEquals : A filter that returns only jobs that were created for this model.

Parameter modelPackageVersionArnEquals : A filter that returns only jobs that were created for this versioned model package.

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

Parameter nextToken : If the response to a previous ListInferenceRecommendationsJobsRequest request was truncated, the response includes a NextToken. To retrieve the next set of recommendations, use the token in the next request.

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

Parameter sortOrder : The sort order for the results.

Parameter statusEquals : A filter that retrieves only inference recommendations jobs with a specific status.

Implementation

Future<ListInferenceRecommendationsJobsResponse>
    listInferenceRecommendationsJobs({
  DateTime? creationTimeAfter,
  DateTime? creationTimeBefore,
  DateTime? lastModifiedTimeAfter,
  DateTime? lastModifiedTimeBefore,
  int? maxResults,
  String? modelNameEquals,
  String? modelPackageVersionArnEquals,
  String? nameContains,
  String? nextToken,
  ListInferenceRecommendationsJobsSortBy? sortBy,
  SortOrder? sortOrder,
  RecommendationJobStatus? statusEquals,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'SageMaker.ListInferenceRecommendationsJobs'
  };
  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 (lastModifiedTimeAfter != null)
        'LastModifiedTimeAfter': unixTimestampToJson(lastModifiedTimeAfter),
      if (lastModifiedTimeBefore != null)
        'LastModifiedTimeBefore': unixTimestampToJson(lastModifiedTimeBefore),
      if (maxResults != null) 'MaxResults': maxResults,
      if (modelNameEquals != null) 'ModelNameEquals': modelNameEquals,
      if (modelPackageVersionArnEquals != null)
        'ModelPackageVersionArnEquals': modelPackageVersionArnEquals,
      if (nameContains != null) 'NameContains': nameContains,
      if (nextToken != null) 'NextToken': nextToken,
      if (sortBy != null) 'SortBy': sortBy.value,
      if (sortOrder != null) 'SortOrder': sortOrder.value,
      if (statusEquals != null) 'StatusEquals': statusEquals.value,
    },
  );

  return ListInferenceRecommendationsJobsResponse.fromJson(jsonResponse.body);
}