Network.AWS.MachineLearning.CreateBatchPrediction

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.

Creating a Request

createBatchPrediction

Arguments

:: Text

cbpBatchPredictionId

-> Text

cbpMLModelId

-> Text

cbpBatchPredictionDataSourceId

-> Text

cbpOutputURI

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

• cbpBatchPredictionName - A user-supplied name or description of the BatchPrediction . BatchPredictionName can only use the UTF-8 character set.
• cbpBatchPredictionId - A user-supplied ID that uniquely identifies the BatchPrediction .
• cbpMLModelId - The ID of the MLModel that will generate predictions for the group of observations.
• cbpBatchPredictionDataSourceId - The ID of the DataSource that points to the group of observations to predict.
• cbpOutputURI - 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 .

data CreateBatchPrediction

See: createBatchPrediction smart constructor.

Instances

Eq CreateBatchPrediction

Methods

(==) :: CreateBatchPrediction -> CreateBatchPrediction -> Bool

(/=) :: CreateBatchPrediction -> CreateBatchPrediction -> Bool

Data CreateBatchPrediction

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateBatchPrediction -> c CreateBatchPrediction

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateBatchPrediction

toConstr :: CreateBatchPrediction -> Constr

dataTypeOf :: CreateBatchPrediction -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateBatchPrediction)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateBatchPrediction)

gmapT :: (forall b. Data b => b -> b) -> CreateBatchPrediction -> CreateBatchPrediction

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateBatchPrediction -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateBatchPrediction -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateBatchPrediction -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateBatchPrediction -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateBatchPrediction -> m CreateBatchPrediction

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateBatchPrediction -> m CreateBatchPrediction

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateBatchPrediction -> m CreateBatchPrediction

Read CreateBatchPrediction

Methods

readsPrec :: Int -> ReadS CreateBatchPrediction

readList :: ReadS [CreateBatchPrediction]

readPrec :: ReadPrec CreateBatchPrediction

readListPrec :: ReadPrec [CreateBatchPrediction]

Show CreateBatchPrediction

Methods

showsPrec :: Int -> CreateBatchPrediction -> ShowS

show :: CreateBatchPrediction -> String

showList :: [CreateBatchPrediction] -> ShowS

Generic CreateBatchPrediction

Associated Types

type Rep CreateBatchPrediction :: * -> *

Methods

from :: CreateBatchPrediction -> Rep CreateBatchPrediction x

to :: Rep CreateBatchPrediction x -> CreateBatchPrediction

Hashable CreateBatchPrediction

Methods

hashWithSalt :: Int -> CreateBatchPrediction -> Int

hash :: CreateBatchPrediction -> Int

ToJSON CreateBatchPrediction

Methods

toJSON :: CreateBatchPrediction -> Value

toEncoding :: CreateBatchPrediction -> Encoding

toJSONList :: [CreateBatchPrediction] -> Value

toEncodingList :: [CreateBatchPrediction] -> Encoding

NFData CreateBatchPrediction

Methods

rnf :: CreateBatchPrediction -> ()

AWSRequest CreateBatchPrediction

Associated Types

type Rs CreateBatchPrediction :: *

Methods

request :: CreateBatchPrediction -> Request CreateBatchPrediction

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * CreateBatchPrediction -> ClientResponse -> m (Response CreateBatchPrediction)

ToHeaders CreateBatchPrediction

Methods

toHeaders :: CreateBatchPrediction -> [Header]

ToPath CreateBatchPrediction

Methods

toPath :: CreateBatchPrediction -> ByteString

ToQuery CreateBatchPrediction

Methods

toQuery :: CreateBatchPrediction -> QueryString

type Rep CreateBatchPrediction

type Rep CreateBatchPrediction = D1 * (MetaData "CreateBatchPrediction" "Network.AWS.MachineLearning.CreateBatchPrediction" "amazonka-ml-1.6.0-Ieesuz5Kri8FW4cNPxVPkB" False) (C1 * (MetaCons "CreateBatchPrediction'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cbpBatchPredictionName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cbpBatchPredictionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cbpMLModelId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_cbpBatchPredictionDataSourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_cbpOutputURI") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

type Rs CreateBatchPrediction

type Rs CreateBatchPrediction = CreateBatchPredictionResponse

Request Lenses

cbpBatchPredictionName :: Lens' CreateBatchPrediction (Maybe Text)

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

cbpBatchPredictionId :: Lens' CreateBatchPrediction Text

A user-supplied ID that uniquely identifies the BatchPrediction .

cbpMLModelId :: Lens' CreateBatchPrediction Text

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

cbpBatchPredictionDataSourceId :: Lens' CreateBatchPrediction Text

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

cbpOutputURI :: Lens' CreateBatchPrediction 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 .

Destructuring the Response

createBatchPredictionResponse

Arguments

:: Int

cbprsResponseStatus

-> CreateBatchPredictionResponse

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:

• cbprsBatchPredictionId - A user-supplied ID that uniquely identifies the BatchPrediction . This value is identical to the value of the BatchPredictionId in the request.
• cbprsResponseStatus - -- | The response status code.

data CreateBatchPredictionResponse

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.

Instances

Eq CreateBatchPredictionResponse

Methods

(==) :: CreateBatchPredictionResponse -> CreateBatchPredictionResponse -> Bool

(/=) :: CreateBatchPredictionResponse -> CreateBatchPredictionResponse -> Bool

Data CreateBatchPredictionResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateBatchPredictionResponse -> c CreateBatchPredictionResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateBatchPredictionResponse

toConstr :: CreateBatchPredictionResponse -> Constr

dataTypeOf :: CreateBatchPredictionResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateBatchPredictionResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateBatchPredictionResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateBatchPredictionResponse -> CreateBatchPredictionResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateBatchPredictionResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateBatchPredictionResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateBatchPredictionResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateBatchPredictionResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateBatchPredictionResponse -> m CreateBatchPredictionResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateBatchPredictionResponse -> m CreateBatchPredictionResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateBatchPredictionResponse -> m CreateBatchPredictionResponse

Read CreateBatchPredictionResponse

Methods

readsPrec :: Int -> ReadS CreateBatchPredictionResponse

readList :: ReadS [CreateBatchPredictionResponse]

readPrec :: ReadPrec CreateBatchPredictionResponse

readListPrec :: ReadPrec [CreateBatchPredictionResponse]

Show CreateBatchPredictionResponse

Methods

showsPrec :: Int -> CreateBatchPredictionResponse -> ShowS

show :: CreateBatchPredictionResponse -> String

showList :: [CreateBatchPredictionResponse] -> ShowS

Generic CreateBatchPredictionResponse

Associated Types

type Rep CreateBatchPredictionResponse :: * -> *

Methods

from :: CreateBatchPredictionResponse -> Rep CreateBatchPredictionResponse x

to :: Rep CreateBatchPredictionResponse x -> CreateBatchPredictionResponse

NFData CreateBatchPredictionResponse

Methods

rnf :: CreateBatchPredictionResponse -> ()

type Rep CreateBatchPredictionResponse

type Rep CreateBatchPredictionResponse = D1 * (MetaData "CreateBatchPredictionResponse" "Network.AWS.MachineLearning.CreateBatchPrediction" "amazonka-ml-1.6.0-Ieesuz5Kri8FW4cNPxVPkB" False) (C1 * (MetaCons "CreateBatchPredictionResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_cbprsBatchPredictionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cbprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

cbprsBatchPredictionId :: Lens' CreateBatchPredictionResponse (Maybe Text)

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

cbprsResponseStatus :: Lens' CreateBatchPredictionResponse Int

• - | The response status code.