/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { template class AmazonWebServiceResult; namespace Utils { namespace Json { class JsonValue; } // namespace Json } // namespace Utils namespace MachineLearning { namespace Model { /** *

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

See Also:

AWS * API Reference

*/ class GetEvaluationResult { public: AWS_MACHINELEARNING_API GetEvaluationResult(); AWS_MACHINELEARNING_API GetEvaluationResult(const Aws::AmazonWebServiceResult& result); AWS_MACHINELEARNING_API GetEvaluationResult& operator=(const Aws::AmazonWebServiceResult& result); /** *

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

*/ inline const Aws::String& GetEvaluationId() const{ return m_evaluationId; } /** *

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

*/ inline void SetEvaluationId(const Aws::String& value) { m_evaluationId = value; } /** *

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

*/ inline void SetEvaluationId(Aws::String&& value) { m_evaluationId = std::move(value); } /** *

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

*/ inline void SetEvaluationId(const char* value) { m_evaluationId.assign(value); } /** *

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

*/ inline GetEvaluationResult& WithEvaluationId(const Aws::String& value) { SetEvaluationId(value); return *this;} /** *

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

*/ inline GetEvaluationResult& WithEvaluationId(Aws::String&& value) { SetEvaluationId(std::move(value)); return *this;} /** *

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

*/ inline GetEvaluationResult& WithEvaluationId(const char* value) { SetEvaluationId(value); return *this;} /** *

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

*/ inline const Aws::String& GetMLModelId() const{ return m_mLModelId; } /** *

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

*/ inline void SetMLModelId(const Aws::String& value) { m_mLModelId = value; } /** *

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

*/ inline void SetMLModelId(Aws::String&& value) { m_mLModelId = std::move(value); } /** *

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

*/ inline void SetMLModelId(const char* value) { m_mLModelId.assign(value); } /** *

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

*/ inline GetEvaluationResult& WithMLModelId(const Aws::String& value) { SetMLModelId(value); return *this;} /** *

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

*/ inline GetEvaluationResult& WithMLModelId(Aws::String&& value) { SetMLModelId(std::move(value)); return *this;} /** *

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

*/ inline GetEvaluationResult& WithMLModelId(const char* value) { SetMLModelId(value); return *this;} /** *

The DataSource used for this evaluation.

*/ inline const Aws::String& GetEvaluationDataSourceId() const{ return m_evaluationDataSourceId; } /** *

The DataSource used for this evaluation.

*/ inline void SetEvaluationDataSourceId(const Aws::String& value) { m_evaluationDataSourceId = value; } /** *

The DataSource used for this evaluation.

*/ inline void SetEvaluationDataSourceId(Aws::String&& value) { m_evaluationDataSourceId = std::move(value); } /** *

The DataSource used for this evaluation.

*/ inline void SetEvaluationDataSourceId(const char* value) { m_evaluationDataSourceId.assign(value); } /** *

The DataSource used for this evaluation.

*/ inline GetEvaluationResult& WithEvaluationDataSourceId(const Aws::String& value) { SetEvaluationDataSourceId(value); return *this;} /** *

The DataSource used for this evaluation.

*/ inline GetEvaluationResult& WithEvaluationDataSourceId(Aws::String&& value) { SetEvaluationDataSourceId(std::move(value)); return *this;} /** *

The DataSource used for this evaluation.

*/ inline GetEvaluationResult& WithEvaluationDataSourceId(const char* value) { SetEvaluationDataSourceId(value); return *this;} /** *

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

*/ inline const Aws::String& GetInputDataLocationS3() const{ return m_inputDataLocationS3; } /** *

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

*/ inline void SetInputDataLocationS3(const Aws::String& value) { m_inputDataLocationS3 = value; } /** *

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

*/ inline void SetInputDataLocationS3(Aws::String&& value) { m_inputDataLocationS3 = std::move(value); } /** *

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

*/ inline void SetInputDataLocationS3(const char* value) { m_inputDataLocationS3.assign(value); } /** *

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

*/ inline GetEvaluationResult& WithInputDataLocationS3(const Aws::String& value) { SetInputDataLocationS3(value); return *this;} /** *

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

*/ inline GetEvaluationResult& WithInputDataLocationS3(Aws::String&& value) { SetInputDataLocationS3(std::move(value)); return *this;} /** *

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

*/ inline GetEvaluationResult& WithInputDataLocationS3(const char* value) { SetInputDataLocationS3(value); return *this;} /** *

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.

*/ inline const Aws::String& GetCreatedByIamUser() const{ return m_createdByIamUser; } /** *

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.

*/ inline void SetCreatedByIamUser(const Aws::String& value) { m_createdByIamUser = value; } /** *

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.

*/ inline void SetCreatedByIamUser(Aws::String&& value) { m_createdByIamUser = std::move(value); } /** *

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.

*/ inline void SetCreatedByIamUser(const char* value) { m_createdByIamUser.assign(value); } /** *

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.

*/ inline GetEvaluationResult& WithCreatedByIamUser(const Aws::String& value) { SetCreatedByIamUser(value); return *this;} /** *

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.

*/ inline GetEvaluationResult& WithCreatedByIamUser(Aws::String&& value) { SetCreatedByIamUser(std::move(value)); return *this;} /** *

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.

*/ inline GetEvaluationResult& WithCreatedByIamUser(const char* value) { SetCreatedByIamUser(value); return *this;} /** *

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

*/ inline const Aws::Utils::DateTime& GetCreatedAt() const{ return m_createdAt; } /** *

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

*/ inline void SetCreatedAt(const Aws::Utils::DateTime& value) { m_createdAt = value; } /** *

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

*/ inline void SetCreatedAt(Aws::Utils::DateTime&& value) { m_createdAt = std::move(value); } /** *

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

*/ inline GetEvaluationResult& WithCreatedAt(const Aws::Utils::DateTime& value) { SetCreatedAt(value); return *this;} /** *

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

*/ inline GetEvaluationResult& WithCreatedAt(Aws::Utils::DateTime&& value) { SetCreatedAt(std::move(value)); return *this;} /** *

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

*/ inline const Aws::Utils::DateTime& GetLastUpdatedAt() const{ return m_lastUpdatedAt; } /** *

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

*/ inline void SetLastUpdatedAt(const Aws::Utils::DateTime& value) { m_lastUpdatedAt = value; } /** *

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

*/ inline void SetLastUpdatedAt(Aws::Utils::DateTime&& value) { m_lastUpdatedAt = std::move(value); } /** *

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

*/ inline GetEvaluationResult& WithLastUpdatedAt(const Aws::Utils::DateTime& value) { SetLastUpdatedAt(value); return *this;} /** *

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

*/ inline GetEvaluationResult& WithLastUpdatedAt(Aws::Utils::DateTime&& value) { SetLastUpdatedAt(std::move(value)); return *this;} /** *

A user-supplied name or description of the Evaluation.

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

A user-supplied name or description of the Evaluation.

*/ inline void SetName(const Aws::String& value) { m_name = value; } /** *

A user-supplied name or description of the Evaluation.

*/ inline void SetName(Aws::String&& value) { m_name = std::move(value); } /** *

A user-supplied name or description of the Evaluation.

*/ inline void SetName(const char* value) { m_name.assign(value); } /** *

A user-supplied name or description of the Evaluation.

*/ inline GetEvaluationResult& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

A user-supplied name or description of the Evaluation.

*/ inline GetEvaluationResult& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

A user-supplied name or description of the Evaluation.

*/ inline GetEvaluationResult& WithName(const char* value) { SetName(value); return *this;} /** *

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.

*/ inline const EntityStatus& GetStatus() const{ return m_status; } /** *

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.

*/ inline void SetStatus(const EntityStatus& value) { m_status = value; } /** *

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.

*/ inline void SetStatus(EntityStatus&& value) { m_status = std::move(value); } /** *

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.

*/ inline GetEvaluationResult& WithStatus(const EntityStatus& value) { SetStatus(value); return *this;} /** *

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.

*/ inline GetEvaluationResult& WithStatus(EntityStatus&& value) { SetStatus(std::move(value)); return *this;} /** *

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.

*/ inline const PerformanceMetrics& GetPerformanceMetrics() const{ return m_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.

*/ inline void SetPerformanceMetrics(const PerformanceMetrics& value) { m_performanceMetrics = value; } /** *

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.

*/ inline void SetPerformanceMetrics(PerformanceMetrics&& value) { m_performanceMetrics = std::move(value); } /** *

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.

*/ inline GetEvaluationResult& WithPerformanceMetrics(const PerformanceMetrics& value) { SetPerformanceMetrics(value); return *this;} /** *

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.

*/ inline GetEvaluationResult& WithPerformanceMetrics(PerformanceMetrics&& value) { SetPerformanceMetrics(std::move(value)); return *this;} /** *

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

*/ inline const Aws::String& GetLogUri() const{ return m_logUri; } /** *

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

*/ inline void SetLogUri(const Aws::String& value) { m_logUri = value; } /** *

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

*/ inline void SetLogUri(Aws::String&& value) { m_logUri = std::move(value); } /** *

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

*/ inline void SetLogUri(const char* value) { m_logUri.assign(value); } /** *

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

*/ inline GetEvaluationResult& WithLogUri(const Aws::String& value) { SetLogUri(value); return *this;} /** *

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

*/ inline GetEvaluationResult& WithLogUri(Aws::String&& value) { SetLogUri(std::move(value)); return *this;} /** *

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

*/ inline GetEvaluationResult& WithLogUri(const char* value) { SetLogUri(value); return *this;} /** *

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

*/ inline const Aws::String& GetMessage() const{ return m_message; } /** *

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

*/ inline void SetMessage(const Aws::String& value) { m_message = value; } /** *

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

*/ inline void SetMessage(Aws::String&& value) { m_message = std::move(value); } /** *

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

*/ inline void SetMessage(const char* value) { m_message.assign(value); } /** *

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

*/ inline GetEvaluationResult& WithMessage(const Aws::String& value) { SetMessage(value); return *this;} /** *

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

*/ inline GetEvaluationResult& WithMessage(Aws::String&& value) { SetMessage(std::move(value)); return *this;} /** *

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

*/ inline GetEvaluationResult& WithMessage(const char* value) { SetMessage(value); return *this;} /** *

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.

*/ inline long long GetComputeTime() const{ return m_computeTime; } /** *

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.

*/ inline void SetComputeTime(long long value) { m_computeTime = value; } /** *

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.

*/ inline GetEvaluationResult& WithComputeTime(long long value) { SetComputeTime(value); return *this;} /** *

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.

*/ inline const Aws::Utils::DateTime& GetFinishedAt() const{ return m_finishedAt; } /** *

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.

*/ inline void SetFinishedAt(const Aws::Utils::DateTime& value) { m_finishedAt = value; } /** *

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.

*/ inline void SetFinishedAt(Aws::Utils::DateTime&& value) { m_finishedAt = std::move(value); } /** *

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.

*/ inline GetEvaluationResult& WithFinishedAt(const Aws::Utils::DateTime& value) { SetFinishedAt(value); return *this;} /** *

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.

*/ inline GetEvaluationResult& WithFinishedAt(Aws::Utils::DateTime&& value) { SetFinishedAt(std::move(value)); return *this;} /** *

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

*/ inline const Aws::Utils::DateTime& GetStartedAt() const{ return m_startedAt; } /** *

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

*/ inline void SetStartedAt(const Aws::Utils::DateTime& value) { m_startedAt = value; } /** *

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

*/ inline void SetStartedAt(Aws::Utils::DateTime&& value) { m_startedAt = std::move(value); } /** *

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

*/ inline GetEvaluationResult& WithStartedAt(const Aws::Utils::DateTime& value) { SetStartedAt(value); return *this;} /** *

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

*/ inline GetEvaluationResult& WithStartedAt(Aws::Utils::DateTime&& value) { SetStartedAt(std::move(value)); return *this;} inline const Aws::String& GetRequestId() const{ return m_requestId; } inline void SetRequestId(const Aws::String& value) { m_requestId = value; } inline void SetRequestId(Aws::String&& value) { m_requestId = std::move(value); } inline void SetRequestId(const char* value) { m_requestId.assign(value); } inline GetEvaluationResult& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} inline GetEvaluationResult& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} inline GetEvaluationResult& WithRequestId(const char* value) { SetRequestId(value); return *this;} private: Aws::String m_evaluationId; Aws::String m_mLModelId; Aws::String m_evaluationDataSourceId; Aws::String m_inputDataLocationS3; Aws::String m_createdByIamUser; Aws::Utils::DateTime m_createdAt; Aws::Utils::DateTime m_lastUpdatedAt; Aws::String m_name; EntityStatus m_status; PerformanceMetrics m_performanceMetrics; Aws::String m_logUri; Aws::String m_message; long long m_computeTime; Aws::Utils::DateTime m_finishedAt; Aws::Utils::DateTime m_startedAt; Aws::String m_requestId; }; } // namespace Model } // namespace MachineLearning } // namespace Aws