/** * 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 #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace Comprehend { namespace Model { /** *

Describes information about an entity recognizer.

See Also:

* AWS * API Reference

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

The Amazon Resource Name (ARN) that identifies the entity recognizer.

*/ inline const Aws::String& GetEntityRecognizerArn() const{ return m_entityRecognizerArn; } /** *

The Amazon Resource Name (ARN) that identifies the entity recognizer.

*/ inline bool EntityRecognizerArnHasBeenSet() const { return m_entityRecognizerArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) that identifies the entity recognizer.

*/ inline void SetEntityRecognizerArn(const Aws::String& value) { m_entityRecognizerArnHasBeenSet = true; m_entityRecognizerArn = value; } /** *

The Amazon Resource Name (ARN) that identifies the entity recognizer.

*/ inline void SetEntityRecognizerArn(Aws::String&& value) { m_entityRecognizerArnHasBeenSet = true; m_entityRecognizerArn = std::move(value); } /** *

The Amazon Resource Name (ARN) that identifies the entity recognizer.

*/ inline void SetEntityRecognizerArn(const char* value) { m_entityRecognizerArnHasBeenSet = true; m_entityRecognizerArn.assign(value); } /** *

The Amazon Resource Name (ARN) that identifies the entity recognizer.

*/ inline EntityRecognizerProperties& WithEntityRecognizerArn(const Aws::String& value) { SetEntityRecognizerArn(value); return *this;} /** *

The Amazon Resource Name (ARN) that identifies the entity recognizer.

*/ inline EntityRecognizerProperties& WithEntityRecognizerArn(Aws::String&& value) { SetEntityRecognizerArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) that identifies the entity recognizer.

*/ inline EntityRecognizerProperties& WithEntityRecognizerArn(const char* value) { SetEntityRecognizerArn(value); return *this;} /** *

The language of the input documents. All documents must be in the same * language. Only English ("en") is currently supported.

*/ inline const LanguageCode& GetLanguageCode() const{ return m_languageCode; } /** *

The language of the input documents. All documents must be in the same * language. Only English ("en") is currently supported.

*/ inline bool LanguageCodeHasBeenSet() const { return m_languageCodeHasBeenSet; } /** *

The language of the input documents. All documents must be in the same * language. Only English ("en") is currently supported.

*/ inline void SetLanguageCode(const LanguageCode& value) { m_languageCodeHasBeenSet = true; m_languageCode = value; } /** *

The language of the input documents. All documents must be in the same * language. Only English ("en") is currently supported.

*/ inline void SetLanguageCode(LanguageCode&& value) { m_languageCodeHasBeenSet = true; m_languageCode = std::move(value); } /** *

The language of the input documents. All documents must be in the same * language. Only English ("en") is currently supported.

*/ inline EntityRecognizerProperties& WithLanguageCode(const LanguageCode& value) { SetLanguageCode(value); return *this;} /** *

The language of the input documents. All documents must be in the same * language. Only English ("en") is currently supported.

*/ inline EntityRecognizerProperties& WithLanguageCode(LanguageCode&& value) { SetLanguageCode(std::move(value)); return *this;} /** *

Provides the status of the entity recognizer.

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

Provides the status of the entity recognizer.

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

Provides the status of the entity recognizer.

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

Provides the status of the entity recognizer.

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

Provides the status of the entity recognizer.

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

Provides the status of the entity recognizer.

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

A description of the status of the recognizer.

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

A description of the status of the recognizer.

*/ inline bool MessageHasBeenSet() const { return m_messageHasBeenSet; } /** *

A description of the status of the recognizer.

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

A description of the status of the recognizer.

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

A description of the status of the recognizer.

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

A description of the status of the recognizer.

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

A description of the status of the recognizer.

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

A description of the status of the recognizer.

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

The time that the recognizer was submitted for processing.

*/ inline const Aws::Utils::DateTime& GetSubmitTime() const{ return m_submitTime; } /** *

The time that the recognizer was submitted for processing.

*/ inline bool SubmitTimeHasBeenSet() const { return m_submitTimeHasBeenSet; } /** *

The time that the recognizer was submitted for processing.

*/ inline void SetSubmitTime(const Aws::Utils::DateTime& value) { m_submitTimeHasBeenSet = true; m_submitTime = value; } /** *

The time that the recognizer was submitted for processing.

*/ inline void SetSubmitTime(Aws::Utils::DateTime&& value) { m_submitTimeHasBeenSet = true; m_submitTime = std::move(value); } /** *

The time that the recognizer was submitted for processing.

*/ inline EntityRecognizerProperties& WithSubmitTime(const Aws::Utils::DateTime& value) { SetSubmitTime(value); return *this;} /** *

The time that the recognizer was submitted for processing.

*/ inline EntityRecognizerProperties& WithSubmitTime(Aws::Utils::DateTime&& value) { SetSubmitTime(std::move(value)); return *this;} /** *

The time that the recognizer creation completed.

*/ inline const Aws::Utils::DateTime& GetEndTime() const{ return m_endTime; } /** *

The time that the recognizer creation completed.

*/ inline bool EndTimeHasBeenSet() const { return m_endTimeHasBeenSet; } /** *

The time that the recognizer creation completed.

*/ inline void SetEndTime(const Aws::Utils::DateTime& value) { m_endTimeHasBeenSet = true; m_endTime = value; } /** *

The time that the recognizer creation completed.

*/ inline void SetEndTime(Aws::Utils::DateTime&& value) { m_endTimeHasBeenSet = true; m_endTime = std::move(value); } /** *

The time that the recognizer creation completed.

*/ inline EntityRecognizerProperties& WithEndTime(const Aws::Utils::DateTime& value) { SetEndTime(value); return *this;} /** *

The time that the recognizer creation completed.

*/ inline EntityRecognizerProperties& WithEndTime(Aws::Utils::DateTime&& value) { SetEndTime(std::move(value)); return *this;} /** *

The time that training of the entity recognizer started.

*/ inline const Aws::Utils::DateTime& GetTrainingStartTime() const{ return m_trainingStartTime; } /** *

The time that training of the entity recognizer started.

*/ inline bool TrainingStartTimeHasBeenSet() const { return m_trainingStartTimeHasBeenSet; } /** *

The time that training of the entity recognizer started.

*/ inline void SetTrainingStartTime(const Aws::Utils::DateTime& value) { m_trainingStartTimeHasBeenSet = true; m_trainingStartTime = value; } /** *

The time that training of the entity recognizer started.

*/ inline void SetTrainingStartTime(Aws::Utils::DateTime&& value) { m_trainingStartTimeHasBeenSet = true; m_trainingStartTime = std::move(value); } /** *

The time that training of the entity recognizer started.

*/ inline EntityRecognizerProperties& WithTrainingStartTime(const Aws::Utils::DateTime& value) { SetTrainingStartTime(value); return *this;} /** *

The time that training of the entity recognizer started.

*/ inline EntityRecognizerProperties& WithTrainingStartTime(Aws::Utils::DateTime&& value) { SetTrainingStartTime(std::move(value)); return *this;} /** *

The time that training of the entity recognizer was completed.

*/ inline const Aws::Utils::DateTime& GetTrainingEndTime() const{ return m_trainingEndTime; } /** *

The time that training of the entity recognizer was completed.

*/ inline bool TrainingEndTimeHasBeenSet() const { return m_trainingEndTimeHasBeenSet; } /** *

The time that training of the entity recognizer was completed.

*/ inline void SetTrainingEndTime(const Aws::Utils::DateTime& value) { m_trainingEndTimeHasBeenSet = true; m_trainingEndTime = value; } /** *

The time that training of the entity recognizer was completed.

*/ inline void SetTrainingEndTime(Aws::Utils::DateTime&& value) { m_trainingEndTimeHasBeenSet = true; m_trainingEndTime = std::move(value); } /** *

The time that training of the entity recognizer was completed.

*/ inline EntityRecognizerProperties& WithTrainingEndTime(const Aws::Utils::DateTime& value) { SetTrainingEndTime(value); return *this;} /** *

The time that training of the entity recognizer was completed.

*/ inline EntityRecognizerProperties& WithTrainingEndTime(Aws::Utils::DateTime&& value) { SetTrainingEndTime(std::move(value)); return *this;} /** *

The input data properties of an entity recognizer.

*/ inline const EntityRecognizerInputDataConfig& GetInputDataConfig() const{ return m_inputDataConfig; } /** *

The input data properties of an entity recognizer.

*/ inline bool InputDataConfigHasBeenSet() const { return m_inputDataConfigHasBeenSet; } /** *

The input data properties of an entity recognizer.

*/ inline void SetInputDataConfig(const EntityRecognizerInputDataConfig& value) { m_inputDataConfigHasBeenSet = true; m_inputDataConfig = value; } /** *

The input data properties of an entity recognizer.

*/ inline void SetInputDataConfig(EntityRecognizerInputDataConfig&& value) { m_inputDataConfigHasBeenSet = true; m_inputDataConfig = std::move(value); } /** *

The input data properties of an entity recognizer.

*/ inline EntityRecognizerProperties& WithInputDataConfig(const EntityRecognizerInputDataConfig& value) { SetInputDataConfig(value); return *this;} /** *

The input data properties of an entity recognizer.

*/ inline EntityRecognizerProperties& WithInputDataConfig(EntityRecognizerInputDataConfig&& value) { SetInputDataConfig(std::move(value)); return *this;} /** *

Provides information about an entity recognizer.

*/ inline const EntityRecognizerMetadata& GetRecognizerMetadata() const{ return m_recognizerMetadata; } /** *

Provides information about an entity recognizer.

*/ inline bool RecognizerMetadataHasBeenSet() const { return m_recognizerMetadataHasBeenSet; } /** *

Provides information about an entity recognizer.

*/ inline void SetRecognizerMetadata(const EntityRecognizerMetadata& value) { m_recognizerMetadataHasBeenSet = true; m_recognizerMetadata = value; } /** *

Provides information about an entity recognizer.

*/ inline void SetRecognizerMetadata(EntityRecognizerMetadata&& value) { m_recognizerMetadataHasBeenSet = true; m_recognizerMetadata = std::move(value); } /** *

Provides information about an entity recognizer.

*/ inline EntityRecognizerProperties& WithRecognizerMetadata(const EntityRecognizerMetadata& value) { SetRecognizerMetadata(value); return *this;} /** *

Provides information about an entity recognizer.

*/ inline EntityRecognizerProperties& WithRecognizerMetadata(EntityRecognizerMetadata&& value) { SetRecognizerMetadata(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role * that grants Amazon Comprehend read access to your input data.

*/ inline const Aws::String& GetDataAccessRoleArn() const{ return m_dataAccessRoleArn; } /** *

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role * that grants Amazon Comprehend read access to your input data.

*/ inline bool DataAccessRoleArnHasBeenSet() const { return m_dataAccessRoleArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role * that grants Amazon Comprehend read access to your input data.

*/ inline void SetDataAccessRoleArn(const Aws::String& value) { m_dataAccessRoleArnHasBeenSet = true; m_dataAccessRoleArn = value; } /** *

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role * that grants Amazon Comprehend read access to your input data.

*/ inline void SetDataAccessRoleArn(Aws::String&& value) { m_dataAccessRoleArnHasBeenSet = true; m_dataAccessRoleArn = std::move(value); } /** *

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role * that grants Amazon Comprehend read access to your input data.

*/ inline void SetDataAccessRoleArn(const char* value) { m_dataAccessRoleArnHasBeenSet = true; m_dataAccessRoleArn.assign(value); } /** *

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role * that grants Amazon Comprehend read access to your input data.

*/ inline EntityRecognizerProperties& WithDataAccessRoleArn(const Aws::String& value) { SetDataAccessRoleArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role * that grants Amazon Comprehend read access to your input data.

*/ inline EntityRecognizerProperties& WithDataAccessRoleArn(Aws::String&& value) { SetDataAccessRoleArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role * that grants Amazon Comprehend read access to your input data.

*/ inline EntityRecognizerProperties& WithDataAccessRoleArn(const char* value) { SetDataAccessRoleArn(value); return *this;} /** *

ID for the AWS 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:

  • KMS Key ID: * "1234abcd-12ab-34cd-56ef-1234567890ab"

  • Amazon * Resource Name (ARN) of a KMS Key: * "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" *

*/ inline const Aws::String& GetVolumeKmsKeyId() const{ return m_volumeKmsKeyId; } /** *

ID for the AWS 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:

  • KMS Key ID: * "1234abcd-12ab-34cd-56ef-1234567890ab"

  • Amazon * Resource Name (ARN) of a KMS Key: * "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" *

*/ inline bool VolumeKmsKeyIdHasBeenSet() const { return m_volumeKmsKeyIdHasBeenSet; } /** *

ID for the AWS 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:

  • KMS Key ID: * "1234abcd-12ab-34cd-56ef-1234567890ab"

  • Amazon * Resource Name (ARN) of a KMS Key: * "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" *

*/ inline void SetVolumeKmsKeyId(const Aws::String& value) { m_volumeKmsKeyIdHasBeenSet = true; m_volumeKmsKeyId = value; } /** *

ID for the AWS 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:

  • KMS Key ID: * "1234abcd-12ab-34cd-56ef-1234567890ab"

  • Amazon * Resource Name (ARN) of a KMS Key: * "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" *

*/ inline void SetVolumeKmsKeyId(Aws::String&& value) { m_volumeKmsKeyIdHasBeenSet = true; m_volumeKmsKeyId = std::move(value); } /** *

ID for the AWS 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:

  • KMS Key ID: * "1234abcd-12ab-34cd-56ef-1234567890ab"

  • Amazon * Resource Name (ARN) of a KMS Key: * "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" *

*/ inline void SetVolumeKmsKeyId(const char* value) { m_volumeKmsKeyIdHasBeenSet = true; m_volumeKmsKeyId.assign(value); } /** *

ID for the AWS 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:

  • KMS Key ID: * "1234abcd-12ab-34cd-56ef-1234567890ab"

  • Amazon * Resource Name (ARN) of a KMS Key: * "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" *

*/ inline EntityRecognizerProperties& WithVolumeKmsKeyId(const Aws::String& value) { SetVolumeKmsKeyId(value); return *this;} /** *

ID for the AWS 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:

  • KMS Key ID: * "1234abcd-12ab-34cd-56ef-1234567890ab"

  • Amazon * Resource Name (ARN) of a KMS Key: * "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" *

*/ inline EntityRecognizerProperties& WithVolumeKmsKeyId(Aws::String&& value) { SetVolumeKmsKeyId(std::move(value)); return *this;} /** *

ID for the AWS 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:

  • KMS Key ID: * "1234abcd-12ab-34cd-56ef-1234567890ab"

  • Amazon * Resource Name (ARN) of a KMS Key: * "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" *

*/ inline EntityRecognizerProperties& WithVolumeKmsKeyId(const char* value) { SetVolumeKmsKeyId(value); return *this;} /** *

Configuration parameters for a private Virtual Private Cloud (VPC) * containing the resources you are using for your custom entity recognizer. For * more information, see Amazon * VPC.

*/ inline const VpcConfig& GetVpcConfig() const{ return m_vpcConfig; } /** *

Configuration parameters for a private Virtual Private Cloud (VPC) * containing the resources you are using for your custom entity recognizer. For * more information, see Amazon * VPC.

*/ inline bool VpcConfigHasBeenSet() const { return m_vpcConfigHasBeenSet; } /** *

Configuration parameters for a private Virtual Private Cloud (VPC) * containing the resources you are using for your custom entity recognizer. For * more information, see Amazon * VPC.

*/ inline void SetVpcConfig(const VpcConfig& value) { m_vpcConfigHasBeenSet = true; m_vpcConfig = value; } /** *

Configuration parameters for a private Virtual Private Cloud (VPC) * containing the resources you are using for your custom entity recognizer. For * more information, see Amazon * VPC.

*/ inline void SetVpcConfig(VpcConfig&& value) { m_vpcConfigHasBeenSet = true; m_vpcConfig = std::move(value); } /** *

Configuration parameters for a private Virtual Private Cloud (VPC) * containing the resources you are using for your custom entity recognizer. For * more information, see Amazon * VPC.

*/ inline EntityRecognizerProperties& WithVpcConfig(const VpcConfig& value) { SetVpcConfig(value); return *this;} /** *

Configuration parameters for a private Virtual Private Cloud (VPC) * containing the resources you are using for your custom entity recognizer. For * more information, see Amazon * VPC.

*/ inline EntityRecognizerProperties& WithVpcConfig(VpcConfig&& value) { SetVpcConfig(std::move(value)); return *this;} private: Aws::String m_entityRecognizerArn; bool m_entityRecognizerArnHasBeenSet; LanguageCode m_languageCode; bool m_languageCodeHasBeenSet; ModelStatus m_status; bool m_statusHasBeenSet; Aws::String m_message; bool m_messageHasBeenSet; Aws::Utils::DateTime m_submitTime; bool m_submitTimeHasBeenSet; Aws::Utils::DateTime m_endTime; bool m_endTimeHasBeenSet; Aws::Utils::DateTime m_trainingStartTime; bool m_trainingStartTimeHasBeenSet; Aws::Utils::DateTime m_trainingEndTime; bool m_trainingEndTimeHasBeenSet; EntityRecognizerInputDataConfig m_inputDataConfig; bool m_inputDataConfigHasBeenSet; EntityRecognizerMetadata m_recognizerMetadata; bool m_recognizerMetadataHasBeenSet; Aws::String m_dataAccessRoleArn; bool m_dataAccessRoleArnHasBeenSet; Aws::String m_volumeKmsKeyId; bool m_volumeKmsKeyIdHasBeenSet; VpcConfig m_vpcConfig; bool m_vpcConfigHasBeenSet; }; } // namespace Model } // namespace Comprehend } // namespace Aws