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 |
Returns a BatchPrediction
that includes detailed metadata, status, and data file information for a Batch Prediction
request.
Synopsis
- getBatchPrediction :: Text -> GetBatchPrediction
- data GetBatchPrediction
- gbpBatchPredictionId :: Lens' GetBatchPrediction Text
- getBatchPredictionResponse :: Int -> GetBatchPredictionResponse
- data GetBatchPredictionResponse
- gbprsStatus :: Lens' GetBatchPredictionResponse (Maybe EntityStatus)
- gbprsLastUpdatedAt :: Lens' GetBatchPredictionResponse (Maybe UTCTime)
- gbprsCreatedAt :: Lens' GetBatchPredictionResponse (Maybe UTCTime)
- gbprsComputeTime :: Lens' GetBatchPredictionResponse (Maybe Integer)
- gbprsInputDataLocationS3 :: Lens' GetBatchPredictionResponse (Maybe Text)
- gbprsMLModelId :: Lens' GetBatchPredictionResponse (Maybe Text)
- gbprsBatchPredictionDataSourceId :: Lens' GetBatchPredictionResponse (Maybe Text)
- gbprsTotalRecordCount :: Lens' GetBatchPredictionResponse (Maybe Integer)
- gbprsStartedAt :: Lens' GetBatchPredictionResponse (Maybe UTCTime)
- gbprsBatchPredictionId :: Lens' GetBatchPredictionResponse (Maybe Text)
- gbprsFinishedAt :: Lens' GetBatchPredictionResponse (Maybe UTCTime)
- gbprsInvalidRecordCount :: Lens' GetBatchPredictionResponse (Maybe Integer)
- gbprsCreatedByIAMUser :: Lens' GetBatchPredictionResponse (Maybe Text)
- gbprsName :: Lens' GetBatchPredictionResponse (Maybe Text)
- gbprsLogURI :: Lens' GetBatchPredictionResponse (Maybe Text)
- gbprsMessage :: Lens' GetBatchPredictionResponse (Maybe Text)
- gbprsOutputURI :: Lens' GetBatchPredictionResponse (Maybe Text)
- gbprsResponseStatus :: Lens' GetBatchPredictionResponse Int
Creating a Request
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 theBatchPrediction
at creation.
data GetBatchPrediction Source #
See: getBatchPrediction
smart constructor.
Instances
Request Lenses
gbpBatchPredictionId :: Lens' GetBatchPrediction Text Source #
An ID assigned to the BatchPrediction
at creation.
Destructuring the Response
getBatchPredictionResponse Source #
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 theBatchPrediction
, 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
- TheBatchPrediction
is marked as deleted. It is not usable.gbprsLastUpdatedAt
- The time of the most recent edit toBatchPrediction
. The time is expressed in epoch time.gbprsCreatedAt
- The time when theBatchPrediction
was created. The time is expressed in epoch time.gbprsComputeTime
- The approximate CPU time in milliseconds that Amazon Machine Learning spent processing theBatchPrediction
, normalized and scaled on computation resources.ComputeTime
is only available if theBatchPrediction
is in theCOMPLETED
state.gbprsInputDataLocationS3
- The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).gbprsMLModelId
- The ID of theMLModel
that generated predictions for theBatchPrediction
request.gbprsBatchPredictionDataSourceId
- The ID of theDataSource
that was used to create theBatchPrediction
.gbprsTotalRecordCount
- The number of total records that Amazon Machine Learning saw while processing theBatchPrediction
.gbprsStartedAt
- The epoch time when Amazon Machine Learning marked theBatchPrediction
asINPROGRESS
.StartedAt
isn't available if theBatchPrediction
is in thePENDING
state.gbprsBatchPredictionId
- An ID assigned to theBatchPrediction
at creation. This value should be identical to the value of theBatchPredictionID
in the request.gbprsFinishedAt
- The epoch time when Amazon Machine Learning marked theBatchPrediction
asCOMPLETED
orFAILED
.FinishedAt
is only available when theBatchPrediction
is in theCOMPLETED
orFAILED
state.gbprsInvalidRecordCount
- The number of invalid records that Amazon Machine Learning saw while processing theBatchPrediction
.gbprsCreatedByIAMUser
- The AWS user account that invoked theBatchPrediction
. 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 theBatchPrediction
.gbprsLogURI
- A link to the file that contains logs of theCreateBatchPrediction
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 Source #
Represents the output of a GetBatchPrediction
operation and describes a BatchPrediction
.
See: getBatchPredictionResponse
smart constructor.
Instances
Response Lenses
gbprsStatus :: Lens' GetBatchPredictionResponse (Maybe EntityStatus) Source #
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) Source #
The time of the most recent edit to BatchPrediction
. The time is expressed in epoch time.
gbprsCreatedAt :: Lens' GetBatchPredictionResponse (Maybe UTCTime) Source #
The time when the BatchPrediction
was created. The time is expressed in epoch time.
gbprsComputeTime :: Lens' GetBatchPredictionResponse (Maybe Integer) Source #
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) Source #
The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
gbprsMLModelId :: Lens' GetBatchPredictionResponse (Maybe Text) Source #
The ID of the MLModel
that generated predictions for the BatchPrediction
request.
gbprsBatchPredictionDataSourceId :: Lens' GetBatchPredictionResponse (Maybe Text) Source #
The ID of the DataSource
that was used to create the BatchPrediction
.
gbprsTotalRecordCount :: Lens' GetBatchPredictionResponse (Maybe Integer) Source #
The number of total records that Amazon Machine Learning saw while processing the BatchPrediction
.
gbprsStartedAt :: Lens' GetBatchPredictionResponse (Maybe UTCTime) Source #
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) Source #
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) Source #
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) Source #
The number of invalid records that Amazon Machine Learning saw while processing the BatchPrediction
.
gbprsCreatedByIAMUser :: Lens' GetBatchPredictionResponse (Maybe Text) Source #
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) Source #
A user-supplied name or description of the BatchPrediction
.
gbprsLogURI :: Lens' GetBatchPredictionResponse (Maybe Text) Source #
A link to the file that contains logs of the CreateBatchPrediction
operation.
gbprsMessage :: Lens' GetBatchPredictionResponse (Maybe Text) Source #
A description of the most recent details about processing the batch prediction request.
gbprsOutputURI :: Lens' GetBatchPredictionResponse (Maybe Text) Source #
The location of an Amazon S3 bucket or directory to receive the operation results.
gbprsResponseStatus :: Lens' GetBatchPredictionResponse Int Source #
- - | The response status code.