/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/comprehend/Comprehend_EXPORTS.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/comprehend/model/LanguageCode.h>
#include <aws/comprehend/model/ModelStatus.h>
#include <aws/core/utils/DateTime.h>
#include <aws/comprehend/model/DocumentClassifierInputDataConfig.h>
#include <aws/comprehend/model/DocumentClassifierOutputDataConfig.h>
#include <aws/comprehend/model/ClassifierMetadata.h>
#include <aws/comprehend/model/VpcConfig.h>
#include <aws/comprehend/model/DocumentClassifierMode.h>
#include <utility>
namespace Aws
{
namespace Utils
{
namespace Json
{
class JsonValue;
class JsonView;
} // namespace Json
} // namespace Utils
namespace Comprehend
{
namespace Model
{
/**
* <p>Provides information about a document classifier.</p><p><h3>See Also:</h3>
* <a
* href="http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierProperties">AWS
* API Reference</a></p>
*/
class DocumentClassifierProperties
{
public:
AWS_COMPREHEND_API DocumentClassifierProperties();
AWS_COMPREHEND_API DocumentClassifierProperties(Aws::Utils::Json::JsonView jsonValue);
AWS_COMPREHEND_API DocumentClassifierProperties& operator=(Aws::Utils::Json::JsonView jsonValue);
AWS_COMPREHEND_API Aws::Utils::Json::JsonValue Jsonize() const;
/**
* <p>The Amazon Resource Name (ARN) that identifies the document classifier.</p>
*/
inline const Aws::String& GetDocumentClassifierArn() const{ return m_documentClassifierArn; }
/**
* <p>The Amazon Resource Name (ARN) that identifies the document classifier.</p>
*/
inline bool DocumentClassifierArnHasBeenSet() const { return m_documentClassifierArnHasBeenSet; }
/**
* <p>The Amazon Resource Name (ARN) that identifies the document classifier.</p>
*/
inline void SetDocumentClassifierArn(const Aws::String& value) { m_documentClassifierArnHasBeenSet = true; m_documentClassifierArn = value; }
/**
* <p>The Amazon Resource Name (ARN) that identifies the document classifier.</p>
*/
inline void SetDocumentClassifierArn(Aws::String&& value) { m_documentClassifierArnHasBeenSet = true; m_documentClassifierArn = std::move(value); }
/**
* <p>The Amazon Resource Name (ARN) that identifies the document classifier.</p>
*/
inline void SetDocumentClassifierArn(const char* value) { m_documentClassifierArnHasBeenSet = true; m_documentClassifierArn.assign(value); }
/**
* <p>The Amazon Resource Name (ARN) that identifies the document classifier.</p>
*/
inline DocumentClassifierProperties& WithDocumentClassifierArn(const Aws::String& value) { SetDocumentClassifierArn(value); return *this;}
/**
* <p>The Amazon Resource Name (ARN) that identifies the document classifier.</p>
*/
inline DocumentClassifierProperties& WithDocumentClassifierArn(Aws::String&& value) { SetDocumentClassifierArn(std::move(value)); return *this;}
/**
* <p>The Amazon Resource Name (ARN) that identifies the document classifier.</p>
*/
inline DocumentClassifierProperties& WithDocumentClassifierArn(const char* value) { SetDocumentClassifierArn(value); return *this;}
/**
* <p>The language code for the language of the documents that the classifier was
* trained on.</p>
*/
inline const LanguageCode& GetLanguageCode() const{ return m_languageCode; }
/**
* <p>The language code for the language of the documents that the classifier was
* trained on.</p>
*/
inline bool LanguageCodeHasBeenSet() const { return m_languageCodeHasBeenSet; }
/**
* <p>The language code for the language of the documents that the classifier was
* trained on.</p>
*/
inline void SetLanguageCode(const LanguageCode& value) { m_languageCodeHasBeenSet = true; m_languageCode = value; }
/**
* <p>The language code for the language of the documents that the classifier was
* trained on.</p>
*/
inline void SetLanguageCode(LanguageCode&& value) { m_languageCodeHasBeenSet = true; m_languageCode = std::move(value); }
/**
* <p>The language code for the language of the documents that the classifier was
* trained on.</p>
*/
inline DocumentClassifierProperties& WithLanguageCode(const LanguageCode& value) { SetLanguageCode(value); return *this;}
/**
* <p>The language code for the language of the documents that the classifier was
* trained on.</p>
*/
inline DocumentClassifierProperties& WithLanguageCode(LanguageCode&& value) { SetLanguageCode(std::move(value)); return *this;}
/**
* <p>The status of the document classifier. If the status is <code>TRAINED</code>
* the classifier is ready to use. If the status is
* <code>TRAINED_WITH_WARNINGS</code> the classifier training succeeded, but you
* should review the warnings returned in the <code>CreateDocumentClassifier</code>
* response.</p> <p> If the status is <code>FAILED</code> you can see additional
* information about why the classifier wasn't trained in the <code>Message</code>
* field.</p>
*/
inline const ModelStatus& GetStatus() const{ return m_status; }
/**
* <p>The status of the document classifier. If the status is <code>TRAINED</code>
* the classifier is ready to use. If the status is
* <code>TRAINED_WITH_WARNINGS</code> the classifier training succeeded, but you
* should review the warnings returned in the <code>CreateDocumentClassifier</code>
* response.</p> <p> If the status is <code>FAILED</code> you can see additional
* information about why the classifier wasn't trained in the <code>Message</code>
* field.</p>
*/
inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; }
/**
* <p>The status of the document classifier. If the status is <code>TRAINED</code>
* the classifier is ready to use. If the status is
* <code>TRAINED_WITH_WARNINGS</code> the classifier training succeeded, but you
* should review the warnings returned in the <code>CreateDocumentClassifier</code>
* response.</p> <p> If the status is <code>FAILED</code> you can see additional
* information about why the classifier wasn't trained in the <code>Message</code>
* field.</p>
*/
inline void SetStatus(const ModelStatus& value) { m_statusHasBeenSet = true; m_status = value; }
/**
* <p>The status of the document classifier. If the status is <code>TRAINED</code>
* the classifier is ready to use. If the status is
* <code>TRAINED_WITH_WARNINGS</code> the classifier training succeeded, but you
* should review the warnings returned in the <code>CreateDocumentClassifier</code>
* response.</p> <p> If the status is <code>FAILED</code> you can see additional
* information about why the classifier wasn't trained in the <code>Message</code>
* field.</p>
*/
inline void SetStatus(ModelStatus&& value) { m_statusHasBeenSet = true; m_status = std::move(value); }
/**
* <p>The status of the document classifier. If the status is <code>TRAINED</code>
* the classifier is ready to use. If the status is
* <code>TRAINED_WITH_WARNINGS</code> the classifier training succeeded, but you
* should review the warnings returned in the <code>CreateDocumentClassifier</code>
* response.</p> <p> If the status is <code>FAILED</code> you can see additional
* information about why the classifier wasn't trained in the <code>Message</code>
* field.</p>
*/
inline DocumentClassifierProperties& WithStatus(const ModelStatus& value) { SetStatus(value); return *this;}
/**
* <p>The status of the document classifier. If the status is <code>TRAINED</code>
* the classifier is ready to use. If the status is
* <code>TRAINED_WITH_WARNINGS</code> the classifier training succeeded, but you
* should review the warnings returned in the <code>CreateDocumentClassifier</code>
* response.</p> <p> If the status is <code>FAILED</code> you can see additional
* information about why the classifier wasn't trained in the <code>Message</code>
* field.</p>
*/
inline DocumentClassifierProperties& WithStatus(ModelStatus&& value) { SetStatus(std::move(value)); return *this;}
/**
* <p>Additional information about the status of the classifier.</p>
*/
inline const Aws::String& GetMessage() const{ return m_message; }
/**
* <p>Additional information about the status of the classifier.</p>
*/
inline bool MessageHasBeenSet() const { return m_messageHasBeenSet; }
/**
* <p>Additional information about the status of the classifier.</p>
*/
inline void SetMessage(const Aws::String& value) { m_messageHasBeenSet = true; m_message = value; }
/**
* <p>Additional information about the status of the classifier.</p>
*/
inline void SetMessage(Aws::String&& value) { m_messageHasBeenSet = true; m_message = std::move(value); }
/**
* <p>Additional information about the status of the classifier.</p>
*/
inline void SetMessage(const char* value) { m_messageHasBeenSet = true; m_message.assign(value); }
/**
* <p>Additional information about the status of the classifier.</p>
*/
inline DocumentClassifierProperties& WithMessage(const Aws::String& value) { SetMessage(value); return *this;}
/**
* <p>Additional information about the status of the classifier.</p>
*/
inline DocumentClassifierProperties& WithMessage(Aws::String&& value) { SetMessage(std::move(value)); return *this;}
/**
* <p>Additional information about the status of the classifier.</p>
*/
inline DocumentClassifierProperties& WithMessage(const char* value) { SetMessage(value); return *this;}
/**
* <p>The time that the document classifier was submitted for training.</p>
*/
inline const Aws::Utils::DateTime& GetSubmitTime() const{ return m_submitTime; }
/**
* <p>The time that the document classifier was submitted for training.</p>
*/
inline bool SubmitTimeHasBeenSet() const { return m_submitTimeHasBeenSet; }
/**
* <p>The time that the document classifier was submitted for training.</p>
*/
inline void SetSubmitTime(const Aws::Utils::DateTime& value) { m_submitTimeHasBeenSet = true; m_submitTime = value; }
/**
* <p>The time that the document classifier was submitted for training.</p>
*/
inline void SetSubmitTime(Aws::Utils::DateTime&& value) { m_submitTimeHasBeenSet = true; m_submitTime = std::move(value); }
/**
* <p>The time that the document classifier was submitted for training.</p>
*/
inline DocumentClassifierProperties& WithSubmitTime(const Aws::Utils::DateTime& value) { SetSubmitTime(value); return *this;}
/**
* <p>The time that the document classifier was submitted for training.</p>
*/
inline DocumentClassifierProperties& WithSubmitTime(Aws::Utils::DateTime&& value) { SetSubmitTime(std::move(value)); return *this;}
/**
* <p>The time that training the document classifier completed.</p>
*/
inline const Aws::Utils::DateTime& GetEndTime() const{ return m_endTime; }
/**
* <p>The time that training the document classifier completed.</p>
*/
inline bool EndTimeHasBeenSet() const { return m_endTimeHasBeenSet; }
/**
* <p>The time that training the document classifier completed.</p>
*/
inline void SetEndTime(const Aws::Utils::DateTime& value) { m_endTimeHasBeenSet = true; m_endTime = value; }
/**
* <p>The time that training the document classifier completed.</p>
*/
inline void SetEndTime(Aws::Utils::DateTime&& value) { m_endTimeHasBeenSet = true; m_endTime = std::move(value); }
/**
* <p>The time that training the document classifier completed.</p>
*/
inline DocumentClassifierProperties& WithEndTime(const Aws::Utils::DateTime& value) { SetEndTime(value); return *this;}
/**
* <p>The time that training the document classifier completed.</p>
*/
inline DocumentClassifierProperties& WithEndTime(Aws::Utils::DateTime&& value) { SetEndTime(std::move(value)); return *this;}
/**
* <p>Indicates the time when the training starts on documentation classifiers. You
* are billed for the time interval between this time and the value of
* TrainingEndTime. </p>
*/
inline const Aws::Utils::DateTime& GetTrainingStartTime() const{ return m_trainingStartTime; }
/**
* <p>Indicates the time when the training starts on documentation classifiers. You
* are billed for the time interval between this time and the value of
* TrainingEndTime. </p>
*/
inline bool TrainingStartTimeHasBeenSet() const { return m_trainingStartTimeHasBeenSet; }
/**
* <p>Indicates the time when the training starts on documentation classifiers. You
* are billed for the time interval between this time and the value of
* TrainingEndTime. </p>
*/
inline void SetTrainingStartTime(const Aws::Utils::DateTime& value) { m_trainingStartTimeHasBeenSet = true; m_trainingStartTime = value; }
/**
* <p>Indicates the time when the training starts on documentation classifiers. You
* are billed for the time interval between this time and the value of
* TrainingEndTime. </p>
*/
inline void SetTrainingStartTime(Aws::Utils::DateTime&& value) { m_trainingStartTimeHasBeenSet = true; m_trainingStartTime = std::move(value); }
/**
* <p>Indicates the time when the training starts on documentation classifiers. You
* are billed for the time interval between this time and the value of
* TrainingEndTime. </p>
*/
inline DocumentClassifierProperties& WithTrainingStartTime(const Aws::Utils::DateTime& value) { SetTrainingStartTime(value); return *this;}
/**
* <p>Indicates the time when the training starts on documentation classifiers. You
* are billed for the time interval between this time and the value of
* TrainingEndTime. </p>
*/
inline DocumentClassifierProperties& WithTrainingStartTime(Aws::Utils::DateTime&& value) { SetTrainingStartTime(std::move(value)); return *this;}
/**
* <p>The time that training of the document classifier was completed. Indicates
* the time when the training completes on documentation classifiers. You are
* billed for the time interval between this time and the value of
* TrainingStartTime.</p>
*/
inline const Aws::Utils::DateTime& GetTrainingEndTime() const{ return m_trainingEndTime; }
/**
* <p>The time that training of the document classifier was completed. Indicates
* the time when the training completes on documentation classifiers. You are
* billed for the time interval between this time and the value of
* TrainingStartTime.</p>
*/
inline bool TrainingEndTimeHasBeenSet() const { return m_trainingEndTimeHasBeenSet; }
/**
* <p>The time that training of the document classifier was completed. Indicates
* the time when the training completes on documentation classifiers. You are
* billed for the time interval between this time and the value of
* TrainingStartTime.</p>
*/
inline void SetTrainingEndTime(const Aws::Utils::DateTime& value) { m_trainingEndTimeHasBeenSet = true; m_trainingEndTime = value; }
/**
* <p>The time that training of the document classifier was completed. Indicates
* the time when the training completes on documentation classifiers. You are
* billed for the time interval between this time and the value of
* TrainingStartTime.</p>
*/
inline void SetTrainingEndTime(Aws::Utils::DateTime&& value) { m_trainingEndTimeHasBeenSet = true; m_trainingEndTime = std::move(value); }
/**
* <p>The time that training of the document classifier was completed. Indicates
* the time when the training completes on documentation classifiers. You are
* billed for the time interval between this time and the value of
* TrainingStartTime.</p>
*/
inline DocumentClassifierProperties& WithTrainingEndTime(const Aws::Utils::DateTime& value) { SetTrainingEndTime(value); return *this;}
/**
* <p>The time that training of the document classifier was completed. Indicates
* the time when the training completes on documentation classifiers. You are
* billed for the time interval between this time and the value of
* TrainingStartTime.</p>
*/
inline DocumentClassifierProperties& WithTrainingEndTime(Aws::Utils::DateTime&& value) { SetTrainingEndTime(std::move(value)); return *this;}
/**
* <p>The input data configuration that you supplied when you created the document
* classifier for training.</p>
*/
inline const DocumentClassifierInputDataConfig& GetInputDataConfig() const{ return m_inputDataConfig; }
/**
* <p>The input data configuration that you supplied when you created the document
* classifier for training.</p>
*/
inline bool InputDataConfigHasBeenSet() const { return m_inputDataConfigHasBeenSet; }
/**
* <p>The input data configuration that you supplied when you created the document
* classifier for training.</p>
*/
inline void SetInputDataConfig(const DocumentClassifierInputDataConfig& value) { m_inputDataConfigHasBeenSet = true; m_inputDataConfig = value; }
/**
* <p>The input data configuration that you supplied when you created the document
* classifier for training.</p>
*/
inline void SetInputDataConfig(DocumentClassifierInputDataConfig&& value) { m_inputDataConfigHasBeenSet = true; m_inputDataConfig = std::move(value); }
/**
* <p>The input data configuration that you supplied when you created the document
* classifier for training.</p>
*/
inline DocumentClassifierProperties& WithInputDataConfig(const DocumentClassifierInputDataConfig& value) { SetInputDataConfig(value); return *this;}
/**
* <p>The input data configuration that you supplied when you created the document
* classifier for training.</p>
*/
inline DocumentClassifierProperties& WithInputDataConfig(DocumentClassifierInputDataConfig&& value) { SetInputDataConfig(std::move(value)); return *this;}
/**
* <p> Provides output results configuration parameters for custom classifier
* jobs.</p>
*/
inline const DocumentClassifierOutputDataConfig& GetOutputDataConfig() const{ return m_outputDataConfig; }
/**
* <p> Provides output results configuration parameters for custom classifier
* jobs.</p>
*/
inline bool OutputDataConfigHasBeenSet() const { return m_outputDataConfigHasBeenSet; }
/**
* <p> Provides output results configuration parameters for custom classifier
* jobs.</p>
*/
inline void SetOutputDataConfig(const DocumentClassifierOutputDataConfig& value) { m_outputDataConfigHasBeenSet = true; m_outputDataConfig = value; }
/**
* <p> Provides output results configuration parameters for custom classifier
* jobs.</p>
*/
inline void SetOutputDataConfig(DocumentClassifierOutputDataConfig&& value) { m_outputDataConfigHasBeenSet = true; m_outputDataConfig = std::move(value); }
/**
* <p> Provides output results configuration parameters for custom classifier
* jobs.</p>
*/
inline DocumentClassifierProperties& WithOutputDataConfig(const DocumentClassifierOutputDataConfig& value) { SetOutputDataConfig(value); return *this;}
/**
* <p> Provides output results configuration parameters for custom classifier
* jobs.</p>
*/
inline DocumentClassifierProperties& WithOutputDataConfig(DocumentClassifierOutputDataConfig&& value) { SetOutputDataConfig(std::move(value)); return *this;}
/**
* <p>Information about the document classifier, including the number of documents
* used for training the classifier, the number of documents used for test the
* classifier, and an accuracy rating.</p>
*/
inline const ClassifierMetadata& GetClassifierMetadata() const{ return m_classifierMetadata; }
/**
* <p>Information about the document classifier, including the number of documents
* used for training the classifier, the number of documents used for test the
* classifier, and an accuracy rating.</p>
*/
inline bool ClassifierMetadataHasBeenSet() const { return m_classifierMetadataHasBeenSet; }
/**
* <p>Information about the document classifier, including the number of documents
* used for training the classifier, the number of documents used for test the
* classifier, and an accuracy rating.</p>
*/
inline void SetClassifierMetadata(const ClassifierMetadata& value) { m_classifierMetadataHasBeenSet = true; m_classifierMetadata = value; }
/**
* <p>Information about the document classifier, including the number of documents
* used for training the classifier, the number of documents used for test the
* classifier, and an accuracy rating.</p>
*/
inline void SetClassifierMetadata(ClassifierMetadata&& value) { m_classifierMetadataHasBeenSet = true; m_classifierMetadata = std::move(value); }
/**
* <p>Information about the document classifier, including the number of documents
* used for training the classifier, the number of documents used for test the
* classifier, and an accuracy rating.</p>
*/
inline DocumentClassifierProperties& WithClassifierMetadata(const ClassifierMetadata& value) { SetClassifierMetadata(value); return *this;}
/**
* <p>Information about the document classifier, including the number of documents
* used for training the classifier, the number of documents used for test the
* classifier, and an accuracy rating.</p>
*/
inline DocumentClassifierProperties& WithClassifierMetadata(ClassifierMetadata&& value) { SetClassifierMetadata(std::move(value)); return *this;}
/**
* <p>The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
* read access to your input data.</p>
*/
inline const Aws::String& GetDataAccessRoleArn() const{ return m_dataAccessRoleArn; }
/**
* <p>The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
* read access to your input data.</p>
*/
inline bool DataAccessRoleArnHasBeenSet() const { return m_dataAccessRoleArnHasBeenSet; }
/**
* <p>The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
* read access to your input data.</p>
*/
inline void SetDataAccessRoleArn(const Aws::String& value) { m_dataAccessRoleArnHasBeenSet = true; m_dataAccessRoleArn = value; }
/**
* <p>The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
* read access to your input data.</p>
*/
inline void SetDataAccessRoleArn(Aws::String&& value) { m_dataAccessRoleArnHasBeenSet = true; m_dataAccessRoleArn = std::move(value); }
/**
* <p>The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
* read access to your input data.</p>
*/
inline void SetDataAccessRoleArn(const char* value) { m_dataAccessRoleArnHasBeenSet = true; m_dataAccessRoleArn.assign(value); }
/**
* <p>The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
* read access to your input data.</p>
*/
inline DocumentClassifierProperties& WithDataAccessRoleArn(const Aws::String& value) { SetDataAccessRoleArn(value); return *this;}
/**
* <p>The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
* read access to your input data.</p>
*/
inline DocumentClassifierProperties& WithDataAccessRoleArn(Aws::String&& value) { SetDataAccessRoleArn(std::move(value)); return *this;}
/**
* <p>The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend
* read access to your input data.</p>
*/
inline DocumentClassifierProperties& WithDataAccessRoleArn(const char* value) { SetDataAccessRoleArn(value); return *this;}
/**
* <p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
* Comprehend uses to encrypt data on the storage volume attached to the ML compute
* instance(s) that process the analysis job. The VolumeKmsKeyId can be either of
* the following formats:</p> <ul> <li> <p>KMS Key ID:
* <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code> </p> </li> <li> <p>Amazon
* Resource Name (ARN) of a KMS Key:
* <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code>
* </p> </li> </ul>
*/
inline const Aws::String& GetVolumeKmsKeyId() const{ return m_volumeKmsKeyId; }
/**
* <p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
* Comprehend uses to encrypt data on the storage volume attached to the ML compute
* instance(s) that process the analysis job. The VolumeKmsKeyId can be either of
* the following formats:</p> <ul> <li> <p>KMS Key ID:
* <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code> </p> </li> <li> <p>Amazon
* Resource Name (ARN) of a KMS Key:
* <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code>
* </p> </li> </ul>
*/
inline bool VolumeKmsKeyIdHasBeenSet() const { return m_volumeKmsKeyIdHasBeenSet; }
/**
* <p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
* Comprehend uses to encrypt data on the storage volume attached to the ML compute
* instance(s) that process the analysis job. The VolumeKmsKeyId can be either of
* the following formats:</p> <ul> <li> <p>KMS Key ID:
* <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code> </p> </li> <li> <p>Amazon
* Resource Name (ARN) of a KMS Key:
* <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code>
* </p> </li> </ul>
*/
inline void SetVolumeKmsKeyId(const Aws::String& value) { m_volumeKmsKeyIdHasBeenSet = true; m_volumeKmsKeyId = value; }
/**
* <p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
* Comprehend uses to encrypt data on the storage volume attached to the ML compute
* instance(s) that process the analysis job. The VolumeKmsKeyId can be either of
* the following formats:</p> <ul> <li> <p>KMS Key ID:
* <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code> </p> </li> <li> <p>Amazon
* Resource Name (ARN) of a KMS Key:
* <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code>
* </p> </li> </ul>
*/
inline void SetVolumeKmsKeyId(Aws::String&& value) { m_volumeKmsKeyIdHasBeenSet = true; m_volumeKmsKeyId = std::move(value); }
/**
* <p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
* Comprehend uses to encrypt data on the storage volume attached to the ML compute
* instance(s) that process the analysis job. The VolumeKmsKeyId can be either of
* the following formats:</p> <ul> <li> <p>KMS Key ID:
* <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code> </p> </li> <li> <p>Amazon
* Resource Name (ARN) of a KMS Key:
* <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code>
* </p> </li> </ul>
*/
inline void SetVolumeKmsKeyId(const char* value) { m_volumeKmsKeyIdHasBeenSet = true; m_volumeKmsKeyId.assign(value); }
/**
* <p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
* Comprehend uses to encrypt data on the storage volume attached to the ML compute
* instance(s) that process the analysis job. The VolumeKmsKeyId can be either of
* the following formats:</p> <ul> <li> <p>KMS Key ID:
* <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code> </p> </li> <li> <p>Amazon
* Resource Name (ARN) of a KMS Key:
* <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code>
* </p> </li> </ul>
*/
inline DocumentClassifierProperties& WithVolumeKmsKeyId(const Aws::String& value) { SetVolumeKmsKeyId(value); return *this;}
/**
* <p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
* Comprehend uses to encrypt data on the storage volume attached to the ML compute
* instance(s) that process the analysis job. The VolumeKmsKeyId can be either of
* the following formats:</p> <ul> <li> <p>KMS Key ID:
* <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code> </p> </li> <li> <p>Amazon
* Resource Name (ARN) of a KMS Key:
* <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code>
* </p> </li> </ul>
*/
inline DocumentClassifierProperties& WithVolumeKmsKeyId(Aws::String&& value) { SetVolumeKmsKeyId(std::move(value)); return *this;}
/**
* <p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon
* Comprehend uses to encrypt data on the storage volume attached to the ML compute
* instance(s) that process the analysis job. The VolumeKmsKeyId can be either of
* the following formats:</p> <ul> <li> <p>KMS Key ID:
* <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code> </p> </li> <li> <p>Amazon
* Resource Name (ARN) of a KMS Key:
* <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code>
* </p> </li> </ul>
*/
inline DocumentClassifierProperties& WithVolumeKmsKeyId(const char* value) { SetVolumeKmsKeyId(value); return *this;}
/**
* <p> Configuration parameters for a private Virtual Private Cloud (VPC)
* containing the resources you are using for your custom classifier. For more
* information, see <a
* href="https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html">Amazon
* VPC</a>. </p>
*/
inline const VpcConfig& GetVpcConfig() const{ return m_vpcConfig; }
/**
* <p> Configuration parameters for a private Virtual Private Cloud (VPC)
* containing the resources you are using for your custom classifier. For more
* information, see <a
* href="https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html">Amazon
* VPC</a>. </p>
*/
inline bool VpcConfigHasBeenSet() const { return m_vpcConfigHasBeenSet; }
/**
* <p> Configuration parameters for a private Virtual Private Cloud (VPC)
* containing the resources you are using for your custom classifier. For more
* information, see <a
* href="https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html">Amazon
* VPC</a>. </p>
*/
inline void SetVpcConfig(const VpcConfig& value) { m_vpcConfigHasBeenSet = true; m_vpcConfig = value; }
/**
* <p> Configuration parameters for a private Virtual Private Cloud (VPC)
* containing the resources you are using for your custom classifier. For more
* information, see <a
* href="https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html">Amazon
* VPC</a>. </p>
*/
inline void SetVpcConfig(VpcConfig&& value) { m_vpcConfigHasBeenSet = true; m_vpcConfig = std::move(value); }
/**
* <p> Configuration parameters for a private Virtual Private Cloud (VPC)
* containing the resources you are using for your custom classifier. For more
* information, see <a
* href="https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html">Amazon
* VPC</a>. </p>
*/
inline DocumentClassifierProperties& WithVpcConfig(const VpcConfig& value) { SetVpcConfig(value); return *this;}
/**
* <p> Configuration parameters for a private Virtual Private Cloud (VPC)
* containing the resources you are using for your custom classifier. For more
* information, see <a
* href="https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html">Amazon
* VPC</a>. </p>
*/
inline DocumentClassifierProperties& WithVpcConfig(VpcConfig&& value) { SetVpcConfig(std::move(value)); return *this;}
/**
* <p>Indicates the mode in which the specific classifier was trained. This also
* indicates the format of input documents and the format of the confusion matrix.
* Each classifier can only be trained in one mode and this cannot be changed once
* the classifier is trained.</p>
*/
inline const DocumentClassifierMode& GetMode() const{ return m_mode; }
/**
* <p>Indicates the mode in which the specific classifier was trained. This also
* indicates the format of input documents and the format of the confusion matrix.
* Each classifier can only be trained in one mode and this cannot be changed once
* the classifier is trained.</p>
*/
inline bool ModeHasBeenSet() const { return m_modeHasBeenSet; }
/**
* <p>Indicates the mode in which the specific classifier was trained. This also
* indicates the format of input documents and the format of the confusion matrix.
* Each classifier can only be trained in one mode and this cannot be changed once
* the classifier is trained.</p>
*/
inline void SetMode(const DocumentClassifierMode& value) { m_modeHasBeenSet = true; m_mode = value; }
/**
* <p>Indicates the mode in which the specific classifier was trained. This also
* indicates the format of input documents and the format of the confusion matrix.
* Each classifier can only be trained in one mode and this cannot be changed once
* the classifier is trained.</p>
*/
inline void SetMode(DocumentClassifierMode&& value) { m_modeHasBeenSet = true; m_mode = std::move(value); }
/**
* <p>Indicates the mode in which the specific classifier was trained. This also
* indicates the format of input documents and the format of the confusion matrix.
* Each classifier can only be trained in one mode and this cannot be changed once
* the classifier is trained.</p>
*/
inline DocumentClassifierProperties& WithMode(const DocumentClassifierMode& value) { SetMode(value); return *this;}
/**
* <p>Indicates the mode in which the specific classifier was trained. This also
* indicates the format of input documents and the format of the confusion matrix.
* Each classifier can only be trained in one mode and this cannot be changed once
* the classifier is trained.</p>
*/
inline DocumentClassifierProperties& WithMode(DocumentClassifierMode&& value) { SetMode(std::move(value)); return *this;}
/**
* <p>ID for the KMS key that Amazon Comprehend uses to encrypt trained custom
* models. The ModelKmsKeyId can be either of the following formats:</p> <ul> <li>
* <p>KMS Key ID: <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code> </p> </li>
* <li> <p>Amazon Resource Name (ARN) of a KMS Key:
* <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code>
* </p> </li> </ul>
*/
inline const Aws::String& GetModelKmsKeyId() const{ return m_modelKmsKeyId; }
/**
* <p>ID for the KMS key that Amazon Comprehend uses to encrypt trained custom
* models. The ModelKmsKeyId can be either of the following formats:</p> <ul> <li>
* <p>KMS Key ID: <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code> </p> </li>
* <li> <p>Amazon Resource Name (ARN) of a KMS Key:
* <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code>
* </p> </li> </ul>
*/
inline bool ModelKmsKeyIdHasBeenSet() const { return m_modelKmsKeyIdHasBeenSet; }
/**
* <p>ID for the KMS key that Amazon Comprehend uses to encrypt trained custom
* models. The ModelKmsKeyId can be either of the following formats:</p> <ul> <li>
* <p>KMS Key ID: <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code> </p> </li>
* <li> <p>Amazon Resource Name (ARN) of a KMS Key:
* <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code>
* </p> </li> </ul>
*/
inline void SetModelKmsKeyId(const Aws::String& value) { m_modelKmsKeyIdHasBeenSet = true; m_modelKmsKeyId = value; }
/**
* <p>ID for the KMS key that Amazon Comprehend uses to encrypt trained custom
* models. The ModelKmsKeyId can be either of the following formats:</p> <ul> <li>
* <p>KMS Key ID: <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code> </p> </li>
* <li> <p>Amazon Resource Name (ARN) of a KMS Key:
* <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code>
* </p> </li> </ul>
*/
inline void SetModelKmsKeyId(Aws::String&& value) { m_modelKmsKeyIdHasBeenSet = true; m_modelKmsKeyId = std::move(value); }
/**
* <p>ID for the KMS key that Amazon Comprehend uses to encrypt trained custom
* models. The ModelKmsKeyId can be either of the following formats:</p> <ul> <li>
* <p>KMS Key ID: <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code> </p> </li>
* <li> <p>Amazon Resource Name (ARN) of a KMS Key:
* <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code>
* </p> </li> </ul>
*/
inline void SetModelKmsKeyId(const char* value) { m_modelKmsKeyIdHasBeenSet = true; m_modelKmsKeyId.assign(value); }
/**
* <p>ID for the KMS key that Amazon Comprehend uses to encrypt trained custom
* models. The ModelKmsKeyId can be either of the following formats:</p> <ul> <li>
* <p>KMS Key ID: <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code> </p> </li>
* <li> <p>Amazon Resource Name (ARN) of a KMS Key:
* <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code>
* </p> </li> </ul>
*/
inline DocumentClassifierProperties& WithModelKmsKeyId(const Aws::String& value) { SetModelKmsKeyId(value); return *this;}
/**
* <p>ID for the KMS key that Amazon Comprehend uses to encrypt trained custom
* models. The ModelKmsKeyId can be either of the following formats:</p> <ul> <li>
* <p>KMS Key ID: <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code> </p> </li>
* <li> <p>Amazon Resource Name (ARN) of a KMS Key:
* <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code>
* </p> </li> </ul>
*/
inline DocumentClassifierProperties& WithModelKmsKeyId(Aws::String&& value) { SetModelKmsKeyId(std::move(value)); return *this;}
/**
* <p>ID for the KMS key that Amazon Comprehend uses to encrypt trained custom
* models. The ModelKmsKeyId can be either of the following formats:</p> <ul> <li>
* <p>KMS Key ID: <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code> </p> </li>
* <li> <p>Amazon Resource Name (ARN) of a KMS Key:
* <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code>
* </p> </li> </ul>
*/
inline DocumentClassifierProperties& WithModelKmsKeyId(const char* value) { SetModelKmsKeyId(value); return *this;}
/**
* <p>The version name that you assigned to the document classifier.</p>
*/
inline const Aws::String& GetVersionName() const{ return m_versionName; }
/**
* <p>The version name that you assigned to the document classifier.</p>
*/
inline bool VersionNameHasBeenSet() const { return m_versionNameHasBeenSet; }
/**
* <p>The version name that you assigned to the document classifier.</p>
*/
inline void SetVersionName(const Aws::String& value) { m_versionNameHasBeenSet = true; m_versionName = value; }
/**
* <p>The version name that you assigned to the document classifier.</p>
*/
inline void SetVersionName(Aws::String&& value) { m_versionNameHasBeenSet = true; m_versionName = std::move(value); }
/**
* <p>The version name that you assigned to the document classifier.</p>
*/
inline void SetVersionName(const char* value) { m_versionNameHasBeenSet = true; m_versionName.assign(value); }
/**
* <p>The version name that you assigned to the document classifier.</p>
*/
inline DocumentClassifierProperties& WithVersionName(const Aws::String& value) { SetVersionName(value); return *this;}
/**
* <p>The version name that you assigned to the document classifier.</p>
*/
inline DocumentClassifierProperties& WithVersionName(Aws::String&& value) { SetVersionName(std::move(value)); return *this;}
/**
* <p>The version name that you assigned to the document classifier.</p>
*/
inline DocumentClassifierProperties& WithVersionName(const char* value) { SetVersionName(value); return *this;}
/**
* <p>The Amazon Resource Name (ARN) of the source model. This model was imported
* from a different Amazon Web Services account to create the document classifier
* model in your Amazon Web Services account.</p>
*/
inline const Aws::String& GetSourceModelArn() const{ return m_sourceModelArn; }
/**
* <p>The Amazon Resource Name (ARN) of the source model. This model was imported
* from a different Amazon Web Services account to create the document classifier
* model in your Amazon Web Services account.</p>
*/
inline bool SourceModelArnHasBeenSet() const { return m_sourceModelArnHasBeenSet; }
/**
* <p>The Amazon Resource Name (ARN) of the source model. This model was imported
* from a different Amazon Web Services account to create the document classifier
* model in your Amazon Web Services account.</p>
*/
inline void SetSourceModelArn(const Aws::String& value) { m_sourceModelArnHasBeenSet = true; m_sourceModelArn = value; }
/**
* <p>The Amazon Resource Name (ARN) of the source model. This model was imported
* from a different Amazon Web Services account to create the document classifier
* model in your Amazon Web Services account.</p>
*/
inline void SetSourceModelArn(Aws::String&& value) { m_sourceModelArnHasBeenSet = true; m_sourceModelArn = std::move(value); }
/**
* <p>The Amazon Resource Name (ARN) of the source model. This model was imported
* from a different Amazon Web Services account to create the document classifier
* model in your Amazon Web Services account.</p>
*/
inline void SetSourceModelArn(const char* value) { m_sourceModelArnHasBeenSet = true; m_sourceModelArn.assign(value); }
/**
* <p>The Amazon Resource Name (ARN) of the source model. This model was imported
* from a different Amazon Web Services account to create the document classifier
* model in your Amazon Web Services account.</p>
*/
inline DocumentClassifierProperties& WithSourceModelArn(const Aws::String& value) { SetSourceModelArn(value); return *this;}
/**
* <p>The Amazon Resource Name (ARN) of the source model. This model was imported
* from a different Amazon Web Services account to create the document classifier
* model in your Amazon Web Services account.</p>
*/
inline DocumentClassifierProperties& WithSourceModelArn(Aws::String&& value) { SetSourceModelArn(std::move(value)); return *this;}
/**
* <p>The Amazon Resource Name (ARN) of the source model. This model was imported
* from a different Amazon Web Services account to create the document classifier
* model in your Amazon Web Services account.</p>
*/
inline DocumentClassifierProperties& WithSourceModelArn(const char* value) { SetSourceModelArn(value); return *this;}
/**
* <p>The Amazon Resource Number (ARN) of the flywheel</p>
*/
inline const Aws::String& GetFlywheelArn() const{ return m_flywheelArn; }
/**
* <p>The Amazon Resource Number (ARN) of the flywheel</p>
*/
inline bool FlywheelArnHasBeenSet() const { return m_flywheelArnHasBeenSet; }
/**
* <p>The Amazon Resource Number (ARN) of the flywheel</p>
*/
inline void SetFlywheelArn(const Aws::String& value) { m_flywheelArnHasBeenSet = true; m_flywheelArn = value; }
/**
* <p>The Amazon Resource Number (ARN) of the flywheel</p>
*/
inline void SetFlywheelArn(Aws::String&& value) { m_flywheelArnHasBeenSet = true; m_flywheelArn = std::move(value); }
/**
* <p>The Amazon Resource Number (ARN) of the flywheel</p>
*/
inline void SetFlywheelArn(const char* value) { m_flywheelArnHasBeenSet = true; m_flywheelArn.assign(value); }
/**
* <p>The Amazon Resource Number (ARN) of the flywheel</p>
*/
inline DocumentClassifierProperties& WithFlywheelArn(const Aws::String& value) { SetFlywheelArn(value); return *this;}
/**
* <p>The Amazon Resource Number (ARN) of the flywheel</p>
*/
inline DocumentClassifierProperties& WithFlywheelArn(Aws::String&& value) { SetFlywheelArn(std::move(value)); return *this;}
/**
* <p>The Amazon Resource Number (ARN) of the flywheel</p>
*/
inline DocumentClassifierProperties& WithFlywheelArn(const char* value) { SetFlywheelArn(value); return *this;}
private:
Aws::String m_documentClassifierArn;
bool m_documentClassifierArnHasBeenSet = false;
LanguageCode m_languageCode;
bool m_languageCodeHasBeenSet = false;
ModelStatus m_status;
bool m_statusHasBeenSet = false;
Aws::String m_message;
bool m_messageHasBeenSet = false;
Aws::Utils::DateTime m_submitTime;
bool m_submitTimeHasBeenSet = false;
Aws::Utils::DateTime m_endTime;
bool m_endTimeHasBeenSet = false;
Aws::Utils::DateTime m_trainingStartTime;
bool m_trainingStartTimeHasBeenSet = false;
Aws::Utils::DateTime m_trainingEndTime;
bool m_trainingEndTimeHasBeenSet = false;
DocumentClassifierInputDataConfig m_inputDataConfig;
bool m_inputDataConfigHasBeenSet = false;
DocumentClassifierOutputDataConfig m_outputDataConfig;
bool m_outputDataConfigHasBeenSet = false;
ClassifierMetadata m_classifierMetadata;
bool m_classifierMetadataHasBeenSet = false;
Aws::String m_dataAccessRoleArn;
bool m_dataAccessRoleArnHasBeenSet = false;
Aws::String m_volumeKmsKeyId;
bool m_volumeKmsKeyIdHasBeenSet = false;
VpcConfig m_vpcConfig;
bool m_vpcConfigHasBeenSet = false;
DocumentClassifierMode m_mode;
bool m_modeHasBeenSet = false;
Aws::String m_modelKmsKeyId;
bool m_modelKmsKeyIdHasBeenSet = false;
Aws::String m_versionName;
bool m_versionNameHasBeenSet = false;
Aws::String m_sourceModelArn;
bool m_sourceModelArnHasBeenSet = false;
Aws::String m_flywheelArn;
bool m_flywheelArnHasBeenSet = false;
};
} // namespace Model
} // namespace Comprehend
} // namespace Aws