Menu
Amazon Machine Learning
API Reference (API Version 2014-12-12)

DescribeBatchPredictions

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

Request Syntax

{
   "EQ": "string",
   "FilterVariable": "string",
   "GE": "string",
   "GT": "string",
   "LE": "string",
   "Limit": number,
   "LT": "string",
   "NE": "string",
   "NextToken": "string",
   "Prefix": "string",
   "SortOrder": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

EQ

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

Type: String

Length Constraints: Maximum length of 1024.

Pattern: .*\S.*|^$

Required: No

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.

Type: String

Valid Values: CreatedAt | LastUpdatedAt | Status | Name | IAMUser | MLModelId | DataSourceId | DataURI

Required: No

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.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: .*\S.*|^$

Required: No

GT

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

Type: String

Length Constraints: Maximum length of 1024.

Pattern: .*\S.*|^$

Required: No

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.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: .*\S.*|^$

Required: No

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

LT

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

Type: String

Length Constraints: Maximum length of 1024.

Pattern: .*\S.*|^$

Required: No

NE

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

Type: String

Length Constraints: Maximum length of 1024.

Pattern: .*\S.*|^$

Required: No

NextToken

An ID of the page in the paginated results.

Type: String

Required: No

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

Type: String

Length Constraints: Maximum length of 1024.

Pattern: .*\S.*|^$

Required: No

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.

Type: String

Valid Values: asc | dsc

Required: No

Response Syntax

{
   "NextToken": "string",
   "Results": [ 
      { 
         "BatchPredictionDataSourceId": "string",
         "BatchPredictionId": "string",
         "ComputeTime": number,
         "CreatedAt": number,
         "CreatedByIamUser": "string",
         "FinishedAt": number,
         "InputDataLocationS3": "string",
         "InvalidRecordCount": number,
         "LastUpdatedAt": number,
         "Message": "string",
         "MLModelId": "string",
         "Name": "string",
         "OutputUri": "string",
         "StartedAt": number,
         "Status": "string",
         "TotalRecordCount": number
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

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

Type: String

Results

A list of BatchPrediction objects that meet the search criteria.

Type: Array of BatchPrediction objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

An error on the server occurred when trying to process a request.

HTTP Status Code: 500

InvalidInputException

An error on the client occurred. Typically, the cause is an invalid input value.

HTTP Status Code: 400

Example

The following is a sample request and response of the DescribeBatchPredictions operation.

Sample Request

POST / HTTP/1.1
Host: machinelearning.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=contenttype;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid,Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
X-Amz-Target: AmazonML_20141212.DescribeBatchPredictions
{
  "FilterVariable": "Name",
  "Prefix": "bp-",
  "SortOrder": "asc",
  "Limit": 1
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
{
  "Results": [
    {
      "BatchPredictionDataSourceId": "ds-exampleDataSourceId", 
      "BatchPredictionId": "bp-exampleBatchPredictionId", 
      "CreatedAt": 1422057670.697, 
      "CreatedByIamUser": "arn:aws:iam::<awsAccountId>:user/username", 
      "InputDataLocationS3": "s3://bucket/locationToInput/example-data.testing.csv", 
      "LastUpdatedAt": 1422057811.431, 
      "MLModelId": "pr-exampleModelId", 
      "Name": "bp-exampleBatchPredictionName", 
      "OutputUri": "s3://bucket/locationToLogs/", 
      "Status": "COMPLETED",
      "ComputeTime":"185200",
      "FinishedAt":"1422057711.192",
      "StartedAt":"14220557678.324",
      "TotalRecordCount":"21154",
      "InvalidRecordCount":"0"
    }
  ]
}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: