Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1428150188.6 KB

Generates predictions for a group of observations. The observations to process exist in one or more data files referenced by a DataSource. This operation creates a new BatchPrediction, and uses an MLModel and the data files referenced by the DataSource as information sources.

CreateBatchPrediction is an asynchronous operation. In response to CreateBatchPrediction, Amazon Machine Learning (Amazon ML) immediately returns and sets the BatchPrediction status to PENDING. After the BatchPrediction completes, Amazon ML sets the status to COMPLETED.

You can poll for status updates by using the GetBatchPrediction operation and checking the Status parameter of the result. After the COMPLETED status appears, the results are available in the location specified by the OutputUri parameter.

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

Headers

X-Amz-Target'AmazonML_20141212.CreateBatchPrediction' required

Request body

BatchPredictionIdstring required

A user-supplied ID that uniquely identifies the <code>BatchPrediction</code>.

BatchPredictionNamestring

A user-supplied name or description of the <code>BatchPrediction</code>. <code>BatchPredictionName</code> can only use the UTF-8 character set.

MLModelIdstring required

The ID of the <code>MLModel</code> that will generate predictions for the group of observations.

BatchPredictionDataSourceIdstring required

The ID of the <code>DataSource</code> that points to the group of observations to predict.

OutputUristring required
<p>The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the <code>s3 key</code> portion of the <code>outputURI</code> field: ':', '//', '/./', '/../'.</p> <p>Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the <a href="https://docs.aws.amazon.com/machine-learning/latest/dg">Amazon Machine Learning Developer Guide</a>.</p>

Response

Success

BatchPredictionIdstring

A user-supplied ID that uniquely identifies the <code>BatchPrediction</code>. This value is identical to the value of the <code>BatchPredictionId</code> in the request.