Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.MachineLearning.GetBatchPrediction

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

Creating a Request

getBatchPrediction #

Arguments

:: Text	`gbpBatchPredictionId`
-> GetBatchPrediction

Creates a value of GetBatchPrediction with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

gbpBatchPredictionId - An ID assigned to the BatchPrediction at creation.

data GetBatchPrediction #

See: getBatchPrediction smart constructor.

Instances

Eq GetBatchPrediction #
Instance details Defined in Network.AWS.MachineLearning.GetBatchPrediction Methods (==) :: GetBatchPrediction -> GetBatchPrediction -> Bool # (/=) :: GetBatchPrediction -> GetBatchPrediction -> Bool #
Data GetBatchPrediction #
Instance details Defined in Network.AWS.MachineLearning.GetBatchPrediction Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetBatchPrediction -> c GetBatchPrediction # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetBatchPrediction # toConstr :: GetBatchPrediction -> Constr # dataTypeOf :: GetBatchPrediction -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetBatchPrediction) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetBatchPrediction) # gmapT :: (forall b. Data b => b -> b) -> GetBatchPrediction -> GetBatchPrediction # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetBatchPrediction -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetBatchPrediction -> r # gmapQ :: (forall d. Data d => d -> u) -> GetBatchPrediction -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetBatchPrediction -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetBatchPrediction -> m GetBatchPrediction # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetBatchPrediction -> m GetBatchPrediction # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetBatchPrediction -> m GetBatchPrediction #
Read GetBatchPrediction #
Instance details Defined in Network.AWS.MachineLearning.GetBatchPrediction Methods readsPrec :: Int -> ReadS GetBatchPrediction # readList :: ReadS [GetBatchPrediction] # readPrec :: ReadPrec GetBatchPrediction # readListPrec :: ReadPrec [GetBatchPrediction] #
Show GetBatchPrediction #
Instance details Defined in Network.AWS.MachineLearning.GetBatchPrediction Methods showsPrec :: Int -> GetBatchPrediction -> ShowS # show :: GetBatchPrediction -> String # showList :: [GetBatchPrediction] -> ShowS #
Generic GetBatchPrediction #
Instance details Defined in Network.AWS.MachineLearning.GetBatchPrediction Associated Types type Rep GetBatchPrediction :: * -> * # Methods from :: GetBatchPrediction -> Rep GetBatchPrediction x # to :: Rep GetBatchPrediction x -> GetBatchPrediction #
Hashable GetBatchPrediction #
Instance details Defined in Network.AWS.MachineLearning.GetBatchPrediction Methods hashWithSalt :: Int -> GetBatchPrediction -> Int # hash :: GetBatchPrediction -> Int #
ToJSON GetBatchPrediction #
Instance details Defined in Network.AWS.MachineLearning.GetBatchPrediction Methods toJSON :: GetBatchPrediction -> Value # toEncoding :: GetBatchPrediction -> Encoding # toJSONList :: [GetBatchPrediction] -> Value # toEncodingList :: [GetBatchPrediction] -> Encoding #
AWSRequest GetBatchPrediction #
Instance details Defined in Network.AWS.MachineLearning.GetBatchPrediction Associated Types type Rs GetBatchPrediction :: * # Methods request :: GetBatchPrediction -> Request GetBatchPrediction # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy GetBatchPrediction -> ClientResponse -> m (Response GetBatchPrediction) #
ToHeaders GetBatchPrediction #
Instance details Defined in Network.AWS.MachineLearning.GetBatchPrediction Methods toHeaders :: GetBatchPrediction -> [Header] #
ToPath GetBatchPrediction #
Instance details Defined in Network.AWS.MachineLearning.GetBatchPrediction Methods toPath :: GetBatchPrediction -> ByteString #
ToQuery GetBatchPrediction #
Instance details Defined in Network.AWS.MachineLearning.GetBatchPrediction Methods toQuery :: GetBatchPrediction -> QueryString #
NFData GetBatchPrediction #
Instance details Defined in Network.AWS.MachineLearning.GetBatchPrediction Methods rnf :: GetBatchPrediction -> () #
type Rep GetBatchPrediction #
Instance details Defined in Network.AWS.MachineLearning.GetBatchPrediction type Rep GetBatchPrediction = D1 (MetaData "GetBatchPrediction" "Network.AWS.MachineLearning.GetBatchPrediction" "amazonka-ml-1.6.0-TdNGQduaCI3599xkq7Zfu" True) (C1 (MetaCons "GetBatchPrediction'" PrefixI True) (S1 (MetaSel (Just "_gbpBatchPredictionId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type Rs GetBatchPrediction #
Instance details Defined in Network.AWS.MachineLearning.GetBatchPrediction type Rs GetBatchPrediction = GetBatchPredictionResponse

Request Lenses

gbpBatchPredictionId :: Lens' GetBatchPrediction Text #

An ID assigned to the BatchPrediction at creation.

Destructuring the Response

getBatchPredictionResponse #

Arguments

:: Int	`gbprsResponseStatus`
-> GetBatchPredictionResponse

Creates a value of GetBatchPredictionResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

gbprsStatus - The status of the BatchPrediction , which can be one of the following values: * PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate batch predictions. * INPROGRESS - The batch predictions are in progress. * FAILED - The request to perform a batch prediction did not run to completion. It is not usable. * COMPLETED - The batch prediction process completed successfully. * DELETED - The BatchPrediction is marked as deleted. It is not usable.
gbprsLastUpdatedAt - The time of the most recent edit to BatchPrediction . The time is expressed in epoch time.
gbprsCreatedAt - The time when the BatchPrediction was created. The time is expressed in epoch time.
gbprsComputeTime - The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the BatchPrediction , normalized and scaled on computation resources. ComputeTime is only available if the BatchPrediction is in the COMPLETED state.
gbprsInputDataLocationS3 - The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
gbprsMLModelId - The ID of the MLModel that generated predictions for the BatchPrediction request.
gbprsBatchPredictionDataSourceId - The ID of the DataSource that was used to create the BatchPrediction .
gbprsTotalRecordCount - The number of total records that Amazon Machine Learning saw while processing the BatchPrediction .
gbprsStartedAt - The epoch time when Amazon Machine Learning marked the BatchPrediction as INPROGRESS . StartedAt isn't available if the BatchPrediction is in the PENDING state.
gbprsBatchPredictionId - An ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID in the request.
gbprsFinishedAt - The epoch time when Amazon Machine Learning marked the BatchPrediction as COMPLETED or FAILED . FinishedAt is only available when the BatchPrediction is in the COMPLETED or FAILED state.
gbprsInvalidRecordCount - The number of invalid records that Amazon Machine Learning saw while processing the BatchPrediction .
gbprsCreatedByIAMUser - The AWS user account that invoked the BatchPrediction . The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.
gbprsName - A user-supplied name or description of the BatchPrediction .
gbprsLogURI - A link to the file that contains logs of the CreateBatchPrediction operation.
gbprsMessage - A description of the most recent details about processing the batch prediction request.
gbprsOutputURI - The location of an Amazon S3 bucket or directory to receive the operation results.
gbprsResponseStatus - -- | The response status code.

data GetBatchPredictionResponse #

Represents the output of a GetBatchPrediction operation and describes a BatchPrediction .

See: getBatchPredictionResponse smart constructor.

Instances

Eq GetBatchPredictionResponse #
Instance details Defined in Network.AWS.MachineLearning.GetBatchPrediction Methods (==) :: GetBatchPredictionResponse -> GetBatchPredictionResponse -> Bool # (/=) :: GetBatchPredictionResponse -> GetBatchPredictionResponse -> Bool #
Data GetBatchPredictionResponse #
Instance details Defined in Network.AWS.MachineLearning.GetBatchPrediction Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetBatchPredictionResponse -> c GetBatchPredictionResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetBatchPredictionResponse # toConstr :: GetBatchPredictionResponse -> Constr # dataTypeOf :: GetBatchPredictionResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetBatchPredictionResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetBatchPredictionResponse) # gmapT :: (forall b. Data b => b -> b) -> GetBatchPredictionResponse -> GetBatchPredictionResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetBatchPredictionResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetBatchPredictionResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> GetBatchPredictionResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetBatchPredictionResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetBatchPredictionResponse -> m GetBatchPredictionResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetBatchPredictionResponse -> m GetBatchPredictionResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetBatchPredictionResponse -> m GetBatchPredictionResponse #
Read GetBatchPredictionResponse #
Instance details Defined in Network.AWS.MachineLearning.GetBatchPrediction Methods readsPrec :: Int -> ReadS GetBatchPredictionResponse # readList :: ReadS [GetBatchPredictionResponse] # readPrec :: ReadPrec GetBatchPredictionResponse # readListPrec :: ReadPrec [GetBatchPredictionResponse] #
Show GetBatchPredictionResponse #
Instance details Defined in Network.AWS.MachineLearning.GetBatchPrediction Methods showsPrec :: Int -> GetBatchPredictionResponse -> ShowS # show :: GetBatchPredictionResponse -> String # showList :: [GetBatchPredictionResponse] -> ShowS #
Generic GetBatchPredictionResponse #
Instance details Defined in Network.AWS.MachineLearning.GetBatchPrediction Associated Types type Rep GetBatchPredictionResponse :: * -> * # Methods from :: GetBatchPredictionResponse -> Rep GetBatchPredictionResponse x # to :: Rep GetBatchPredictionResponse x -> GetBatchPredictionResponse #
NFData GetBatchPredictionResponse #
Instance details Defined in Network.AWS.MachineLearning.GetBatchPrediction Methods rnf :: GetBatchPredictionResponse -> () #
type Rep GetBatchPredictionResponse #
Instance details Defined in Network.AWS.MachineLearning.GetBatchPrediction type Rep GetBatchPredictionResponse = D1 (MetaData "GetBatchPredictionResponse" "Network.AWS.MachineLearning.GetBatchPrediction" "amazonka-ml-1.6.0-TdNGQduaCI3599xkq7Zfu" False) (C1 (MetaCons "GetBatchPredictionResponse'" PrefixI True) ((((S1 (MetaSel (Just "_gbprsStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EntityStatus)) :: S1 (MetaSel (Just "_gbprsLastUpdatedAt") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 (MetaSel (Just "_gbprsCreatedAt") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 (MetaSel (Just "_gbprsComputeTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer)))) :: ((S1 (MetaSel (Just "_gbprsInputDataLocationS3") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_gbprsMLModelId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_gbprsBatchPredictionDataSourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_gbprsTotalRecordCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer)) :: S1 (MetaSel (Just "_gbprsStartedAt") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)))))) :: (((S1 (MetaSel (Just "_gbprsBatchPredictionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_gbprsFinishedAt") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 (MetaSel (Just "_gbprsInvalidRecordCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer)) :: S1 (MetaSel (Just "_gbprsCreatedByIAMUser") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_gbprsName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_gbprsLogURI") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_gbprsMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_gbprsOutputURI") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_gbprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))))

Response Lenses

gbprsStatus :: Lens' GetBatchPredictionResponse (Maybe EntityStatus) #

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

gbprsLastUpdatedAt :: Lens' GetBatchPredictionResponse (Maybe UTCTime) #

The time of the most recent edit to BatchPrediction . The time is expressed in epoch time.

gbprsCreatedAt :: Lens' GetBatchPredictionResponse (Maybe UTCTime) #

The time when the BatchPrediction was created. The time is expressed in epoch time.

gbprsComputeTime :: Lens' GetBatchPredictionResponse (Maybe Integer) #

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

gbprsInputDataLocationS3 :: Lens' GetBatchPredictionResponse (Maybe Text) #

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

gbprsMLModelId :: Lens' GetBatchPredictionResponse (Maybe Text) #

The ID of the MLModel that generated predictions for the BatchPrediction request.

gbprsBatchPredictionDataSourceId :: Lens' GetBatchPredictionResponse (Maybe Text) #

The ID of the DataSource that was used to create the BatchPrediction .

gbprsTotalRecordCount :: Lens' GetBatchPredictionResponse (Maybe Integer) #

The number of total records that Amazon Machine Learning saw while processing the BatchPrediction .

gbprsStartedAt :: Lens' GetBatchPredictionResponse (Maybe UTCTime) #

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

gbprsBatchPredictionId :: Lens' GetBatchPredictionResponse (Maybe Text) #

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

gbprsFinishedAt :: Lens' GetBatchPredictionResponse (Maybe UTCTime) #

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

gbprsInvalidRecordCount :: Lens' GetBatchPredictionResponse (Maybe Integer) #

The number of invalid records that Amazon Machine Learning saw while processing the BatchPrediction .

gbprsCreatedByIAMUser :: Lens' GetBatchPredictionResponse (Maybe Text) #

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

gbprsName :: Lens' GetBatchPredictionResponse (Maybe Text) #

A user-supplied name or description of the BatchPrediction .

gbprsLogURI :: Lens' GetBatchPredictionResponse (Maybe Text) #

A link to the file that contains logs of the CreateBatchPrediction operation.

gbprsMessage :: Lens' GetBatchPredictionResponse (Maybe Text) #

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

gbprsOutputURI :: Lens' GetBatchPredictionResponse (Maybe Text) #

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

gbprsResponseStatus :: Lens' GetBatchPredictionResponse Int #

- | The response status code.