Post x amz targetamazonml_20141212.describebatchpredictions

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1428150188.6 KB

Returns a list of <code>BatchPrediction</code> operations that match the search criteria in the request.

post/#X-Amz-Target=AmazonML_20141212.DescribeBatchPredictions

Query parameters

Limitstring

Pagination limit

NextTokenstring

Pagination token

Headers

X-Amz-Target'AmazonML_20141212.DescribeBatchPredictions' required

Request body

Use one of the following variables to filter a list of <code>BatchPrediction</code>: <ul> <li> <code>CreatedAt</code> - Sets the search criteria to the <code>BatchPrediction</code> creation date. </li> <li> <code>Status</code> - Sets the search criteria to the <code>BatchPrediction</code> status. </li> <li> <code>Name</code> - Sets the search criteria to the contents of the <code>BatchPrediction</code> <code>Name</code>. </li> <li> <code>IAMUser</code> - Sets the search criteria to the user account that invoked the <code>BatchPrediction</code> creation. </li> <li> <code>MLModelId</code> - Sets the search criteria to the <code>MLModel</code> used in the <code>BatchPrediction</code>. </li> <li> <code>DataSourceId</code> - Sets the search criteria to the <code>DataSource</code> used in the <code>BatchPrediction</code>. </li> <li> <code>DataURI</code> - Sets the search criteria to the data file(s) used in the <code>BatchPrediction</code>. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory. </li> </ul>

EQstring

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

GTstring

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

LTstring

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

GEstring

The greater than or equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>.

LEstring

The less than or equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>.

NEstring

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

Prefixstring

A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>. For example, a <code>Batch Prediction</code> operation could have the <code>Name</code> <code>2014-09-09-HolidayGiftMailer</code>. To search for this <code>BatchPrediction</code>, select <code>Name</code> for the <code>FilterVariable</code> and any of the following strings for the <code>Prefix</code>: <ul> <li> 2014-09 </li> <li> 2014-09-09 </li> <li> 2014-09-09-Holiday </li> </ul>

SortOrder'asc' | 'dsc'

A two-value parameter that determines the sequence of the resulting list of <code>MLModel</code>s. <ul> <li> <code>asc</code> - Arranges the list in ascending order (A-Z, 0-9). </li> <li> <code>dsc</code> - Arranges the list in descending order (Z-A, 9-0). </li> </ul> Results are sorted by <code>FilterVariable</code>.

NextTokenstring

An ID of the page in the paginated results.

Limitinteger

The number of pages of information to include in the result. The range of acceptable values is <code>1</code> through <code>100</code>. The default value is <code>100</code>.

Response

Success

NextTokenstring

The ID of the next page in the paginated results that indicates at least one more page follows.