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 an Evaluation
that includes metadata as well as the current status of the Evaluation
.
- getEvaluation :: Text -> GetEvaluation
- data GetEvaluation
- geEvaluationId :: Lens' GetEvaluation Text
- getEvaluationResponse :: Int -> GetEvaluationResponse
- data GetEvaluationResponse
- gersStatus :: Lens' GetEvaluationResponse (Maybe EntityStatus)
- gersPerformanceMetrics :: Lens' GetEvaluationResponse (Maybe PerformanceMetrics)
- gersLastUpdatedAt :: Lens' GetEvaluationResponse (Maybe UTCTime)
- gersCreatedAt :: Lens' GetEvaluationResponse (Maybe UTCTime)
- gersComputeTime :: Lens' GetEvaluationResponse (Maybe Integer)
- gersInputDataLocationS3 :: Lens' GetEvaluationResponse (Maybe Text)
- gersMLModelId :: Lens' GetEvaluationResponse (Maybe Text)
- gersStartedAt :: Lens' GetEvaluationResponse (Maybe UTCTime)
- gersFinishedAt :: Lens' GetEvaluationResponse (Maybe UTCTime)
- gersCreatedByIAMUser :: Lens' GetEvaluationResponse (Maybe Text)
- gersName :: Lens' GetEvaluationResponse (Maybe Text)
- gersLogURI :: Lens' GetEvaluationResponse (Maybe Text)
- gersEvaluationId :: Lens' GetEvaluationResponse (Maybe Text)
- gersMessage :: Lens' GetEvaluationResponse (Maybe Text)
- gersEvaluationDataSourceId :: Lens' GetEvaluationResponse (Maybe Text)
- gersResponseStatus :: Lens' GetEvaluationResponse Int
Creating a Request
Creates a value of GetEvaluation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
geEvaluationId
- The ID of theEvaluation
to retrieve. The evaluation of eachMLModel
is recorded and cataloged. The ID provides the means to access the information.
data GetEvaluation Source #
See: getEvaluation
smart constructor.
Request Lenses
geEvaluationId :: Lens' GetEvaluation Text Source #
The ID of the Evaluation
to retrieve. The evaluation of each MLModel
is recorded and cataloged. The ID provides the means to access the information.
Destructuring the Response
getEvaluationResponse Source #
Creates a value of GetEvaluationResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gersStatus
- The status of the evaluation. This element can have one of the following values: *PENDING
- Amazon Machine Language (Amazon ML) submitted a request to evaluate anMLModel
. *INPROGRESS
- The evaluation is underway. *FAILED
- The request to evaluate anMLModel
did not run to completion. It is not usable. *COMPLETED
- The evaluation process completed successfully. *DELETED
- TheEvaluation
is marked as deleted. It is not usable.gersPerformanceMetrics
- Measurements of how well theMLModel
performed using observations referenced by theDataSource
. One of the following metric is returned based on the type of theMLModel
: * BinaryAUC: A binaryMLModel
uses the Area Under the Curve (AUC) technique to measure performance. * RegressionRMSE: A regressionMLModel
uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable. * MulticlassAvgFScore: A multiclassMLModel
uses the F1 score technique to measure performance. For more information about performance metrics, please see the Amazon Machine Learning Developer Guide .gersLastUpdatedAt
- The time of the most recent edit to theEvaluation
. The time is expressed in epoch time.gersCreatedAt
- The time that theEvaluation
was created. The time is expressed in epoch time.gersComputeTime
- The approximate CPU time in milliseconds that Amazon Machine Learning spent processing theEvaluation
, normalized and scaled on computation resources.ComputeTime
is only available if theEvaluation
is in theCOMPLETED
state.gersInputDataLocationS3
- The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).gersMLModelId
- The ID of theMLModel
that was the focus of the evaluation.gersStartedAt
- The epoch time when Amazon Machine Learning marked theEvaluation
asINPROGRESS
.StartedAt
isn't available if theEvaluation
is in thePENDING
state.gersFinishedAt
- The epoch time when Amazon Machine Learning marked theEvaluation
asCOMPLETED
orFAILED
.FinishedAt
is only available when theEvaluation
is in theCOMPLETED
orFAILED
state.gersCreatedByIAMUser
- The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.gersName
- A user-supplied name or description of theEvaluation
.gersLogURI
- A link to the file that contains logs of theCreateEvaluation
operation.gersEvaluationId
- The evaluation ID which is same as theEvaluationId
in the request.gersMessage
- A description of the most recent details about evaluating theMLModel
.gersEvaluationDataSourceId
- TheDataSource
used for this evaluation.gersResponseStatus
- -- | The response status code.
data GetEvaluationResponse Source #
Represents the output of a GetEvaluation
operation and describes an Evaluation
.
See: getEvaluationResponse
smart constructor.
Response Lenses
gersStatus :: Lens' GetEvaluationResponse (Maybe EntityStatus) Source #
The status of the evaluation. This element can have one of the following values: * PENDING
- Amazon Machine Language (Amazon ML) submitted a request to evaluate an MLModel
. * INPROGRESS
- The evaluation is underway. * FAILED
- The request to evaluate an MLModel
did not run to completion. It is not usable. * COMPLETED
- The evaluation process completed successfully. * DELETED
- The Evaluation
is marked as deleted. It is not usable.
gersPerformanceMetrics :: Lens' GetEvaluationResponse (Maybe PerformanceMetrics) Source #
Measurements of how well the MLModel
performed using observations referenced by the DataSource
. One of the following metric is returned based on the type of the MLModel
: * BinaryAUC: A binary MLModel
uses the Area Under the Curve (AUC) technique to measure performance. * RegressionRMSE: A regression MLModel
uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable. * MulticlassAvgFScore: A multiclass MLModel
uses the F1 score technique to measure performance. For more information about performance metrics, please see the Amazon Machine Learning Developer Guide .
gersLastUpdatedAt :: Lens' GetEvaluationResponse (Maybe UTCTime) Source #
The time of the most recent edit to the Evaluation
. The time is expressed in epoch time.
gersCreatedAt :: Lens' GetEvaluationResponse (Maybe UTCTime) Source #
The time that the Evaluation
was created. The time is expressed in epoch time.
gersComputeTime :: Lens' GetEvaluationResponse (Maybe Integer) Source #
The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the Evaluation
, normalized and scaled on computation resources. ComputeTime
is only available if the Evaluation
is in the COMPLETED
state.
gersInputDataLocationS3 :: Lens' GetEvaluationResponse (Maybe Text) Source #
The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
gersMLModelId :: Lens' GetEvaluationResponse (Maybe Text) Source #
The ID of the MLModel
that was the focus of the evaluation.
gersStartedAt :: Lens' GetEvaluationResponse (Maybe UTCTime) Source #
The epoch time when Amazon Machine Learning marked the Evaluation
as INPROGRESS
. StartedAt
isn't available if the Evaluation
is in the PENDING
state.
gersFinishedAt :: Lens' GetEvaluationResponse (Maybe UTCTime) Source #
The epoch time when Amazon Machine Learning marked the Evaluation
as COMPLETED
or FAILED
. FinishedAt
is only available when the Evaluation
is in the COMPLETED
or FAILED
state.
gersCreatedByIAMUser :: Lens' GetEvaluationResponse (Maybe Text) Source #
The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.
gersName :: Lens' GetEvaluationResponse (Maybe Text) Source #
A user-supplied name or description of the Evaluation
.
gersLogURI :: Lens' GetEvaluationResponse (Maybe Text) Source #
A link to the file that contains logs of the CreateEvaluation
operation.
gersEvaluationId :: Lens' GetEvaluationResponse (Maybe Text) Source #
The evaluation ID which is same as the EvaluationId
in the request.
gersMessage :: Lens' GetEvaluationResponse (Maybe Text) Source #
A description of the most recent details about evaluating the MLModel
.
gersEvaluationDataSourceId :: Lens' GetEvaluationResponse (Maybe Text) Source #
The DataSource
used for this evaluation.
gersResponseStatus :: Lens' GetEvaluationResponse Int Source #
- - | The response status code.