Skip to content

/AWS1/CL_ML=>DESCRIBEBATCHPREDICTIONS()

About DescribeBatchPredictions

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

Method Signature

IMPORTING

Optional arguments:

IV_FILTERVARIABLE TYPE /AWS1/ML_BTCPREDICTIONFILTVA00 /AWS1/ML_BTCPREDICTIONFILTVA00

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.

IV_EQ TYPE /AWS1/ML_COMPARATORVALUE /AWS1/ML_COMPARATORVALUE

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

IV_GT TYPE /AWS1/ML_COMPARATORVALUE /AWS1/ML_COMPARATORVALUE

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

IV_LT TYPE /AWS1/ML_COMPARATORVALUE /AWS1/ML_COMPARATORVALUE

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

IV_GE TYPE /AWS1/ML_COMPARATORVALUE /AWS1/ML_COMPARATORVALUE

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.

IV_LE TYPE /AWS1/ML_COMPARATORVALUE /AWS1/ML_COMPARATORVALUE

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.

IV_NE TYPE /AWS1/ML_COMPARATORVALUE /AWS1/ML_COMPARATORVALUE

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

IV_PREFIX TYPE /AWS1/ML_COMPARATORVALUE /AWS1/ML_COMPARATORVALUE

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

IV_SORTORDER TYPE /AWS1/ML_SORTORDER /AWS1/ML_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.

IV_NEXTTOKEN TYPE /AWS1/ML_STRINGTYPE /AWS1/ML_STRINGTYPE

An ID of the page in the paginated results.

IV_LIMIT TYPE /AWS1/ML_PAGELIMIT /AWS1/ML_PAGELIMIT

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.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_ML_DSCBTCPREDICTION01 /AWS1/CL_ML_DSCBTCPREDICTION01