listModelExplainabilityJobDefinitions method

Future<ListModelExplainabilityJobDefinitionsResponse> listModelExplainabilityJobDefinitions({ DateTime? creationTimeAfter, DateTime? creationTimeBefore, String? endpointName, int? maxResults, String? nameContains, String? nextToken, MonitoringJobDefinitionSortKey? sortBy, SortOrder? sortOrder, })

Lists model explainability job definitions that satisfy various filters.

Parameter creationTimeAfter : A filter that returns only model explainability jobs created after a specified time.

Parameter creationTimeBefore : A filter that returns only model explainability jobs created before a specified time.

Parameter endpointName : Name of the endpoint to monitor for model explainability.

Parameter maxResults : The maximum number of jobs to return in the response. The default value is 10.

Parameter nameContains : Filter for model explainability jobs whose name contains a specified string.

Parameter nextToken : The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

Parameter sortBy : Whether to sort results by the Name or CreationTime field. The default is CreationTime.

Parameter sortOrder : Whether to sort the results in Ascending or Descending order. The default is Descending.

Implementation

Future<ListModelExplainabilityJobDefinitionsResponse>
    listModelExplainabilityJobDefinitions({
  DateTime? creationTimeAfter,
  DateTime? creationTimeBefore,
  String? endpointName,
  int? maxResults,
  String? nameContains,
  String? nextToken,
  MonitoringJobDefinitionSortKey? sortBy,
  SortOrder? sortOrder,
}) async {
  _s.validateStringLength(
    'endpointName',
    endpointName,
    0,
    63,
  );
  _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.ListModelExplainabilityJobDefinitions'
  };
  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 (endpointName != null) 'EndpointName': endpointName,
      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 ListModelExplainabilityJobDefinitionsResponse.fromJson(
      jsonResponse.body);
}