Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
See: AWS API Reference for CreateBatchPrediction.
- createBatchPrediction :: Text -> Text -> Text -> Text -> CreateBatchPrediction
- data CreateBatchPrediction
- cbpBatchPredictionName :: Lens' CreateBatchPrediction (Maybe Text)
- cbpBatchPredictionId :: Lens' CreateBatchPrediction Text
- cbpMLModelId :: Lens' CreateBatchPrediction Text
- cbpBatchPredictionDataSourceId :: Lens' CreateBatchPrediction Text
- cbpOutputURI :: Lens' CreateBatchPrediction Text
- createBatchPredictionResponse :: Int -> CreateBatchPredictionResponse
- data CreateBatchPredictionResponse
- cbprsBatchPredictionId :: Lens' CreateBatchPredictionResponse (Maybe Text)
- cbprsStatus :: Lens' CreateBatchPredictionResponse Int
Creating a Request
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> CreateBatchPrediction |
Creates a value of CreateBatchPrediction
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CreateBatchPrediction Source
See: createBatchPrediction
smart constructor.
Request Lenses
cbpBatchPredictionName :: Lens' CreateBatchPrediction (Maybe Text) Source
A user-supplied name or description of the BatchPrediction
.
BatchPredictionName
can only use the UTF-8 character set.
cbpBatchPredictionId :: Lens' CreateBatchPrediction Text Source
A user-supplied ID that uniquely identifies the BatchPrediction
.
cbpMLModelId :: Lens' CreateBatchPrediction Text Source
The ID of the MLModel
that will generate predictions for the group of
observations.
cbpBatchPredictionDataSourceId :: Lens' CreateBatchPrediction Text Source
The ID of the DataSource
that points to the group of observations to
predict.
cbpOutputURI :: Lens' CreateBatchPrediction Text Source
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 s3 key portion of the "outputURI" field: ':', '//', '/./', '/../'.
Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the Amazon Machine Learning Developer Guide.
Destructuring the Response
createBatchPredictionResponse Source
Creates a value of CreateBatchPredictionResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CreateBatchPredictionResponse Source
Represents the output of a CreateBatchPrediction operation, and is an acknowledgement that Amazon ML received the request.
The CreateBatchPrediction operation is asynchronous. You can poll for
status updates by using the GetBatchPrediction operation and checking
the Status
parameter of the result.
See: createBatchPredictionResponse
smart constructor.
Response Lenses
cbprsBatchPredictionId :: Lens' CreateBatchPredictionResponse (Maybe Text) Source
A user-supplied ID that uniquely identifies the BatchPrediction
. This
value is identical to the value of the BatchPredictionId
in the
request.
cbprsStatus :: Lens' CreateBatchPredictionResponse Int Source
The response status code.