Network.AWS.MachineLearning.GetEvaluation

Returns an Evaluation that includes metadata as well as the current status of the Evaluation .

Creating a Request

getEvaluation

Arguments

:: Text

geEvaluationId

-> GetEvaluation

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 the Evaluation to retrieve. The evaluation of each MLModel is recorded and cataloged. The ID provides the means to access the information.

data GetEvaluation

See: getEvaluation smart constructor.

Instances

Eq GetEvaluation

Methods

(==) :: GetEvaluation -> GetEvaluation -> Bool

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

Data GetEvaluation

Methods

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

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

toConstr :: GetEvaluation -> Constr

dataTypeOf :: GetEvaluation -> DataType

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

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

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

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

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

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

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

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

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

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

Read GetEvaluation

Methods

readsPrec :: Int -> ReadS GetEvaluation

readList :: ReadS [GetEvaluation]

readPrec :: ReadPrec GetEvaluation

readListPrec :: ReadPrec [GetEvaluation]

Show GetEvaluation

Methods

showsPrec :: Int -> GetEvaluation -> ShowS

show :: GetEvaluation -> String

showList :: [GetEvaluation] -> ShowS

Generic GetEvaluation

Associated Types

type Rep GetEvaluation :: * -> *

Methods

from :: GetEvaluation -> Rep GetEvaluation x

to :: Rep GetEvaluation x -> GetEvaluation

Hashable GetEvaluation

Methods

hashWithSalt :: Int -> GetEvaluation -> Int

hash :: GetEvaluation -> Int

ToJSON GetEvaluation

Methods

toJSON :: GetEvaluation -> Value

toEncoding :: GetEvaluation -> Encoding

toJSONList :: [GetEvaluation] -> Value

toEncodingList :: [GetEvaluation] -> Encoding

NFData GetEvaluation

Methods

rnf :: GetEvaluation -> ()

AWSRequest GetEvaluation

Associated Types

type Rs GetEvaluation :: *

Methods

request :: GetEvaluation -> Request GetEvaluation

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

ToHeaders GetEvaluation

Methods

toHeaders :: GetEvaluation -> [Header]

ToPath GetEvaluation

Methods

toPath :: GetEvaluation -> ByteString

ToQuery GetEvaluation

Methods

toQuery :: GetEvaluation -> QueryString

type Rep GetEvaluation

type Rep GetEvaluation = D1 * (MetaData "GetEvaluation" "Network.AWS.MachineLearning.GetEvaluation" "amazonka-ml-1.6.0-Ieesuz5Kri8FW4cNPxVPkB" True) (C1 * (MetaCons "GetEvaluation'" PrefixI True) (S1 * (MetaSel (Just Symbol "_geEvaluationId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

type Rs GetEvaluation

type Rs GetEvaluation = GetEvaluationResponse

Request Lenses

geEvaluationId :: Lens' GetEvaluation Text

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

Arguments

:: Int

gersResponseStatus

-> GetEvaluationResponse

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 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 - 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 - The time of the most recent edit to the Evaluation . The time is expressed in epoch time.
• gersCreatedAt - The time that the Evaluation was created. The time is expressed in epoch time.
• gersComputeTime - 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 - The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
• gersMLModelId - The ID of the MLModel that was the focus of the evaluation.
• gersStartedAt - 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 - 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 - 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 the Evaluation .
• gersLogURI - A link to the file that contains logs of the CreateEvaluation operation.
• gersEvaluationId - The evaluation ID which is same as the EvaluationId in the request.
• gersMessage - A description of the most recent details about evaluating the MLModel .
• gersEvaluationDataSourceId - The DataSource used for this evaluation.
• gersResponseStatus - -- | The response status code.

data GetEvaluationResponse

Represents the output of a GetEvaluation operation and describes an Evaluation .

See: getEvaluationResponse smart constructor.

Instances

Eq GetEvaluationResponse

Methods

(==) :: GetEvaluationResponse -> GetEvaluationResponse -> Bool

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

Data GetEvaluationResponse

Methods

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

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

toConstr :: GetEvaluationResponse -> Constr

dataTypeOf :: GetEvaluationResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read GetEvaluationResponse

Methods

readsPrec :: Int -> ReadS GetEvaluationResponse

readList :: ReadS [GetEvaluationResponse]

readPrec :: ReadPrec GetEvaluationResponse

readListPrec :: ReadPrec [GetEvaluationResponse]

Show GetEvaluationResponse

Methods

showsPrec :: Int -> GetEvaluationResponse -> ShowS

show :: GetEvaluationResponse -> String

showList :: [GetEvaluationResponse] -> ShowS

Generic GetEvaluationResponse

Associated Types

type Rep GetEvaluationResponse :: * -> *

Methods

from :: GetEvaluationResponse -> Rep GetEvaluationResponse x

to :: Rep GetEvaluationResponse x -> GetEvaluationResponse

NFData GetEvaluationResponse

Methods

rnf :: GetEvaluationResponse -> ()

type Rep GetEvaluationResponse

type Rep GetEvaluationResponse = D1 * (MetaData "GetEvaluationResponse" "Network.AWS.MachineLearning.GetEvaluation" "amazonka-ml-1.6.0-Ieesuz5Kri8FW4cNPxVPkB" False) (C1 * (MetaCons "GetEvaluationResponse'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_gersStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe EntityStatus))) (S1 * (MetaSel (Just Symbol "_gersPerformanceMetrics") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe PerformanceMetrics)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gersLastUpdatedAt") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) (S1 * (MetaSel (Just Symbol "_gersCreatedAt") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_gersComputeTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Integer))) (S1 * (MetaSel (Just Symbol "_gersInputDataLocationS3") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gersMLModelId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gersStartedAt") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX)))))) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_gersFinishedAt") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) (S1 * (MetaSel (Just Symbol "_gersCreatedByIAMUser") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gersName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gersLogURI") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_gersEvaluationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gersMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gersEvaluationDataSourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gersResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))))

Response Lenses

gersStatus :: Lens' GetEvaluationResponse (Maybe EntityStatus)

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)

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)

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

gersCreatedAt :: Lens' GetEvaluationResponse (Maybe UTCTime)

The time that the Evaluation was created. The time is expressed in epoch time.

gersComputeTime :: Lens' GetEvaluationResponse (Maybe Integer)

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)

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

gersMLModelId :: Lens' GetEvaluationResponse (Maybe Text)

The ID of the MLModel that was the focus of the evaluation.

gersStartedAt :: Lens' GetEvaluationResponse (Maybe UTCTime)

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)

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)

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)

A user-supplied name or description of the Evaluation .

gersLogURI :: Lens' GetEvaluationResponse (Maybe Text)

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

gersEvaluationId :: Lens' GetEvaluationResponse (Maybe Text)

The evaluation ID which is same as the EvaluationId in the request.

gersMessage :: Lens' GetEvaluationResponse (Maybe Text)

A description of the most recent details about evaluating the MLModel .

gersEvaluationDataSourceId :: Lens' GetEvaluationResponse (Maybe Text)

The DataSource used for this evaluation.

gersResponseStatus :: Lens' GetEvaluationResponse Int

• - | The response status code.