describeBatchPredictions method

Future<DescribeBatchPredictionsOutput> describeBatchPredictions({ String? eq, BatchPredictionFilterVariable? filterVariable, String? ge, String? gt, String? le, String? lt, int? limit, String? ne, String? nextToken, String? prefix, SortOrder? sortOrder, })

Returns a list of BatchPrediction operations that match the search criteria in the request.

May throw InvalidInputException. May throw InternalServerException.

Parameter eq : The equal to operator. The BatchPrediction results will have FilterVariable values that exactly match the value specified with EQ.

Parameter filterVariable : Use one of the following variables to filter a list of BatchPrediction:

• CreatedAt - Sets the search criteria to the BatchPrediction creation date.
• Status - Sets the search criteria to the BatchPrediction status.
• Name - Sets the search criteria to the contents of the BatchPrediction Name.
• IAMUser - Sets the search criteria to the user account that invoked the BatchPrediction creation.
• MLModelId - Sets the search criteria to the MLModel used in the BatchPrediction.
• DataSourceId - Sets the search criteria to the DataSource used in the BatchPrediction.
• DataURI - Sets the search criteria to the data file(s) used in the BatchPrediction. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.

Parameter ge : The greater than or equal to operator. The BatchPrediction results will have FilterVariable values that are greater than or equal to the value specified with GE.

Parameter gt : The greater than operator. The BatchPrediction results will have FilterVariable values that are greater than the value specified with GT.

Parameter le : The less than or equal to operator. The BatchPrediction results will have FilterVariable values that are less than or equal to the value specified with LE.

Parameter lt : The less than operator. The BatchPrediction results will have FilterVariable values that are less than the value specified with LT.

Parameter limit : The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.

Parameter ne : The not equal to operator. The BatchPrediction results will have FilterVariable values not equal to the value specified with NE.

Parameter nextToken : An ID of the page in the paginated results.

Parameter prefix : A string that is found at the beginning of a variable, such as Name or Id.

For example, a Batch Prediction operation could have the Name 2014-09-09-HolidayGiftMailer. To search for this BatchPrediction, select Name for the FilterVariable and any of the following strings for the Prefix:

• 2014-09
• 2014-09-09
• 2014-09-09-Holiday

Parameter sortOrder : A two-value parameter that determines the sequence of the resulting list of MLModels.

• asc - Arranges the list in ascending order (A-Z, 0-9).
• dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

Implementation

Future<DescribeBatchPredictionsOutput> describeBatchPredictions({
  String? eq,
  BatchPredictionFilterVariable? filterVariable,
  String? ge,
  String? gt,
  String? le,
  String? lt,
  int? limit,
  String? ne,
  String? nextToken,
  String? prefix,
  SortOrder? sortOrder,
}) async {
  _s.validateStringLength(
    'eq',
    eq,
    0,
    1024,
  );
  _s.validateStringLength(
    'ge',
    ge,
    0,
    1024,
  );
  _s.validateStringLength(
    'gt',
    gt,
    0,
    1024,
  );
  _s.validateStringLength(
    'le',
    le,
    0,
    1024,
  );
  _s.validateStringLength(
    'lt',
    lt,
    0,
    1024,
  );
  _s.validateNumRange(
    'limit',
    limit,
    1,
    100,
  );
  _s.validateStringLength(
    'ne',
    ne,
    0,
    1024,
  );
  _s.validateStringLength(
    'prefix',
    prefix,
    0,
    1024,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AmazonML_20141212.DescribeBatchPredictions'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (eq != null) 'EQ': eq,
      if (filterVariable != null) 'FilterVariable': filterVariable.toValue(),
      if (ge != null) 'GE': ge,
      if (gt != null) 'GT': gt,
      if (le != null) 'LE': le,
      if (lt != null) 'LT': lt,
      if (limit != null) 'Limit': limit,
      if (ne != null) 'NE': ne,
      if (nextToken != null) 'NextToken': nextToken,
      if (prefix != null) 'Prefix': prefix,
      if (sortOrder != null) 'SortOrder': sortOrder.toValue(),
    },
  );

  return DescribeBatchPredictionsOutput.fromJson(jsonResponse.body);
}