/** * 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 #include #include namespace Aws { namespace Comprehend { namespace Model { /** */ class StartPiiEntitiesDetectionJobRequest : public ComprehendRequest { public: AWS_COMPREHEND_API StartPiiEntitiesDetectionJobRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "StartPiiEntitiesDetectionJob"; } AWS_COMPREHEND_API Aws::String SerializePayload() const override; AWS_COMPREHEND_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

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 StartPiiEntitiesDetectionJobRequest& WithInputDataConfig(const InputDataConfig& value) { SetInputDataConfig(value); return *this;} /** *

The input properties for a PII entities detection job.

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

Provides configuration parameters for the output of PII entity detection * jobs.

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

Provides configuration parameters for the output of PII entity detection * jobs.

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

Provides configuration parameters for the output of PII entity detection * jobs.

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

Provides configuration parameters for the output of PII entity detection * jobs.

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

Provides configuration parameters for the output of PII entity detection * jobs.

*/ inline StartPiiEntitiesDetectionJobRequest& WithOutputDataConfig(const OutputDataConfig& value) { SetOutputDataConfig(value); return *this;} /** *

Provides configuration parameters for the output of PII entity detection * jobs.

*/ inline StartPiiEntitiesDetectionJobRequest& WithOutputDataConfig(OutputDataConfig&& value) { SetOutputDataConfig(std::move(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 StartPiiEntitiesDetectionJobRequest& 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 StartPiiEntitiesDetectionJobRequest& WithMode(PiiEntitiesDetectionMode&& value) { SetMode(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 StartPiiEntitiesDetectionJobRequest& 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 StartPiiEntitiesDetectionJobRequest& WithRedactionConfig(RedactionConfig&& value) { SetRedactionConfig(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 StartPiiEntitiesDetectionJobRequest& 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 StartPiiEntitiesDetectionJobRequest& 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 StartPiiEntitiesDetectionJobRequest& WithDataAccessRoleArn(const char* value) { SetDataAccessRoleArn(value); return *this;} /** *

The identifier of the job.

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

The identifier of the job.

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

The identifier of the job.

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

The identifier of the job.

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

The identifier of the job.

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

The identifier of the job.

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

The identifier of the job.

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

The identifier of the job.

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

The language of the input documents. Currently, English is the only valid * language.

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

The language of the input documents. Currently, English is the only valid * language.

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

The language of the input documents. Currently, English is the only valid * language.

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

The language of the input documents. Currently, English is the only valid * language.

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

The language of the input documents. Currently, English is the only valid * language.

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

The language of the input documents. Currently, English is the only valid * language.

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

A unique identifier for the request. If you don't set the client request * token, Amazon Comprehend generates one.

*/ inline const Aws::String& GetClientRequestToken() const{ return m_clientRequestToken; } /** *

A unique identifier for the request. If you don't set the client request * token, Amazon Comprehend generates one.

*/ inline bool ClientRequestTokenHasBeenSet() const { return m_clientRequestTokenHasBeenSet; } /** *

A unique identifier for the request. If you don't set the client request * token, Amazon Comprehend generates one.

*/ inline void SetClientRequestToken(const Aws::String& value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken = value; } /** *

A unique identifier for the request. If you don't set the client request * token, Amazon Comprehend generates one.

*/ inline void SetClientRequestToken(Aws::String&& value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken = std::move(value); } /** *

A unique identifier for the request. If you don't set the client request * token, Amazon Comprehend generates one.

*/ inline void SetClientRequestToken(const char* value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken.assign(value); } /** *

A unique identifier for the request. If you don't set the client request * token, Amazon Comprehend generates one.

*/ inline StartPiiEntitiesDetectionJobRequest& WithClientRequestToken(const Aws::String& value) { SetClientRequestToken(value); return *this;} /** *

A unique identifier for the request. If you don't set the client request * token, Amazon Comprehend generates one.

*/ inline StartPiiEntitiesDetectionJobRequest& WithClientRequestToken(Aws::String&& value) { SetClientRequestToken(std::move(value)); return *this;} /** *

A unique identifier for the request. If you don't set the client request * token, Amazon Comprehend generates one.

*/ inline StartPiiEntitiesDetectionJobRequest& WithClientRequestToken(const char* value) { SetClientRequestToken(value); return *this;} /** *

Tags to associate with the PII entities detection job. A tag is a key-value * pair that adds metadata to a resource used by Amazon Comprehend. For example, a * tag with "Sales" as the key might be added to a resource to indicate its use by * the sales department.

*/ inline const Aws::Vector& GetTags() const{ return m_tags; } /** *

Tags to associate with the PII entities detection job. A tag is a key-value * pair that adds metadata to a resource used by Amazon Comprehend. For example, a * tag with "Sales" as the key might be added to a resource to indicate its use by * the sales department.

*/ inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } /** *

Tags to associate with the PII entities detection job. A tag is a key-value * pair that adds metadata to a resource used by Amazon Comprehend. For example, a * tag with "Sales" as the key might be added to a resource to indicate its use by * the sales department.

*/ inline void SetTags(const Aws::Vector& value) { m_tagsHasBeenSet = true; m_tags = value; } /** *

Tags to associate with the PII entities detection job. A tag is a key-value * pair that adds metadata to a resource used by Amazon Comprehend. For example, a * tag with "Sales" as the key might be added to a resource to indicate its use by * the sales department.

*/ inline void SetTags(Aws::Vector&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } /** *

Tags to associate with the PII entities detection job. A tag is a key-value * pair that adds metadata to a resource used by Amazon Comprehend. For example, a * tag with "Sales" as the key might be added to a resource to indicate its use by * the sales department.

*/ inline StartPiiEntitiesDetectionJobRequest& WithTags(const Aws::Vector& value) { SetTags(value); return *this;} /** *

Tags to associate with the PII entities detection job. A tag is a key-value * pair that adds metadata to a resource used by Amazon Comprehend. For example, a * tag with "Sales" as the key might be added to a resource to indicate its use by * the sales department.

*/ inline StartPiiEntitiesDetectionJobRequest& WithTags(Aws::Vector&& value) { SetTags(std::move(value)); return *this;} /** *

Tags to associate with the PII entities detection job. A tag is a key-value * pair that adds metadata to a resource used by Amazon Comprehend. For example, a * tag with "Sales" as the key might be added to a resource to indicate its use by * the sales department.

*/ inline StartPiiEntitiesDetectionJobRequest& AddTags(const Tag& value) { m_tagsHasBeenSet = true; m_tags.push_back(value); return *this; } /** *

Tags to associate with the PII entities detection job. A tag is a key-value * pair that adds metadata to a resource used by Amazon Comprehend. For example, a * tag with "Sales" as the key might be added to a resource to indicate its use by * the sales department.

*/ inline StartPiiEntitiesDetectionJobRequest& AddTags(Tag&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; } private: InputDataConfig m_inputDataConfig; bool m_inputDataConfigHasBeenSet = false; OutputDataConfig m_outputDataConfig; bool m_outputDataConfigHasBeenSet = false; PiiEntitiesDetectionMode m_mode; bool m_modeHasBeenSet = false; RedactionConfig m_redactionConfig; bool m_redactionConfigHasBeenSet = false; Aws::String m_dataAccessRoleArn; bool m_dataAccessRoleArnHasBeenSet = false; Aws::String m_jobName; bool m_jobNameHasBeenSet = false; LanguageCode m_languageCode; bool m_languageCodeHasBeenSet = false; Aws::String m_clientRequestToken; bool m_clientRequestTokenHasBeenSet = false; Aws::Vector m_tags; bool m_tagsHasBeenSet = false; }; } // namespace Model } // namespace Comprehend } // namespace Aws