listCompilationJobs method

Future<ListCompilationJobsResponse> listCompilationJobs({ DateTime? creationTimeAfter, DateTime? creationTimeBefore, DateTime? lastModifiedTimeAfter, DateTime? lastModifiedTimeBefore, int? maxResults, String? nameContains, String? nextToken, ListCompilationJobsSortBy? sortBy, SortOrder? sortOrder, CompilationJobStatus? statusEquals, })

Lists model compilation jobs that satisfy various filters.

To create a model compilation job, use CreateCompilationJob. To get information about a particular model compilation job you have created, use DescribeCompilationJob.

Parameter creationTimeAfter : A filter that returns the model compilation jobs that were created after a specified time.

Parameter creationTimeBefore : A filter that returns the model compilation jobs that were created before a specified time.

Parameter lastModifiedTimeAfter : A filter that returns the model compilation jobs that were modified after a specified time.

Parameter lastModifiedTimeBefore : A filter that returns the model compilation jobs that were modified before a specified time.

Parameter maxResults : The maximum number of model compilation jobs to return in the response.

Parameter nameContains : A filter that returns the model compilation jobs whose name contains a specified string.

Parameter nextToken : If the result of the previous ListCompilationJobs request was truncated, the response includes a NextToken. To retrieve the next set of model compilation jobs, use the token in the next request.

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

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

Parameter statusEquals : A filter that retrieves model compilation jobs with a specific DescribeCompilationJobResponse$CompilationJobStatus status.

Implementation

Future<ListCompilationJobsResponse> listCompilationJobs({
  DateTime? creationTimeAfter,
  DateTime? creationTimeBefore,
  DateTime? lastModifiedTimeAfter,
  DateTime? lastModifiedTimeBefore,
  int? maxResults,
  String? nameContains,
  String? nextToken,
  ListCompilationJobsSortBy? sortBy,
  SortOrder? sortOrder,
  CompilationJobStatus? statusEquals,
}) 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.ListCompilationJobs'
  };
  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 (nameContains != null) 'NameContains': nameContains,
      if (nextToken != null) 'NextToken': nextToken,
      if (sortBy != null) 'SortBy': sortBy.toValue(),
      if (sortOrder != null) 'SortOrder': sortOrder.toValue(),
      if (statusEquals != null) 'StatusEquals': statusEquals.toValue(),
    },
  );

  return ListCompilationJobsResponse.fromJson(jsonResponse.body);
}