AWS SDK for C++  1.9.132
AWS SDK for C++
Public Member Functions | List of all members
Aws::MachineLearning::Model::Evaluation Class Reference

#include <Evaluation.h>

Public Member Functions

 Evaluation ()
 
 Evaluation (Aws::Utils::Json::JsonView jsonValue)
 
Evaluationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetEvaluationId () const
 
bool EvaluationIdHasBeenSet () const
 
void SetEvaluationId (const Aws::String &value)
 
void SetEvaluationId (Aws::String &&value)
 
void SetEvaluationId (const char *value)
 
EvaluationWithEvaluationId (const Aws::String &value)
 
EvaluationWithEvaluationId (Aws::String &&value)
 
EvaluationWithEvaluationId (const char *value)
 
const Aws::StringGetMLModelId () const
 
bool MLModelIdHasBeenSet () const
 
void SetMLModelId (const Aws::String &value)
 
void SetMLModelId (Aws::String &&value)
 
void SetMLModelId (const char *value)
 
EvaluationWithMLModelId (const Aws::String &value)
 
EvaluationWithMLModelId (Aws::String &&value)
 
EvaluationWithMLModelId (const char *value)
 
const Aws::StringGetEvaluationDataSourceId () const
 
bool EvaluationDataSourceIdHasBeenSet () const
 
void SetEvaluationDataSourceId (const Aws::String &value)
 
void SetEvaluationDataSourceId (Aws::String &&value)
 
void SetEvaluationDataSourceId (const char *value)
 
EvaluationWithEvaluationDataSourceId (const Aws::String &value)
 
EvaluationWithEvaluationDataSourceId (Aws::String &&value)
 
EvaluationWithEvaluationDataSourceId (const char *value)
 
const Aws::StringGetInputDataLocationS3 () const
 
bool InputDataLocationS3HasBeenSet () const
 
void SetInputDataLocationS3 (const Aws::String &value)
 
void SetInputDataLocationS3 (Aws::String &&value)
 
void SetInputDataLocationS3 (const char *value)
 
EvaluationWithInputDataLocationS3 (const Aws::String &value)
 
EvaluationWithInputDataLocationS3 (Aws::String &&value)
 
EvaluationWithInputDataLocationS3 (const char *value)
 
const Aws::StringGetCreatedByIamUser () const
 
bool CreatedByIamUserHasBeenSet () const
 
void SetCreatedByIamUser (const Aws::String &value)
 
void SetCreatedByIamUser (Aws::String &&value)
 
void SetCreatedByIamUser (const char *value)
 
EvaluationWithCreatedByIamUser (const Aws::String &value)
 
EvaluationWithCreatedByIamUser (Aws::String &&value)
 
EvaluationWithCreatedByIamUser (const char *value)
 
const Aws::Utils::DateTimeGetCreatedAt () const
 
bool CreatedAtHasBeenSet () const
 
void SetCreatedAt (const Aws::Utils::DateTime &value)
 
void SetCreatedAt (Aws::Utils::DateTime &&value)
 
EvaluationWithCreatedAt (const Aws::Utils::DateTime &value)
 
EvaluationWithCreatedAt (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetLastUpdatedAt () const
 
bool LastUpdatedAtHasBeenSet () const
 
void SetLastUpdatedAt (const Aws::Utils::DateTime &value)
 
void SetLastUpdatedAt (Aws::Utils::DateTime &&value)
 
EvaluationWithLastUpdatedAt (const Aws::Utils::DateTime &value)
 
EvaluationWithLastUpdatedAt (Aws::Utils::DateTime &&value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
EvaluationWithName (const Aws::String &value)
 
EvaluationWithName (Aws::String &&value)
 
EvaluationWithName (const char *value)
 
const EntityStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const EntityStatus &value)
 
void SetStatus (EntityStatus &&value)
 
EvaluationWithStatus (const EntityStatus &value)
 
EvaluationWithStatus (EntityStatus &&value)
 
const PerformanceMetricsGetPerformanceMetrics () const
 
bool PerformanceMetricsHasBeenSet () const
 
void SetPerformanceMetrics (const PerformanceMetrics &value)
 
void SetPerformanceMetrics (PerformanceMetrics &&value)
 
EvaluationWithPerformanceMetrics (const PerformanceMetrics &value)
 
EvaluationWithPerformanceMetrics (PerformanceMetrics &&value)
 
const Aws::StringGetMessage () const
 
bool MessageHasBeenSet () const
 
void SetMessage (const Aws::String &value)
 
void SetMessage (Aws::String &&value)
 
void SetMessage (const char *value)
 
EvaluationWithMessage (const Aws::String &value)
 
EvaluationWithMessage (Aws::String &&value)
 
EvaluationWithMessage (const char *value)
 
long long GetComputeTime () const
 
bool ComputeTimeHasBeenSet () const
 
void SetComputeTime (long long value)
 
EvaluationWithComputeTime (long long value)
 
const Aws::Utils::DateTimeGetFinishedAt () const
 
bool FinishedAtHasBeenSet () const
 
void SetFinishedAt (const Aws::Utils::DateTime &value)
 
void SetFinishedAt (Aws::Utils::DateTime &&value)
 
EvaluationWithFinishedAt (const Aws::Utils::DateTime &value)
 
EvaluationWithFinishedAt (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetStartedAt () const
 
bool StartedAtHasBeenSet () const
 
void SetStartedAt (const Aws::Utils::DateTime &value)
 
void SetStartedAt (Aws::Utils::DateTime &&value)
 
EvaluationWithStartedAt (const Aws::Utils::DateTime &value)
 
EvaluationWithStartedAt (Aws::Utils::DateTime &&value)
 

Detailed Description

Represents the output of GetEvaluation operation.

The content consists of the detailed metadata and data file information and the current status of the Evaluation.

See Also:

AWS API Reference

Definition at line 36 of file Evaluation.h.

Constructor & Destructor Documentation

◆ Evaluation() [1/2]

Aws::MachineLearning::Model::Evaluation::Evaluation ( )

◆ Evaluation() [2/2]

Aws::MachineLearning::Model::Evaluation::Evaluation ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ComputeTimeHasBeenSet()

bool Aws::MachineLearning::Model::Evaluation::ComputeTimeHasBeenSet ( ) const
inline

Definition at line 632 of file Evaluation.h.

◆ CreatedAtHasBeenSet()

bool Aws::MachineLearning::Model::Evaluation::CreatedAtHasBeenSet ( ) const
inline

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

Definition at line 292 of file Evaluation.h.

◆ CreatedByIamUserHasBeenSet()

bool Aws::MachineLearning::Model::Evaluation::CreatedByIamUserHasBeenSet ( ) const
inline

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.

Definition at line 237 of file Evaluation.h.

◆ EvaluationDataSourceIdHasBeenSet()

bool Aws::MachineLearning::Model::Evaluation::EvaluationDataSourceIdHasBeenSet ( ) const
inline

The ID of the DataSource that is used to evaluate the MLModel.

Definition at line 137 of file Evaluation.h.

◆ EvaluationIdHasBeenSet()

bool Aws::MachineLearning::Model::Evaluation::EvaluationIdHasBeenSet ( ) const
inline

The ID that is assigned to the Evaluation at creation.

Definition at line 53 of file Evaluation.h.

◆ FinishedAtHasBeenSet()

bool Aws::MachineLearning::Model::Evaluation::FinishedAtHasBeenSet ( ) const
inline

Definition at line 645 of file Evaluation.h.

◆ GetComputeTime()

long long Aws::MachineLearning::Model::Evaluation::GetComputeTime ( ) const
inline

Definition at line 629 of file Evaluation.h.

◆ GetCreatedAt()

const Aws::Utils::DateTime& Aws::MachineLearning::Model::Evaluation::GetCreatedAt ( ) const
inline

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

Definition at line 286 of file Evaluation.h.

◆ GetCreatedByIamUser()

const Aws::String& Aws::MachineLearning::Model::Evaluation::GetCreatedByIamUser ( ) const
inline

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.

Definition at line 230 of file Evaluation.h.

◆ GetEvaluationDataSourceId()

const Aws::String& Aws::MachineLearning::Model::Evaluation::GetEvaluationDataSourceId ( ) const
inline

The ID of the DataSource that is used to evaluate the MLModel.

Definition at line 131 of file Evaluation.h.

◆ GetEvaluationId()

const Aws::String& Aws::MachineLearning::Model::Evaluation::GetEvaluationId ( ) const
inline

The ID that is assigned to the Evaluation at creation.

Definition at line 48 of file Evaluation.h.

◆ GetFinishedAt()

const Aws::Utils::DateTime& Aws::MachineLearning::Model::Evaluation::GetFinishedAt ( ) const
inline

Definition at line 642 of file Evaluation.h.

◆ GetInputDataLocationS3()

const Aws::String& Aws::MachineLearning::Model::Evaluation::GetInputDataLocationS3 ( ) const
inline

The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.

Definition at line 180 of file Evaluation.h.

◆ GetLastUpdatedAt()

const Aws::Utils::DateTime& Aws::MachineLearning::Model::Evaluation::GetLastUpdatedAt ( ) const
inline

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

Definition at line 323 of file Evaluation.h.

◆ GetMessage()

const Aws::String& Aws::MachineLearning::Model::Evaluation::GetMessage ( ) const
inline

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

Definition at line 583 of file Evaluation.h.

◆ GetMLModelId()

const Aws::String& Aws::MachineLearning::Model::Evaluation::GetMLModelId ( ) const
inline

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

Definition at line 89 of file Evaluation.h.

◆ GetName()

const Aws::String& Aws::MachineLearning::Model::Evaluation::GetName ( ) const
inline

A user-supplied name or description of the Evaluation.

Definition at line 359 of file Evaluation.h.

◆ GetPerformanceMetrics()

const PerformanceMetrics& Aws::MachineLearning::Model::Evaluation::GetPerformanceMetrics ( ) const
inline

Measurements of how well the MLModel performed, using observations referenced by the DataSource. One of the following metrics 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.

Definition at line 491 of file Evaluation.h.

◆ GetStartedAt()

const Aws::Utils::DateTime& Aws::MachineLearning::Model::Evaluation::GetStartedAt ( ) const
inline

Definition at line 661 of file Evaluation.h.

◆ GetStatus()

const EntityStatus& Aws::MachineLearning::Model::Evaluation::GetStatus ( ) const
inline

The status of the evaluation. This element can have one of the following values:

  • PENDING - Amazon Machine Learning (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.

Definition at line 408 of file Evaluation.h.

◆ InputDataLocationS3HasBeenSet()

bool Aws::MachineLearning::Model::Evaluation::InputDataLocationS3HasBeenSet ( ) const
inline

The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.

Definition at line 186 of file Evaluation.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::MachineLearning::Model::Evaluation::Jsonize ( ) const

◆ LastUpdatedAtHasBeenSet()

bool Aws::MachineLearning::Model::Evaluation::LastUpdatedAtHasBeenSet ( ) const
inline

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

Definition at line 329 of file Evaluation.h.

◆ MessageHasBeenSet()

bool Aws::MachineLearning::Model::Evaluation::MessageHasBeenSet ( ) const
inline

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

Definition at line 589 of file Evaluation.h.

◆ MLModelIdHasBeenSet()

bool Aws::MachineLearning::Model::Evaluation::MLModelIdHasBeenSet ( ) const
inline

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

Definition at line 94 of file Evaluation.h.

◆ NameHasBeenSet()

bool Aws::MachineLearning::Model::Evaluation::NameHasBeenSet ( ) const
inline

A user-supplied name or description of the Evaluation.

Definition at line 364 of file Evaluation.h.

◆ operator=()

Evaluation& Aws::MachineLearning::Model::Evaluation::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PerformanceMetricsHasBeenSet()

bool Aws::MachineLearning::Model::Evaluation::PerformanceMetricsHasBeenSet ( ) const
inline

Measurements of how well the MLModel performed, using observations referenced by the DataSource. One of the following metrics 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.

Definition at line 508 of file Evaluation.h.

◆ SetComputeTime()

void Aws::MachineLearning::Model::Evaluation::SetComputeTime ( long long  value)
inline

Definition at line 635 of file Evaluation.h.

◆ SetCreatedAt() [1/2]

void Aws::MachineLearning::Model::Evaluation::SetCreatedAt ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 304 of file Evaluation.h.

◆ SetCreatedAt() [2/2]

void Aws::MachineLearning::Model::Evaluation::SetCreatedAt ( const Aws::Utils::DateTime value)
inline

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

Definition at line 298 of file Evaluation.h.

◆ SetCreatedByIamUser() [1/3]

void Aws::MachineLearning::Model::Evaluation::SetCreatedByIamUser ( Aws::String &&  value)
inline

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.

Definition at line 251 of file Evaluation.h.

◆ SetCreatedByIamUser() [2/3]

void Aws::MachineLearning::Model::Evaluation::SetCreatedByIamUser ( const Aws::String value)
inline

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.

Definition at line 244 of file Evaluation.h.

◆ SetCreatedByIamUser() [3/3]

void Aws::MachineLearning::Model::Evaluation::SetCreatedByIamUser ( const char *  value)
inline

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.

Definition at line 258 of file Evaluation.h.

◆ SetEvaluationDataSourceId() [1/3]

void Aws::MachineLearning::Model::Evaluation::SetEvaluationDataSourceId ( Aws::String &&  value)
inline

The ID of the DataSource that is used to evaluate the MLModel.

Definition at line 149 of file Evaluation.h.

◆ SetEvaluationDataSourceId() [2/3]

void Aws::MachineLearning::Model::Evaluation::SetEvaluationDataSourceId ( const Aws::String value)
inline

The ID of the DataSource that is used to evaluate the MLModel.

Definition at line 143 of file Evaluation.h.

◆ SetEvaluationDataSourceId() [3/3]

void Aws::MachineLearning::Model::Evaluation::SetEvaluationDataSourceId ( const char *  value)
inline

The ID of the DataSource that is used to evaluate the MLModel.

Definition at line 155 of file Evaluation.h.

◆ SetEvaluationId() [1/3]

void Aws::MachineLearning::Model::Evaluation::SetEvaluationId ( Aws::String &&  value)
inline

The ID that is assigned to the Evaluation at creation.

Definition at line 63 of file Evaluation.h.

◆ SetEvaluationId() [2/3]

void Aws::MachineLearning::Model::Evaluation::SetEvaluationId ( const Aws::String value)
inline

The ID that is assigned to the Evaluation at creation.

Definition at line 58 of file Evaluation.h.

◆ SetEvaluationId() [3/3]

void Aws::MachineLearning::Model::Evaluation::SetEvaluationId ( const char *  value)
inline

The ID that is assigned to the Evaluation at creation.

Definition at line 68 of file Evaluation.h.

◆ SetFinishedAt() [1/2]

void Aws::MachineLearning::Model::Evaluation::SetFinishedAt ( Aws::Utils::DateTime &&  value)
inline

Definition at line 651 of file Evaluation.h.

◆ SetFinishedAt() [2/2]

void Aws::MachineLearning::Model::Evaluation::SetFinishedAt ( const Aws::Utils::DateTime value)
inline

Definition at line 648 of file Evaluation.h.

◆ SetInputDataLocationS3() [1/3]

void Aws::MachineLearning::Model::Evaluation::SetInputDataLocationS3 ( Aws::String &&  value)
inline

The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.

Definition at line 198 of file Evaluation.h.

◆ SetInputDataLocationS3() [2/3]

void Aws::MachineLearning::Model::Evaluation::SetInputDataLocationS3 ( const Aws::String value)
inline

The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.

Definition at line 192 of file Evaluation.h.

◆ SetInputDataLocationS3() [3/3]

void Aws::MachineLearning::Model::Evaluation::SetInputDataLocationS3 ( const char *  value)
inline

The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.

Definition at line 204 of file Evaluation.h.

◆ SetLastUpdatedAt() [1/2]

void Aws::MachineLearning::Model::Evaluation::SetLastUpdatedAt ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 341 of file Evaluation.h.

◆ SetLastUpdatedAt() [2/2]

void Aws::MachineLearning::Model::Evaluation::SetLastUpdatedAt ( const Aws::Utils::DateTime value)
inline

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

Definition at line 335 of file Evaluation.h.

◆ SetMessage() [1/3]

void Aws::MachineLearning::Model::Evaluation::SetMessage ( Aws::String &&  value)
inline

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

Definition at line 601 of file Evaluation.h.

◆ SetMessage() [2/3]

void Aws::MachineLearning::Model::Evaluation::SetMessage ( const Aws::String value)
inline

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

Definition at line 595 of file Evaluation.h.

◆ SetMessage() [3/3]

void Aws::MachineLearning::Model::Evaluation::SetMessage ( const char *  value)
inline

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

Definition at line 607 of file Evaluation.h.

◆ SetMLModelId() [1/3]

void Aws::MachineLearning::Model::Evaluation::SetMLModelId ( Aws::String &&  value)
inline

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

Definition at line 104 of file Evaluation.h.

◆ SetMLModelId() [2/3]

void Aws::MachineLearning::Model::Evaluation::SetMLModelId ( const Aws::String value)
inline

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

Definition at line 99 of file Evaluation.h.

◆ SetMLModelId() [3/3]

void Aws::MachineLearning::Model::Evaluation::SetMLModelId ( const char *  value)
inline

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

Definition at line 109 of file Evaluation.h.

◆ SetName() [1/3]

void Aws::MachineLearning::Model::Evaluation::SetName ( Aws::String &&  value)
inline

A user-supplied name or description of the Evaluation.

Definition at line 374 of file Evaluation.h.

◆ SetName() [2/3]

void Aws::MachineLearning::Model::Evaluation::SetName ( const Aws::String value)
inline

A user-supplied name or description of the Evaluation.

Definition at line 369 of file Evaluation.h.

◆ SetName() [3/3]

void Aws::MachineLearning::Model::Evaluation::SetName ( const char *  value)
inline

A user-supplied name or description of the Evaluation.

Definition at line 379 of file Evaluation.h.

◆ SetPerformanceMetrics() [1/2]

void Aws::MachineLearning::Model::Evaluation::SetPerformanceMetrics ( const PerformanceMetrics value)
inline

Measurements of how well the MLModel performed, using observations referenced by the DataSource. One of the following metrics 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.

Definition at line 525 of file Evaluation.h.

◆ SetPerformanceMetrics() [2/2]

void Aws::MachineLearning::Model::Evaluation::SetPerformanceMetrics ( PerformanceMetrics &&  value)
inline

Measurements of how well the MLModel performed, using observations referenced by the DataSource. One of the following metrics 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.

Definition at line 542 of file Evaluation.h.

◆ SetStartedAt() [1/2]

void Aws::MachineLearning::Model::Evaluation::SetStartedAt ( Aws::Utils::DateTime &&  value)
inline

Definition at line 670 of file Evaluation.h.

◆ SetStartedAt() [2/2]

void Aws::MachineLearning::Model::Evaluation::SetStartedAt ( const Aws::Utils::DateTime value)
inline

Definition at line 667 of file Evaluation.h.

◆ SetStatus() [1/2]

void Aws::MachineLearning::Model::Evaluation::SetStatus ( const EntityStatus value)
inline

The status of the evaluation. This element can have one of the following values:

  • PENDING - Amazon Machine Learning (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.

Definition at line 434 of file Evaluation.h.

◆ SetStatus() [2/2]

void Aws::MachineLearning::Model::Evaluation::SetStatus ( EntityStatus &&  value)
inline

The status of the evaluation. This element can have one of the following values:

  • PENDING - Amazon Machine Learning (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.

Definition at line 447 of file Evaluation.h.

◆ StartedAtHasBeenSet()

bool Aws::MachineLearning::Model::Evaluation::StartedAtHasBeenSet ( ) const
inline

Definition at line 664 of file Evaluation.h.

◆ StatusHasBeenSet()

bool Aws::MachineLearning::Model::Evaluation::StatusHasBeenSet ( ) const
inline

The status of the evaluation. This element can have one of the following values:

  • PENDING - Amazon Machine Learning (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.

Definition at line 421 of file Evaluation.h.

◆ WithComputeTime()

Evaluation& Aws::MachineLearning::Model::Evaluation::WithComputeTime ( long long  value)
inline

Definition at line 638 of file Evaluation.h.

◆ WithCreatedAt() [1/2]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithCreatedAt ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 316 of file Evaluation.h.

◆ WithCreatedAt() [2/2]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithCreatedAt ( const Aws::Utils::DateTime value)
inline

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

Definition at line 310 of file Evaluation.h.

◆ WithCreatedByIamUser() [1/3]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithCreatedByIamUser ( Aws::String &&  value)
inline

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.

Definition at line 272 of file Evaluation.h.

◆ WithCreatedByIamUser() [2/3]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithCreatedByIamUser ( const Aws::String value)
inline

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.

Definition at line 265 of file Evaluation.h.

◆ WithCreatedByIamUser() [3/3]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithCreatedByIamUser ( const char *  value)
inline

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.

Definition at line 279 of file Evaluation.h.

◆ WithEvaluationDataSourceId() [1/3]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithEvaluationDataSourceId ( Aws::String &&  value)
inline

The ID of the DataSource that is used to evaluate the MLModel.

Definition at line 167 of file Evaluation.h.

◆ WithEvaluationDataSourceId() [2/3]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithEvaluationDataSourceId ( const Aws::String value)
inline

The ID of the DataSource that is used to evaluate the MLModel.

Definition at line 161 of file Evaluation.h.

◆ WithEvaluationDataSourceId() [3/3]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithEvaluationDataSourceId ( const char *  value)
inline

The ID of the DataSource that is used to evaluate the MLModel.

Definition at line 173 of file Evaluation.h.

◆ WithEvaluationId() [1/3]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithEvaluationId ( Aws::String &&  value)
inline

The ID that is assigned to the Evaluation at creation.

Definition at line 78 of file Evaluation.h.

◆ WithEvaluationId() [2/3]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithEvaluationId ( const Aws::String value)
inline

The ID that is assigned to the Evaluation at creation.

Definition at line 73 of file Evaluation.h.

◆ WithEvaluationId() [3/3]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithEvaluationId ( const char *  value)
inline

The ID that is assigned to the Evaluation at creation.

Definition at line 83 of file Evaluation.h.

◆ WithFinishedAt() [1/2]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithFinishedAt ( Aws::Utils::DateTime &&  value)
inline

Definition at line 657 of file Evaluation.h.

◆ WithFinishedAt() [2/2]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithFinishedAt ( const Aws::Utils::DateTime value)
inline

Definition at line 654 of file Evaluation.h.

◆ WithInputDataLocationS3() [1/3]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithInputDataLocationS3 ( Aws::String &&  value)
inline

The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.

Definition at line 216 of file Evaluation.h.

◆ WithInputDataLocationS3() [2/3]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithInputDataLocationS3 ( const Aws::String value)
inline

The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.

Definition at line 210 of file Evaluation.h.

◆ WithInputDataLocationS3() [3/3]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithInputDataLocationS3 ( const char *  value)
inline

The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.

Definition at line 222 of file Evaluation.h.

◆ WithLastUpdatedAt() [1/2]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithLastUpdatedAt ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 353 of file Evaluation.h.

◆ WithLastUpdatedAt() [2/2]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithLastUpdatedAt ( const Aws::Utils::DateTime value)
inline

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

Definition at line 347 of file Evaluation.h.

◆ WithMessage() [1/3]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithMessage ( Aws::String &&  value)
inline

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

Definition at line 619 of file Evaluation.h.

◆ WithMessage() [2/3]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithMessage ( const Aws::String value)
inline

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

Definition at line 613 of file Evaluation.h.

◆ WithMessage() [3/3]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithMessage ( const char *  value)
inline

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

Definition at line 625 of file Evaluation.h.

◆ WithMLModelId() [1/3]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithMLModelId ( Aws::String &&  value)
inline

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

Definition at line 119 of file Evaluation.h.

◆ WithMLModelId() [2/3]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithMLModelId ( const Aws::String value)
inline

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

Definition at line 114 of file Evaluation.h.

◆ WithMLModelId() [3/3]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithMLModelId ( const char *  value)
inline

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

Definition at line 124 of file Evaluation.h.

◆ WithName() [1/3]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithName ( Aws::String &&  value)
inline

A user-supplied name or description of the Evaluation.

Definition at line 389 of file Evaluation.h.

◆ WithName() [2/3]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithName ( const Aws::String value)
inline

A user-supplied name or description of the Evaluation.

Definition at line 384 of file Evaluation.h.

◆ WithName() [3/3]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithName ( const char *  value)
inline

A user-supplied name or description of the Evaluation.

Definition at line 394 of file Evaluation.h.

◆ WithPerformanceMetrics() [1/2]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithPerformanceMetrics ( const PerformanceMetrics value)
inline

Measurements of how well the MLModel performed, using observations referenced by the DataSource. One of the following metrics 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.

Definition at line 559 of file Evaluation.h.

◆ WithPerformanceMetrics() [2/2]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithPerformanceMetrics ( PerformanceMetrics &&  value)
inline

Measurements of how well the MLModel performed, using observations referenced by the DataSource. One of the following metrics 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.

Definition at line 576 of file Evaluation.h.

◆ WithStartedAt() [1/2]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithStartedAt ( Aws::Utils::DateTime &&  value)
inline

Definition at line 676 of file Evaluation.h.

◆ WithStartedAt() [2/2]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithStartedAt ( const Aws::Utils::DateTime value)
inline

Definition at line 673 of file Evaluation.h.

◆ WithStatus() [1/2]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithStatus ( const EntityStatus value)
inline

The status of the evaluation. This element can have one of the following values:

  • PENDING - Amazon Machine Learning (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.

Definition at line 460 of file Evaluation.h.

◆ WithStatus() [2/2]

Evaluation& Aws::MachineLearning::Model::Evaluation::WithStatus ( EntityStatus &&  value)
inline

The status of the evaluation. This element can have one of the following values:

  • PENDING - Amazon Machine Learning (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.

Definition at line 473 of file Evaluation.h.


The documentation for this class was generated from the following file: