Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.MachineLearning.CreateBatchPrediction

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

data CreateBatchPrediction = CreateBatchPrediction' {
- batchPredictionName :: Maybe Text
- batchPredictionId :: Text
- mLModelId :: Text
- batchPredictionDataSourceId :: Text
- outputUri :: Text
}
newCreateBatchPrediction :: Text -> Text -> Text -> Text -> CreateBatchPrediction
createBatchPrediction_batchPredictionName :: Lens' CreateBatchPrediction (Maybe Text)
createBatchPrediction_batchPredictionId :: Lens' CreateBatchPrediction Text
createBatchPrediction_mLModelId :: Lens' CreateBatchPrediction Text
createBatchPrediction_batchPredictionDataSourceId :: Lens' CreateBatchPrediction Text
createBatchPrediction_outputUri :: Lens' CreateBatchPrediction Text
data CreateBatchPredictionResponse = CreateBatchPredictionResponse' {
- batchPredictionId :: Maybe Text
- httpStatus :: Int
}
newCreateBatchPredictionResponse :: Int -> CreateBatchPredictionResponse
createBatchPredictionResponse_batchPredictionId :: Lens' CreateBatchPredictionResponse (Maybe Text)
createBatchPredictionResponse_httpStatus :: Lens' CreateBatchPredictionResponse Int

Creating a Request

data CreateBatchPrediction Source #

See: newCreateBatchPrediction smart constructor.

Constructors

CreateBatchPrediction'

Fields

batchPredictionName :: Maybe Text
A user-supplied name or description of the BatchPrediction. BatchPredictionName can only use the UTF-8 character set.
batchPredictionId :: Text
A user-supplied ID that uniquely identifies the BatchPrediction.
mLModelId :: Text
The ID of the MLModel that will generate predictions for the group of observations.
batchPredictionDataSourceId :: Text
The ID of the DataSource that points to the group of observations to predict.
outputUri :: Text
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.

Instances

Instances details

Eq CreateBatchPrediction Source #
Instance details Defined in Amazonka.MachineLearning.CreateBatchPrediction Methods (==) :: CreateBatchPrediction -> CreateBatchPrediction -> Bool # (/=) :: CreateBatchPrediction -> CreateBatchPrediction -> Bool #
Read CreateBatchPrediction Source #
Instance details Defined in Amazonka.MachineLearning.CreateBatchPrediction Methods readsPrec :: Int -> ReadS CreateBatchPrediction # readList :: ReadS [CreateBatchPrediction] # readPrec :: ReadPrec CreateBatchPrediction # readListPrec :: ReadPrec [CreateBatchPrediction] #
Show CreateBatchPrediction Source #
Instance details Defined in Amazonka.MachineLearning.CreateBatchPrediction Methods showsPrec :: Int -> CreateBatchPrediction -> ShowS # show :: CreateBatchPrediction -> String # showList :: [CreateBatchPrediction] -> ShowS #
Generic CreateBatchPrediction Source #
Instance details Defined in Amazonka.MachineLearning.CreateBatchPrediction Associated Types type Rep CreateBatchPrediction :: Type -> Type # Methods from :: CreateBatchPrediction -> Rep CreateBatchPrediction x # to :: Rep CreateBatchPrediction x -> CreateBatchPrediction #
NFData CreateBatchPrediction Source #
Instance details Defined in Amazonka.MachineLearning.CreateBatchPrediction Methods rnf :: CreateBatchPrediction -> () #
Hashable CreateBatchPrediction Source #
Instance details Defined in Amazonka.MachineLearning.CreateBatchPrediction Methods hashWithSalt :: Int -> CreateBatchPrediction -> Int # hash :: CreateBatchPrediction -> Int #
ToJSON CreateBatchPrediction Source #
Instance details Defined in Amazonka.MachineLearning.CreateBatchPrediction Methods toJSON :: CreateBatchPrediction -> Value # toEncoding :: CreateBatchPrediction -> Encoding # toJSONList :: [CreateBatchPrediction] -> Value # toEncodingList :: [CreateBatchPrediction] -> Encoding #
AWSRequest CreateBatchPrediction Source #
Instance details Defined in Amazonka.MachineLearning.CreateBatchPrediction Associated Types type AWSResponse CreateBatchPrediction # Methods request :: CreateBatchPrediction -> Request CreateBatchPrediction # response :: MonadResource m => Logger -> Service -> Proxy CreateBatchPrediction -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateBatchPrediction))) #
ToHeaders CreateBatchPrediction Source #
Instance details Defined in Amazonka.MachineLearning.CreateBatchPrediction Methods toHeaders :: CreateBatchPrediction -> [Header] #
ToPath CreateBatchPrediction Source #
Instance details Defined in Amazonka.MachineLearning.CreateBatchPrediction Methods toPath :: CreateBatchPrediction -> ByteString #
ToQuery CreateBatchPrediction Source #
Instance details Defined in Amazonka.MachineLearning.CreateBatchPrediction Methods toQuery :: CreateBatchPrediction -> QueryString #
type Rep CreateBatchPrediction Source #
Instance details Defined in Amazonka.MachineLearning.CreateBatchPrediction type Rep CreateBatchPrediction = D1 ('MetaData "CreateBatchPrediction" "Amazonka.MachineLearning.CreateBatchPrediction" "libZSservicesZSamazonka-mlZSamazonka-ml" 'False) (C1 ('MetaCons "CreateBatchPrediction'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "batchPredictionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "batchPredictionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "mLModelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "batchPredictionDataSourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "outputUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateBatchPrediction Source #
Instance details Defined in Amazonka.MachineLearning.CreateBatchPrediction type AWSResponse CreateBatchPrediction = CreateBatchPredictionResponse

newCreateBatchPrediction Source #

Arguments

:: Text	`$sel:batchPredictionId:CreateBatchPrediction'`
-> Text	`$sel:mLModelId:CreateBatchPrediction'`
-> Text	`$sel:batchPredictionDataSourceId:CreateBatchPrediction'`
-> Text	`$sel:outputUri:CreateBatchPrediction'`
-> CreateBatchPrediction

Create a value of CreateBatchPrediction with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:batchPredictionName:CreateBatchPrediction', createBatchPrediction_batchPredictionName - A user-supplied name or description of the BatchPrediction. BatchPredictionName can only use the UTF-8 character set.

$sel:batchPredictionId:CreateBatchPrediction', createBatchPrediction_batchPredictionId - A user-supplied ID that uniquely identifies the BatchPrediction.

$sel:mLModelId:CreateBatchPrediction', createBatchPrediction_mLModelId - The ID of the MLModel that will generate predictions for the group of observations.

$sel:batchPredictionDataSourceId:CreateBatchPrediction', createBatchPrediction_batchPredictionDataSourceId - The ID of the DataSource that points to the group of observations to predict.

$sel:outputUri:CreateBatchPrediction', createBatchPrediction_outputUri - 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.

Request Lenses

createBatchPrediction_batchPredictionName :: Lens' CreateBatchPrediction (Maybe Text) Source #

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

createBatchPrediction_batchPredictionId :: Lens' CreateBatchPrediction Text Source #

A user-supplied ID that uniquely identifies the BatchPrediction.

createBatchPrediction_mLModelId :: Lens' CreateBatchPrediction Text Source #

The ID of the MLModel that will generate predictions for the group of observations.

createBatchPrediction_batchPredictionDataSourceId :: Lens' CreateBatchPrediction Text Source #

The ID of the DataSource that points to the group of observations to predict.

createBatchPrediction_outputUri :: 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

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: newCreateBatchPredictionResponse smart constructor.

Constructors

CreateBatchPredictionResponse'
Fields batchPredictionId :: Maybe Text A user-supplied ID that uniquely identifies the `BatchPrediction`. This value is identical to the value of the `BatchPredictionId` in the request. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateBatchPredictionResponse Source #
Instance details Defined in Amazonka.MachineLearning.CreateBatchPrediction Methods (==) :: CreateBatchPredictionResponse -> CreateBatchPredictionResponse -> Bool # (/=) :: CreateBatchPredictionResponse -> CreateBatchPredictionResponse -> Bool #
Read CreateBatchPredictionResponse Source #
Instance details Defined in Amazonka.MachineLearning.CreateBatchPrediction Methods readsPrec :: Int -> ReadS CreateBatchPredictionResponse # readList :: ReadS [CreateBatchPredictionResponse] # readPrec :: ReadPrec CreateBatchPredictionResponse # readListPrec :: ReadPrec [CreateBatchPredictionResponse] #
Show CreateBatchPredictionResponse Source #
Instance details Defined in Amazonka.MachineLearning.CreateBatchPrediction Methods showsPrec :: Int -> CreateBatchPredictionResponse -> ShowS # show :: CreateBatchPredictionResponse -> String # showList :: [CreateBatchPredictionResponse] -> ShowS #
Generic CreateBatchPredictionResponse Source #
Instance details Defined in Amazonka.MachineLearning.CreateBatchPrediction Associated Types type Rep CreateBatchPredictionResponse :: Type -> Type # Methods from :: CreateBatchPredictionResponse -> Rep CreateBatchPredictionResponse x # to :: Rep CreateBatchPredictionResponse x -> CreateBatchPredictionResponse #
NFData CreateBatchPredictionResponse Source #
Instance details Defined in Amazonka.MachineLearning.CreateBatchPrediction Methods rnf :: CreateBatchPredictionResponse -> () #
type Rep CreateBatchPredictionResponse Source #
Instance details Defined in Amazonka.MachineLearning.CreateBatchPrediction type Rep CreateBatchPredictionResponse = D1 ('MetaData "CreateBatchPredictionResponse" "Amazonka.MachineLearning.CreateBatchPrediction" "libZSservicesZSamazonka-mlZSamazonka-ml" 'False) (C1 ('MetaCons "CreateBatchPredictionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "batchPredictionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateBatchPredictionResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateBatchPredictionResponse'`
-> CreateBatchPredictionResponse

Create a value of CreateBatchPredictionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:batchPredictionId:CreateBatchPrediction', createBatchPredictionResponse_batchPredictionId - A user-supplied ID that uniquely identifies the BatchPrediction. This value is identical to the value of the BatchPredictionId in the request.

$sel:httpStatus:CreateBatchPredictionResponse', createBatchPredictionResponse_httpStatus - The response's http status code.

Response Lenses

createBatchPredictionResponse_batchPredictionId :: 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.

createBatchPredictionResponse_httpStatus :: Lens' CreateBatchPredictionResponse Int Source #

The response's http status code.