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

Describes an Amazon Lookout for Vision model.

See Also:

AWS * API Reference

*/ class ModelDescription { public: AWS_LOOKOUTFORVISION_API ModelDescription(); AWS_LOOKOUTFORVISION_API ModelDescription(Aws::Utils::Json::JsonView jsonValue); AWS_LOOKOUTFORVISION_API ModelDescription& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_LOOKOUTFORVISION_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The version of the model

*/ inline const Aws::String& GetModelVersion() const{ return m_modelVersion; } /** *

The version of the model

*/ inline bool ModelVersionHasBeenSet() const { return m_modelVersionHasBeenSet; } /** *

The version of the model

*/ inline void SetModelVersion(const Aws::String& value) { m_modelVersionHasBeenSet = true; m_modelVersion = value; } /** *

The version of the model

*/ inline void SetModelVersion(Aws::String&& value) { m_modelVersionHasBeenSet = true; m_modelVersion = std::move(value); } /** *

The version of the model

*/ inline void SetModelVersion(const char* value) { m_modelVersionHasBeenSet = true; m_modelVersion.assign(value); } /** *

The version of the model

*/ inline ModelDescription& WithModelVersion(const Aws::String& value) { SetModelVersion(value); return *this;} /** *

The version of the model

*/ inline ModelDescription& WithModelVersion(Aws::String&& value) { SetModelVersion(std::move(value)); return *this;} /** *

The version of the model

*/ inline ModelDescription& WithModelVersion(const char* value) { SetModelVersion(value); return *this;} /** *

The Amazon Resource Name (ARN) of the model.

*/ inline const Aws::String& GetModelArn() const{ return m_modelArn; } /** *

The Amazon Resource Name (ARN) of the model.

*/ inline bool ModelArnHasBeenSet() const { return m_modelArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the model.

*/ inline void SetModelArn(const Aws::String& value) { m_modelArnHasBeenSet = true; m_modelArn = value; } /** *

The Amazon Resource Name (ARN) of the model.

*/ inline void SetModelArn(Aws::String&& value) { m_modelArnHasBeenSet = true; m_modelArn = std::move(value); } /** *

The Amazon Resource Name (ARN) of the model.

*/ inline void SetModelArn(const char* value) { m_modelArnHasBeenSet = true; m_modelArn.assign(value); } /** *

The Amazon Resource Name (ARN) of the model.

*/ inline ModelDescription& WithModelArn(const Aws::String& value) { SetModelArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the model.

*/ inline ModelDescription& WithModelArn(Aws::String&& value) { SetModelArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the model.

*/ inline ModelDescription& WithModelArn(const char* value) { SetModelArn(value); return *this;} /** *

The unix timestamp for the date and time that the model was created.

*/ inline const Aws::Utils::DateTime& GetCreationTimestamp() const{ return m_creationTimestamp; } /** *

The unix timestamp for the date and time that the model was created.

*/ inline bool CreationTimestampHasBeenSet() const { return m_creationTimestampHasBeenSet; } /** *

The unix timestamp for the date and time that the model was created.

*/ inline void SetCreationTimestamp(const Aws::Utils::DateTime& value) { m_creationTimestampHasBeenSet = true; m_creationTimestamp = value; } /** *

The unix timestamp for the date and time that the model was created.

*/ inline void SetCreationTimestamp(Aws::Utils::DateTime&& value) { m_creationTimestampHasBeenSet = true; m_creationTimestamp = std::move(value); } /** *

The unix timestamp for the date and time that the model was created.

*/ inline ModelDescription& WithCreationTimestamp(const Aws::Utils::DateTime& value) { SetCreationTimestamp(value); return *this;} /** *

The unix timestamp for the date and time that the model was created.

*/ inline ModelDescription& WithCreationTimestamp(Aws::Utils::DateTime&& value) { SetCreationTimestamp(std::move(value)); return *this;} /** *

The description for the model.

*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *

The description for the model.

*/ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *

The description for the model.

*/ inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *

The description for the model.

*/ inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *

The description for the model.

*/ inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *

The description for the model.

*/ inline ModelDescription& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

The description for the model.

*/ inline ModelDescription& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *

The description for the model.

*/ inline ModelDescription& WithDescription(const char* value) { SetDescription(value); return *this;} /** *

The status of the model.

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

The status of the model.

*/ inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; } /** *

The status of the model.

*/ inline void SetStatus(const ModelStatus& value) { m_statusHasBeenSet = true; m_status = value; } /** *

The status of the model.

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

The status of the model.

*/ inline ModelDescription& WithStatus(const ModelStatus& value) { SetStatus(value); return *this;} /** *

The status of the model.

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

The status message for the model.

*/ inline const Aws::String& GetStatusMessage() const{ return m_statusMessage; } /** *

The status message for the model.

*/ inline bool StatusMessageHasBeenSet() const { return m_statusMessageHasBeenSet; } /** *

The status message for the model.

*/ inline void SetStatusMessage(const Aws::String& value) { m_statusMessageHasBeenSet = true; m_statusMessage = value; } /** *

The status message for the model.

*/ inline void SetStatusMessage(Aws::String&& value) { m_statusMessageHasBeenSet = true; m_statusMessage = std::move(value); } /** *

The status message for the model.

*/ inline void SetStatusMessage(const char* value) { m_statusMessageHasBeenSet = true; m_statusMessage.assign(value); } /** *

The status message for the model.

*/ inline ModelDescription& WithStatusMessage(const Aws::String& value) { SetStatusMessage(value); return *this;} /** *

The status message for the model.

*/ inline ModelDescription& WithStatusMessage(Aws::String&& value) { SetStatusMessage(std::move(value)); return *this;} /** *

The status message for the model.

*/ inline ModelDescription& WithStatusMessage(const char* value) { SetStatusMessage(value); return *this;} /** *

Performance metrics for the model. Created during training.

*/ inline const ModelPerformance& GetPerformance() const{ return m_performance; } /** *

Performance metrics for the model. Created during training.

*/ inline bool PerformanceHasBeenSet() const { return m_performanceHasBeenSet; } /** *

Performance metrics for the model. Created during training.

*/ inline void SetPerformance(const ModelPerformance& value) { m_performanceHasBeenSet = true; m_performance = value; } /** *

Performance metrics for the model. Created during training.

*/ inline void SetPerformance(ModelPerformance&& value) { m_performanceHasBeenSet = true; m_performance = std::move(value); } /** *

Performance metrics for the model. Created during training.

*/ inline ModelDescription& WithPerformance(const ModelPerformance& value) { SetPerformance(value); return *this;} /** *

Performance metrics for the model. Created during training.

*/ inline ModelDescription& WithPerformance(ModelPerformance&& value) { SetPerformance(std::move(value)); return *this;} /** *

The S3 location where Amazon Lookout for Vision saves model training * files.

*/ inline const OutputConfig& GetOutputConfig() const{ return m_outputConfig; } /** *

The S3 location where Amazon Lookout for Vision saves model training * files.

*/ inline bool OutputConfigHasBeenSet() const { return m_outputConfigHasBeenSet; } /** *

The S3 location where Amazon Lookout for Vision saves model training * files.

*/ inline void SetOutputConfig(const OutputConfig& value) { m_outputConfigHasBeenSet = true; m_outputConfig = value; } /** *

The S3 location where Amazon Lookout for Vision saves model training * files.

*/ inline void SetOutputConfig(OutputConfig&& value) { m_outputConfigHasBeenSet = true; m_outputConfig = std::move(value); } /** *

The S3 location where Amazon Lookout for Vision saves model training * files.

*/ inline ModelDescription& WithOutputConfig(const OutputConfig& value) { SetOutputConfig(value); return *this;} /** *

The S3 location where Amazon Lookout for Vision saves model training * files.

*/ inline ModelDescription& WithOutputConfig(OutputConfig&& value) { SetOutputConfig(std::move(value)); return *this;} /** *

The S3 location where Amazon Lookout for Vision saves the manifest file that * was used to test the trained model and generate the performance scores.

*/ inline const OutputS3Object& GetEvaluationManifest() const{ return m_evaluationManifest; } /** *

The S3 location where Amazon Lookout for Vision saves the manifest file that * was used to test the trained model and generate the performance scores.

*/ inline bool EvaluationManifestHasBeenSet() const { return m_evaluationManifestHasBeenSet; } /** *

The S3 location where Amazon Lookout for Vision saves the manifest file that * was used to test the trained model and generate the performance scores.

*/ inline void SetEvaluationManifest(const OutputS3Object& value) { m_evaluationManifestHasBeenSet = true; m_evaluationManifest = value; } /** *

The S3 location where Amazon Lookout for Vision saves the manifest file that * was used to test the trained model and generate the performance scores.

*/ inline void SetEvaluationManifest(OutputS3Object&& value) { m_evaluationManifestHasBeenSet = true; m_evaluationManifest = std::move(value); } /** *

The S3 location where Amazon Lookout for Vision saves the manifest file that * was used to test the trained model and generate the performance scores.

*/ inline ModelDescription& WithEvaluationManifest(const OutputS3Object& value) { SetEvaluationManifest(value); return *this;} /** *

The S3 location where Amazon Lookout for Vision saves the manifest file that * was used to test the trained model and generate the performance scores.

*/ inline ModelDescription& WithEvaluationManifest(OutputS3Object&& value) { SetEvaluationManifest(std::move(value)); return *this;} /** *

The S3 location where Amazon Lookout for Vision saves the performance * metrics.

*/ inline const OutputS3Object& GetEvaluationResult() const{ return m_evaluationResult; } /** *

The S3 location where Amazon Lookout for Vision saves the performance * metrics.

*/ inline bool EvaluationResultHasBeenSet() const { return m_evaluationResultHasBeenSet; } /** *

The S3 location where Amazon Lookout for Vision saves the performance * metrics.

*/ inline void SetEvaluationResult(const OutputS3Object& value) { m_evaluationResultHasBeenSet = true; m_evaluationResult = value; } /** *

The S3 location where Amazon Lookout for Vision saves the performance * metrics.

*/ inline void SetEvaluationResult(OutputS3Object&& value) { m_evaluationResultHasBeenSet = true; m_evaluationResult = std::move(value); } /** *

The S3 location where Amazon Lookout for Vision saves the performance * metrics.

*/ inline ModelDescription& WithEvaluationResult(const OutputS3Object& value) { SetEvaluationResult(value); return *this;} /** *

The S3 location where Amazon Lookout for Vision saves the performance * metrics.

*/ inline ModelDescription& WithEvaluationResult(OutputS3Object&& value) { SetEvaluationResult(std::move(value)); return *this;} /** *

The unix timestamp for the date and time that the evaluation ended.

*/ inline const Aws::Utils::DateTime& GetEvaluationEndTimestamp() const{ return m_evaluationEndTimestamp; } /** *

The unix timestamp for the date and time that the evaluation ended.

*/ inline bool EvaluationEndTimestampHasBeenSet() const { return m_evaluationEndTimestampHasBeenSet; } /** *

The unix timestamp for the date and time that the evaluation ended.

*/ inline void SetEvaluationEndTimestamp(const Aws::Utils::DateTime& value) { m_evaluationEndTimestampHasBeenSet = true; m_evaluationEndTimestamp = value; } /** *

The unix timestamp for the date and time that the evaluation ended.

*/ inline void SetEvaluationEndTimestamp(Aws::Utils::DateTime&& value) { m_evaluationEndTimestampHasBeenSet = true; m_evaluationEndTimestamp = std::move(value); } /** *

The unix timestamp for the date and time that the evaluation ended.

*/ inline ModelDescription& WithEvaluationEndTimestamp(const Aws::Utils::DateTime& value) { SetEvaluationEndTimestamp(value); return *this;} /** *

The unix timestamp for the date and time that the evaluation ended.

*/ inline ModelDescription& WithEvaluationEndTimestamp(Aws::Utils::DateTime&& value) { SetEvaluationEndTimestamp(std::move(value)); return *this;} /** *

The identifer for the AWS Key Management Service (AWS KMS) key that was used * to encrypt the model during training.

*/ inline const Aws::String& GetKmsKeyId() const{ return m_kmsKeyId; } /** *

The identifer for the AWS Key Management Service (AWS KMS) key that was used * to encrypt the model during training.

*/ inline bool KmsKeyIdHasBeenSet() const { return m_kmsKeyIdHasBeenSet; } /** *

The identifer for the AWS Key Management Service (AWS KMS) key that was used * to encrypt the model during training.

*/ inline void SetKmsKeyId(const Aws::String& value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId = value; } /** *

The identifer for the AWS Key Management Service (AWS KMS) key that was used * to encrypt the model during training.

*/ inline void SetKmsKeyId(Aws::String&& value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId = std::move(value); } /** *

The identifer for the AWS Key Management Service (AWS KMS) key that was used * to encrypt the model during training.

*/ inline void SetKmsKeyId(const char* value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId.assign(value); } /** *

The identifer for the AWS Key Management Service (AWS KMS) key that was used * to encrypt the model during training.

*/ inline ModelDescription& WithKmsKeyId(const Aws::String& value) { SetKmsKeyId(value); return *this;} /** *

The identifer for the AWS Key Management Service (AWS KMS) key that was used * to encrypt the model during training.

*/ inline ModelDescription& WithKmsKeyId(Aws::String&& value) { SetKmsKeyId(std::move(value)); return *this;} /** *

The identifer for the AWS Key Management Service (AWS KMS) key that was used * to encrypt the model during training.

*/ inline ModelDescription& WithKmsKeyId(const char* value) { SetKmsKeyId(value); return *this;} /** *

The minimum number of inference units used by the model. For more * information, see StartModel

*/ inline int GetMinInferenceUnits() const{ return m_minInferenceUnits; } /** *

The minimum number of inference units used by the model. For more * information, see StartModel

*/ inline bool MinInferenceUnitsHasBeenSet() const { return m_minInferenceUnitsHasBeenSet; } /** *

The minimum number of inference units used by the model. For more * information, see StartModel

*/ inline void SetMinInferenceUnits(int value) { m_minInferenceUnitsHasBeenSet = true; m_minInferenceUnits = value; } /** *

The minimum number of inference units used by the model. For more * information, see StartModel

*/ inline ModelDescription& WithMinInferenceUnits(int value) { SetMinInferenceUnits(value); return *this;} /** *

The maximum number of inference units Amazon Lookout for Vision uses to * auto-scale the model. For more information, see StartModel.

*/ inline int GetMaxInferenceUnits() const{ return m_maxInferenceUnits; } /** *

The maximum number of inference units Amazon Lookout for Vision uses to * auto-scale the model. For more information, see StartModel.

*/ inline bool MaxInferenceUnitsHasBeenSet() const { return m_maxInferenceUnitsHasBeenSet; } /** *

The maximum number of inference units Amazon Lookout for Vision uses to * auto-scale the model. For more information, see StartModel.

*/ inline void SetMaxInferenceUnits(int value) { m_maxInferenceUnitsHasBeenSet = true; m_maxInferenceUnits = value; } /** *

The maximum number of inference units Amazon Lookout for Vision uses to * auto-scale the model. For more information, see StartModel.

*/ inline ModelDescription& WithMaxInferenceUnits(int value) { SetMaxInferenceUnits(value); return *this;} private: Aws::String m_modelVersion; bool m_modelVersionHasBeenSet = false; Aws::String m_modelArn; bool m_modelArnHasBeenSet = false; Aws::Utils::DateTime m_creationTimestamp; bool m_creationTimestampHasBeenSet = false; Aws::String m_description; bool m_descriptionHasBeenSet = false; ModelStatus m_status; bool m_statusHasBeenSet = false; Aws::String m_statusMessage; bool m_statusMessageHasBeenSet = false; ModelPerformance m_performance; bool m_performanceHasBeenSet = false; OutputConfig m_outputConfig; bool m_outputConfigHasBeenSet = false; OutputS3Object m_evaluationManifest; bool m_evaluationManifestHasBeenSet = false; OutputS3Object m_evaluationResult; bool m_evaluationResultHasBeenSet = false; Aws::Utils::DateTime m_evaluationEndTimestamp; bool m_evaluationEndTimestampHasBeenSet = false; Aws::String m_kmsKeyId; bool m_kmsKeyIdHasBeenSet = false; int m_minInferenceUnits; bool m_minInferenceUnitsHasBeenSet = false; int m_maxInferenceUnits; bool m_maxInferenceUnitsHasBeenSet = false; }; } // namespace Model } // namespace LookoutforVision } // namespace Aws