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

Provides information about a PII entities detection job.

See * Also:

AWS * API Reference

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

The identifier assigned to the PII entities detection job.

*/ inline const Aws::String& GetJobId() const{ return m_jobId; } /** *

The identifier assigned to the PII entities detection job.

*/ inline bool JobIdHasBeenSet() const { return m_jobIdHasBeenSet; } /** *

The identifier assigned to the PII entities detection job.

*/ inline void SetJobId(const Aws::String& value) { m_jobIdHasBeenSet = true; m_jobId = value; } /** *

The identifier assigned to the PII entities detection job.

*/ inline void SetJobId(Aws::String&& value) { m_jobIdHasBeenSet = true; m_jobId = std::move(value); } /** *

The identifier assigned to the PII entities detection job.

*/ inline void SetJobId(const char* value) { m_jobIdHasBeenSet = true; m_jobId.assign(value); } /** *

The identifier assigned to the PII entities detection job.

*/ inline PiiEntitiesDetectionJobProperties& WithJobId(const Aws::String& value) { SetJobId(value); return *this;} /** *

The identifier assigned to the PII entities detection job.

*/ inline PiiEntitiesDetectionJobProperties& WithJobId(Aws::String&& value) { SetJobId(std::move(value)); return *this;} /** *

The identifier assigned to the PII entities detection job.

*/ inline PiiEntitiesDetectionJobProperties& WithJobId(const char* value) { SetJobId(value); return *this;} /** *

The Amazon Resource Name (ARN) of the PII entities detection job. It is a * unique, fully qualified identifier for the job. It includes the Amazon Web * Services account, Amazon Web Services Region, and the job ID. The format of the * ARN is as follows:

* arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id> *

The following is an example job ARN:

* arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab *

*/ inline const Aws::String& GetJobArn() const{ return m_jobArn; } /** *

The Amazon Resource Name (ARN) of the PII entities detection job. It is a * unique, fully qualified identifier for the job. It includes the Amazon Web * Services account, Amazon Web Services Region, and the job ID. The format of the * ARN is as follows:

* arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id> *

The following is an example job ARN:

* arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab *

*/ inline bool JobArnHasBeenSet() const { return m_jobArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the PII entities detection job. It is a * unique, fully qualified identifier for the job. It includes the Amazon Web * Services account, Amazon Web Services Region, and the job ID. The format of the * ARN is as follows:

* arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id> *

The following is an example job ARN:

* arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab *

*/ inline void SetJobArn(const Aws::String& value) { m_jobArnHasBeenSet = true; m_jobArn = value; } /** *

The Amazon Resource Name (ARN) of the PII entities detection job. It is a * unique, fully qualified identifier for the job. It includes the Amazon Web * Services account, Amazon Web Services Region, and the job ID. The format of the * ARN is as follows:

* arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id> *

The following is an example job ARN:

* arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab *

*/ inline void SetJobArn(Aws::String&& value) { m_jobArnHasBeenSet = true; m_jobArn = std::move(value); } /** *

The Amazon Resource Name (ARN) of the PII entities detection job. It is a * unique, fully qualified identifier for the job. It includes the Amazon Web * Services account, Amazon Web Services Region, and the job ID. The format of the * ARN is as follows:

* arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id> *

The following is an example job ARN:

* arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab *

*/ inline void SetJobArn(const char* value) { m_jobArnHasBeenSet = true; m_jobArn.assign(value); } /** *

The Amazon Resource Name (ARN) of the PII entities detection job. It is a * unique, fully qualified identifier for the job. It includes the Amazon Web * Services account, Amazon Web Services Region, and the job ID. The format of the * ARN is as follows:

* arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id> *

The following is an example job ARN:

* arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab *

*/ inline PiiEntitiesDetectionJobProperties& WithJobArn(const Aws::String& value) { SetJobArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the PII entities detection job. It is a * unique, fully qualified identifier for the job. It includes the Amazon Web * Services account, Amazon Web Services Region, and the job ID. The format of the * ARN is as follows:

* arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id> *

The following is an example job ARN:

* arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab *

*/ inline PiiEntitiesDetectionJobProperties& WithJobArn(Aws::String&& value) { SetJobArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the PII entities detection job. It is a * unique, fully qualified identifier for the job. It includes the Amazon Web * Services account, Amazon Web Services Region, and the job ID. The format of the * ARN is as follows:

* arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id> *

The following is an example job ARN:

* arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab *

*/ inline PiiEntitiesDetectionJobProperties& WithJobArn(const char* value) { SetJobArn(value); return *this;} /** *

The name that you assigned the PII entities detection job.

*/ inline const Aws::String& GetJobName() const{ return m_jobName; } /** *

The name that you assigned the PII entities detection job.

*/ inline bool JobNameHasBeenSet() const { return m_jobNameHasBeenSet; } /** *

The name that you assigned the PII entities detection job.

*/ inline void SetJobName(const Aws::String& value) { m_jobNameHasBeenSet = true; m_jobName = value; } /** *

The name that you assigned the PII entities detection job.

*/ inline void SetJobName(Aws::String&& value) { m_jobNameHasBeenSet = true; m_jobName = std::move(value); } /** *

The name that you assigned the PII entities detection job.

*/ inline void SetJobName(const char* value) { m_jobNameHasBeenSet = true; m_jobName.assign(value); } /** *

The name that you assigned the PII entities detection job.

*/ inline PiiEntitiesDetectionJobProperties& WithJobName(const Aws::String& value) { SetJobName(value); return *this;} /** *

The name that you assigned the PII entities detection job.

*/ inline PiiEntitiesDetectionJobProperties& WithJobName(Aws::String&& value) { SetJobName(std::move(value)); return *this;} /** *

The name that you assigned the PII entities detection job.

*/ inline PiiEntitiesDetectionJobProperties& WithJobName(const char* value) { SetJobName(value); return *this;} /** *

The current status of the PII entities detection job. If the status is * FAILED, the Message field shows the reason for the * failure.

*/ inline const JobStatus& GetJobStatus() const{ return m_jobStatus; } /** *

The current status of the PII entities detection job. If the status is * FAILED, the Message field shows the reason for the * failure.

*/ inline bool JobStatusHasBeenSet() const { return m_jobStatusHasBeenSet; } /** *

The current status of the PII entities detection job. If the status is * FAILED, the Message field shows the reason for the * failure.

*/ inline void SetJobStatus(const JobStatus& value) { m_jobStatusHasBeenSet = true; m_jobStatus = value; } /** *

The current status of the PII entities detection job. If the status is * FAILED, the Message field shows the reason for the * failure.

*/ inline void SetJobStatus(JobStatus&& value) { m_jobStatusHasBeenSet = true; m_jobStatus = std::move(value); } /** *

The current status of the PII entities detection job. If the status is * FAILED, the Message field shows the reason for the * failure.

*/ inline PiiEntitiesDetectionJobProperties& WithJobStatus(const JobStatus& value) { SetJobStatus(value); return *this;} /** *

The current status of the PII entities detection job. If the status is * FAILED, the Message field shows the reason for the * failure.

*/ inline PiiEntitiesDetectionJobProperties& WithJobStatus(JobStatus&& value) { SetJobStatus(std::move(value)); return *this;} /** *

A description of the status of a job.

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

A description of the status of a job.

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

A description of the status of a job.

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

A description of the status of a job.

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

A description of the status of a job.

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

A description of the status of a job.

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

A description of the status of a job.

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

A description of the status of a job.

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

The time that the PII entities detection job was submitted for * processing.

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

The time that the PII entities detection job was submitted for * processing.

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

The time that the PII entities detection job was submitted for * processing.

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

The time that the PII entities detection job was submitted for * processing.

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

The time that the PII entities detection job was submitted for * processing.

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

The time that the PII entities detection job was submitted for * processing.

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

The time that the PII entities detection job completed.

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

The time that the PII entities detection job completed.

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

The time that the PII entities detection job completed.

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

The time that the PII entities detection job completed.

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

The time that the PII entities detection job completed.

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

The time that the PII entities detection job completed.

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

The input properties for a PII entities detection job.

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

The input properties for a PII entities detection job.

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

The input properties for a PII entities detection job.

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

The input properties for a PII entities detection job.

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

The input properties for a PII entities detection job.

*/ inline PiiEntitiesDetectionJobProperties& WithInputDataConfig(const InputDataConfig& value) { SetInputDataConfig(value); return *this;} /** *

The input properties for a PII entities detection job.

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

The output data configuration that you supplied when you created the PII * entities detection job.

*/ inline const PiiOutputDataConfig& GetOutputDataConfig() const{ return m_outputDataConfig; } /** *

The output data configuration that you supplied when you created the PII * entities detection job.

*/ inline bool OutputDataConfigHasBeenSet() const { return m_outputDataConfigHasBeenSet; } /** *

The output data configuration that you supplied when you created the PII * entities detection job.

*/ inline void SetOutputDataConfig(const PiiOutputDataConfig& value) { m_outputDataConfigHasBeenSet = true; m_outputDataConfig = value; } /** *

The output data configuration that you supplied when you created the PII * entities detection job.

*/ inline void SetOutputDataConfig(PiiOutputDataConfig&& value) { m_outputDataConfigHasBeenSet = true; m_outputDataConfig = std::move(value); } /** *

The output data configuration that you supplied when you created the PII * entities detection job.

*/ inline PiiEntitiesDetectionJobProperties& WithOutputDataConfig(const PiiOutputDataConfig& value) { SetOutputDataConfig(value); return *this;} /** *

The output data configuration that you supplied when you created the PII * entities detection job.

*/ inline PiiEntitiesDetectionJobProperties& WithOutputDataConfig(PiiOutputDataConfig&& value) { SetOutputDataConfig(std::move(value)); return *this;} /** *

Provides configuration parameters for PII entity redaction.

This * parameter is required if you set the Mode parameter to * ONLY_REDACTION. In that case, you must provide a * RedactionConfig definition that includes the * PiiEntityTypes parameter.

*/ inline const RedactionConfig& GetRedactionConfig() const{ return m_redactionConfig; } /** *

Provides configuration parameters for PII entity redaction.

This * parameter is required if you set the Mode parameter to * ONLY_REDACTION. In that case, you must provide a * RedactionConfig definition that includes the * PiiEntityTypes parameter.

*/ inline bool RedactionConfigHasBeenSet() const { return m_redactionConfigHasBeenSet; } /** *

Provides configuration parameters for PII entity redaction.

This * parameter is required if you set the Mode parameter to * ONLY_REDACTION. In that case, you must provide a * RedactionConfig definition that includes the * PiiEntityTypes parameter.

*/ inline void SetRedactionConfig(const RedactionConfig& value) { m_redactionConfigHasBeenSet = true; m_redactionConfig = value; } /** *

Provides configuration parameters for PII entity redaction.

This * parameter is required if you set the Mode parameter to * ONLY_REDACTION. In that case, you must provide a * RedactionConfig definition that includes the * PiiEntityTypes parameter.

*/ inline void SetRedactionConfig(RedactionConfig&& value) { m_redactionConfigHasBeenSet = true; m_redactionConfig = std::move(value); } /** *

Provides configuration parameters for PII entity redaction.

This * parameter is required if you set the Mode parameter to * ONLY_REDACTION. In that case, you must provide a * RedactionConfig definition that includes the * PiiEntityTypes parameter.

*/ inline PiiEntitiesDetectionJobProperties& WithRedactionConfig(const RedactionConfig& value) { SetRedactionConfig(value); return *this;} /** *

Provides configuration parameters for PII entity redaction.

This * parameter is required if you set the Mode parameter to * ONLY_REDACTION. In that case, you must provide a * RedactionConfig definition that includes the * PiiEntityTypes parameter.

*/ inline PiiEntitiesDetectionJobProperties& WithRedactionConfig(RedactionConfig&& value) { SetRedactionConfig(std::move(value)); return *this;} /** *

The language code of the input documents

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

The language code of the input documents

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

The language code of the input documents

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

The language code of the input documents

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

The language code of the input documents

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

The language code of the input documents

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

The Amazon Resource Name (ARN) of the 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 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 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 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 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 IAM role that grants Amazon Comprehend * read access to your input data.

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

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

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

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

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

Specifies whether the output provides the locations (offsets) of PII entities * or a file in which PII entities are redacted.

*/ inline const PiiEntitiesDetectionMode& GetMode() const{ return m_mode; } /** *

Specifies whether the output provides the locations (offsets) of PII entities * or a file in which PII entities are redacted.

*/ inline bool ModeHasBeenSet() const { return m_modeHasBeenSet; } /** *

Specifies whether the output provides the locations (offsets) of PII entities * or a file in which PII entities are redacted.

*/ inline void SetMode(const PiiEntitiesDetectionMode& value) { m_modeHasBeenSet = true; m_mode = value; } /** *

Specifies whether the output provides the locations (offsets) of PII entities * or a file in which PII entities are redacted.

*/ inline void SetMode(PiiEntitiesDetectionMode&& value) { m_modeHasBeenSet = true; m_mode = std::move(value); } /** *

Specifies whether the output provides the locations (offsets) of PII entities * or a file in which PII entities are redacted.

*/ inline PiiEntitiesDetectionJobProperties& WithMode(const PiiEntitiesDetectionMode& value) { SetMode(value); return *this;} /** *

Specifies whether the output provides the locations (offsets) of PII entities * or a file in which PII entities are redacted.

*/ inline PiiEntitiesDetectionJobProperties& WithMode(PiiEntitiesDetectionMode&& value) { SetMode(std::move(value)); return *this;} private: Aws::String m_jobId; bool m_jobIdHasBeenSet = false; Aws::String m_jobArn; bool m_jobArnHasBeenSet = false; Aws::String m_jobName; bool m_jobNameHasBeenSet = false; JobStatus m_jobStatus; bool m_jobStatusHasBeenSet = 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; InputDataConfig m_inputDataConfig; bool m_inputDataConfigHasBeenSet = false; PiiOutputDataConfig m_outputDataConfig; bool m_outputDataConfigHasBeenSet = false; RedactionConfig m_redactionConfig; bool m_redactionConfigHasBeenSet = false; LanguageCode m_languageCode; bool m_languageCodeHasBeenSet = false; Aws::String m_dataAccessRoleArn; bool m_dataAccessRoleArnHasBeenSet = false; PiiEntitiesDetectionMode m_mode; bool m_modeHasBeenSet = false; }; } // namespace Model } // namespace Comprehend } // namespace Aws