Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1428150188.6 KB

Returns a <code>BatchPrediction</code> that includes detailed metadata, status, and data file information for a <code>Batch Prediction</code> request.

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

Headers

X-Amz-Target'AmazonML_20141212.GetBatchPrediction' required

Request body

BatchPredictionIdstring required

An ID assigned to the <code>BatchPrediction</code> at creation.

Response

Success

BatchPredictionIdstring

An ID assigned to the <code>BatchPrediction</code> at creation. This value should be identical to the value of the <code>BatchPredictionID</code> in the request.

MLModelIdstring

The ID of the <code>MLModel</code> that generated predictions for the <code>BatchPrediction</code> request.

BatchPredictionDataSourceIdstring

The ID of the <code>DataSource</code> that was used to create the <code>BatchPrediction</code>.

InputDataLocationS3string

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

CreatedByIamUserstring

The AWS user account that invoked the <code>BatchPrediction</code>. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

CreatedAtstring date-time

The time when the <code>BatchPrediction</code> was created. The time is expressed in epoch time.

LastUpdatedAtstring date-time

The time of the most recent edit to <code>BatchPrediction</code>. The time is expressed in epoch time.

Namestring

A user-supplied name or description of the <code>BatchPrediction</code>.

Status'PENDING' | 'INPROGRESS' | 'FAILED' | 'COMPLETED' | 'DELETED'
<p>The status of the <code>BatchPrediction</code>, which can be one of the following values:</p> <ul> <li> <p> <code>PENDING</code> - Amazon Machine Learning (Amazon ML) submitted a request to generate batch predictions.</p> </li> <li> <p> <code>INPROGRESS</code> - The batch predictions are in progress.</p> </li> <li> <p> <code>FAILED</code> - The request to perform a batch prediction did not run to completion. It is not usable.</p> </li> <li> <p> <code>COMPLETED</code> - The batch prediction process completed successfully.</p> </li> <li> <p> <code>DELETED</code> - The <code>BatchPrediction</code> is marked as deleted. It is not usable.</p> </li> </ul>
OutputUristring

The location of an Amazon S3 bucket or directory to receive the operation results.

LogUristring

A link to the file that contains logs of the <code>CreateBatchPrediction</code> operation.

Messagestring

A description of the most recent details about processing the batch prediction request.

ComputeTimeinteger

The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the <code>BatchPrediction</code>, normalized and scaled on computation resources. <code>ComputeTime</code> is only available if the <code>BatchPrediction</code> is in the <code>COMPLETED</code> state.

FinishedAtstring date-time

The epoch time when Amazon Machine Learning marked the <code>BatchPrediction</code> as <code>COMPLETED</code> or <code>FAILED</code>. <code>FinishedAt</code> is only available when the <code>BatchPrediction</code> is in the <code>COMPLETED</code> or <code>FAILED</code> state.

StartedAtstring date-time

The epoch time when Amazon Machine Learning marked the <code>BatchPrediction</code> as <code>INPROGRESS</code>. <code>StartedAt</code> isn't available if the <code>BatchPrediction</code> is in the <code>PENDING</code> state.

TotalRecordCountinteger

The number of total records that Amazon Machine Learning saw while processing the <code>BatchPrediction</code>.

InvalidRecordCountinteger

The number of invalid records that Amazon Machine Learning saw while processing the <code>BatchPrediction</code>.