AWS SDK for C++  1.9.103
AWS SDK for C++
Public Member Functions | List of all members
Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties Class Reference

#include <PiiEntitiesDetectionJobProperties.h>

Public Member Functions

 PiiEntitiesDetectionJobProperties ()
 
 PiiEntitiesDetectionJobProperties (Aws::Utils::Json::JsonView jsonValue)
 
PiiEntitiesDetectionJobPropertiesoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetJobId () const
 
bool JobIdHasBeenSet () const
 
void SetJobId (const Aws::String &value)
 
void SetJobId (Aws::String &&value)
 
void SetJobId (const char *value)
 
PiiEntitiesDetectionJobPropertiesWithJobId (const Aws::String &value)
 
PiiEntitiesDetectionJobPropertiesWithJobId (Aws::String &&value)
 
PiiEntitiesDetectionJobPropertiesWithJobId (const char *value)
 
const Aws::StringGetJobArn () const
 
bool JobArnHasBeenSet () const
 
void SetJobArn (const Aws::String &value)
 
void SetJobArn (Aws::String &&value)
 
void SetJobArn (const char *value)
 
PiiEntitiesDetectionJobPropertiesWithJobArn (const Aws::String &value)
 
PiiEntitiesDetectionJobPropertiesWithJobArn (Aws::String &&value)
 
PiiEntitiesDetectionJobPropertiesWithJobArn (const char *value)
 
const Aws::StringGetJobName () const
 
bool JobNameHasBeenSet () const
 
void SetJobName (const Aws::String &value)
 
void SetJobName (Aws::String &&value)
 
void SetJobName (const char *value)
 
PiiEntitiesDetectionJobPropertiesWithJobName (const Aws::String &value)
 
PiiEntitiesDetectionJobPropertiesWithJobName (Aws::String &&value)
 
PiiEntitiesDetectionJobPropertiesWithJobName (const char *value)
 
const JobStatusGetJobStatus () const
 
bool JobStatusHasBeenSet () const
 
void SetJobStatus (const JobStatus &value)
 
void SetJobStatus (JobStatus &&value)
 
PiiEntitiesDetectionJobPropertiesWithJobStatus (const JobStatus &value)
 
PiiEntitiesDetectionJobPropertiesWithJobStatus (JobStatus &&value)
 
const Aws::StringGetMessage () const
 
bool MessageHasBeenSet () const
 
void SetMessage (const Aws::String &value)
 
void SetMessage (Aws::String &&value)
 
void SetMessage (const char *value)
 
PiiEntitiesDetectionJobPropertiesWithMessage (const Aws::String &value)
 
PiiEntitiesDetectionJobPropertiesWithMessage (Aws::String &&value)
 
PiiEntitiesDetectionJobPropertiesWithMessage (const char *value)
 
const Aws::Utils::DateTimeGetSubmitTime () const
 
bool SubmitTimeHasBeenSet () const
 
void SetSubmitTime (const Aws::Utils::DateTime &value)
 
void SetSubmitTime (Aws::Utils::DateTime &&value)
 
PiiEntitiesDetectionJobPropertiesWithSubmitTime (const Aws::Utils::DateTime &value)
 
PiiEntitiesDetectionJobPropertiesWithSubmitTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetEndTime () const
 
bool EndTimeHasBeenSet () const
 
void SetEndTime (const Aws::Utils::DateTime &value)
 
void SetEndTime (Aws::Utils::DateTime &&value)
 
PiiEntitiesDetectionJobPropertiesWithEndTime (const Aws::Utils::DateTime &value)
 
PiiEntitiesDetectionJobPropertiesWithEndTime (Aws::Utils::DateTime &&value)
 
const InputDataConfigGetInputDataConfig () const
 
bool InputDataConfigHasBeenSet () const
 
void SetInputDataConfig (const InputDataConfig &value)
 
void SetInputDataConfig (InputDataConfig &&value)
 
PiiEntitiesDetectionJobPropertiesWithInputDataConfig (const InputDataConfig &value)
 
PiiEntitiesDetectionJobPropertiesWithInputDataConfig (InputDataConfig &&value)
 
const PiiOutputDataConfigGetOutputDataConfig () const
 
bool OutputDataConfigHasBeenSet () const
 
void SetOutputDataConfig (const PiiOutputDataConfig &value)
 
void SetOutputDataConfig (PiiOutputDataConfig &&value)
 
PiiEntitiesDetectionJobPropertiesWithOutputDataConfig (const PiiOutputDataConfig &value)
 
PiiEntitiesDetectionJobPropertiesWithOutputDataConfig (PiiOutputDataConfig &&value)
 
const RedactionConfigGetRedactionConfig () const
 
bool RedactionConfigHasBeenSet () const
 
void SetRedactionConfig (const RedactionConfig &value)
 
void SetRedactionConfig (RedactionConfig &&value)
 
PiiEntitiesDetectionJobPropertiesWithRedactionConfig (const RedactionConfig &value)
 
PiiEntitiesDetectionJobPropertiesWithRedactionConfig (RedactionConfig &&value)
 
const LanguageCodeGetLanguageCode () const
 
bool LanguageCodeHasBeenSet () const
 
void SetLanguageCode (const LanguageCode &value)
 
void SetLanguageCode (LanguageCode &&value)
 
PiiEntitiesDetectionJobPropertiesWithLanguageCode (const LanguageCode &value)
 
PiiEntitiesDetectionJobPropertiesWithLanguageCode (LanguageCode &&value)
 
const Aws::StringGetDataAccessRoleArn () const
 
bool DataAccessRoleArnHasBeenSet () const
 
void SetDataAccessRoleArn (const Aws::String &value)
 
void SetDataAccessRoleArn (Aws::String &&value)
 
void SetDataAccessRoleArn (const char *value)
 
PiiEntitiesDetectionJobPropertiesWithDataAccessRoleArn (const Aws::String &value)
 
PiiEntitiesDetectionJobPropertiesWithDataAccessRoleArn (Aws::String &&value)
 
PiiEntitiesDetectionJobPropertiesWithDataAccessRoleArn (const char *value)
 
const PiiEntitiesDetectionModeGetMode () const
 
bool ModeHasBeenSet () const
 
void SetMode (const PiiEntitiesDetectionMode &value)
 
void SetMode (PiiEntitiesDetectionMode &&value)
 
PiiEntitiesDetectionJobPropertiesWithMode (const PiiEntitiesDetectionMode &value)
 
PiiEntitiesDetectionJobPropertiesWithMode (PiiEntitiesDetectionMode &&value)
 

Detailed Description

Provides information about a PII entities detection job.

See Also:

AWS API Reference

Definition at line 39 of file PiiEntitiesDetectionJobProperties.h.

Constructor & Destructor Documentation

◆ PiiEntitiesDetectionJobProperties() [1/2]

Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::PiiEntitiesDetectionJobProperties ( )

◆ PiiEntitiesDetectionJobProperties() [2/2]

Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::PiiEntitiesDetectionJobProperties ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ DataAccessRoleArnHasBeenSet()

bool Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::DataAccessRoleArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

Definition at line 535 of file PiiEntitiesDetectionJobProperties.h.

◆ EndTimeHasBeenSet()

bool Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::EndTimeHasBeenSet ( ) const
inline

The time that the PII entities detection job completed.

Definition at line 348 of file PiiEntitiesDetectionJobProperties.h.

◆ GetDataAccessRoleArn()

const Aws::String& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::GetDataAccessRoleArn ( ) const
inline

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

Definition at line 529 of file PiiEntitiesDetectionJobProperties.h.

◆ GetEndTime()

const Aws::Utils::DateTime& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::GetEndTime ( ) const
inline

The time that the PII entities detection job completed.

Definition at line 343 of file PiiEntitiesDetectionJobProperties.h.

◆ GetInputDataConfig()

const InputDataConfig& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::GetInputDataConfig ( ) const
inline

The input properties for a PII entities detection job.

Definition at line 374 of file PiiEntitiesDetectionJobProperties.h.

◆ GetJobArn()

const Aws::String& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::GetJobArn ( ) const
inline

The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, 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

Definition at line 98 of file PiiEntitiesDetectionJobProperties.h.

◆ GetJobId()

const Aws::String& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::GetJobId ( ) const
inline

The identifier assigned to the PII entities detection job.

Definition at line 51 of file PiiEntitiesDetectionJobProperties.h.

◆ GetJobName()

const Aws::String& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::GetJobName ( ) const
inline

The name that you assigned the PII entities detection job.

Definition at line 181 of file PiiEntitiesDetectionJobProperties.h.

◆ GetJobStatus()

const JobStatus& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::GetJobStatus ( ) const
inline

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

Definition at line 224 of file PiiEntitiesDetectionJobProperties.h.

◆ GetLanguageCode()

const LanguageCode& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::GetLanguageCode ( ) const
inline

The language code of the input documents

Definition at line 497 of file PiiEntitiesDetectionJobProperties.h.

◆ GetMessage()

const Aws::String& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::GetMessage ( ) const
inline

A description of the status of a job.

Definition at line 265 of file PiiEntitiesDetectionJobProperties.h.

◆ GetMode()

const PiiEntitiesDetectionMode& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::GetMode ( ) const
inline

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

Definition at line 578 of file PiiEntitiesDetectionJobProperties.h.

◆ GetOutputDataConfig()

const PiiOutputDataConfig& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::GetOutputDataConfig ( ) const
inline

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

Definition at line 406 of file PiiEntitiesDetectionJobProperties.h.

◆ GetRedactionConfig()

const RedactionConfig& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::GetRedactionConfig ( ) const
inline

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.

Definition at line 446 of file PiiEntitiesDetectionJobProperties.h.

◆ GetSubmitTime()

const Aws::Utils::DateTime& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::GetSubmitTime ( ) const
inline

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

Definition at line 307 of file PiiEntitiesDetectionJobProperties.h.

◆ InputDataConfigHasBeenSet()

bool Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::InputDataConfigHasBeenSet ( ) const
inline

The input properties for a PII entities detection job.

Definition at line 379 of file PiiEntitiesDetectionJobProperties.h.

◆ JobArnHasBeenSet()

bool Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::JobArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, 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

Definition at line 109 of file PiiEntitiesDetectionJobProperties.h.

◆ JobIdHasBeenSet()

bool Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::JobIdHasBeenSet ( ) const
inline

The identifier assigned to the PII entities detection job.

Definition at line 56 of file PiiEntitiesDetectionJobProperties.h.

◆ JobNameHasBeenSet()

bool Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::JobNameHasBeenSet ( ) const
inline

The name that you assigned the PII entities detection job.

Definition at line 186 of file PiiEntitiesDetectionJobProperties.h.

◆ JobStatusHasBeenSet()

bool Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::JobStatusHasBeenSet ( ) const
inline

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

Definition at line 231 of file PiiEntitiesDetectionJobProperties.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::Jsonize ( ) const

◆ LanguageCodeHasBeenSet()

bool Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::LanguageCodeHasBeenSet ( ) const
inline

The language code of the input documents

Definition at line 502 of file PiiEntitiesDetectionJobProperties.h.

◆ MessageHasBeenSet()

bool Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::MessageHasBeenSet ( ) const
inline

A description of the status of a job.

Definition at line 270 of file PiiEntitiesDetectionJobProperties.h.

◆ ModeHasBeenSet()

bool Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::ModeHasBeenSet ( ) const
inline

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

Definition at line 584 of file PiiEntitiesDetectionJobProperties.h.

◆ operator=()

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ OutputDataConfigHasBeenSet()

bool Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::OutputDataConfigHasBeenSet ( ) const
inline

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

Definition at line 412 of file PiiEntitiesDetectionJobProperties.h.

◆ RedactionConfigHasBeenSet()

bool Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::RedactionConfigHasBeenSet ( ) const
inline

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.

Definition at line 455 of file PiiEntitiesDetectionJobProperties.h.

◆ SetDataAccessRoleArn() [1/3]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetDataAccessRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

Definition at line 547 of file PiiEntitiesDetectionJobProperties.h.

◆ SetDataAccessRoleArn() [2/3]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetDataAccessRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

Definition at line 541 of file PiiEntitiesDetectionJobProperties.h.

◆ SetDataAccessRoleArn() [3/3]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetDataAccessRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

Definition at line 553 of file PiiEntitiesDetectionJobProperties.h.

◆ SetEndTime() [1/2]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetEndTime ( Aws::Utils::DateTime &&  value)
inline

The time that the PII entities detection job completed.

Definition at line 358 of file PiiEntitiesDetectionJobProperties.h.

◆ SetEndTime() [2/2]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetEndTime ( const Aws::Utils::DateTime value)
inline

The time that the PII entities detection job completed.

Definition at line 353 of file PiiEntitiesDetectionJobProperties.h.

◆ SetInputDataConfig() [1/2]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetInputDataConfig ( const InputDataConfig value)
inline

The input properties for a PII entities detection job.

Definition at line 384 of file PiiEntitiesDetectionJobProperties.h.

◆ SetInputDataConfig() [2/2]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetInputDataConfig ( InputDataConfig &&  value)
inline

The input properties for a PII entities detection job.

Definition at line 389 of file PiiEntitiesDetectionJobProperties.h.

◆ SetJobArn() [1/3]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetJobArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, 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

Definition at line 131 of file PiiEntitiesDetectionJobProperties.h.

◆ SetJobArn() [2/3]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetJobArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, 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

Definition at line 120 of file PiiEntitiesDetectionJobProperties.h.

◆ SetJobArn() [3/3]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetJobArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, 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

Definition at line 142 of file PiiEntitiesDetectionJobProperties.h.

◆ SetJobId() [1/3]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetJobId ( Aws::String &&  value)
inline

The identifier assigned to the PII entities detection job.

Definition at line 66 of file PiiEntitiesDetectionJobProperties.h.

◆ SetJobId() [2/3]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetJobId ( const Aws::String value)
inline

The identifier assigned to the PII entities detection job.

Definition at line 61 of file PiiEntitiesDetectionJobProperties.h.

◆ SetJobId() [3/3]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetJobId ( const char *  value)
inline

The identifier assigned to the PII entities detection job.

Definition at line 71 of file PiiEntitiesDetectionJobProperties.h.

◆ SetJobName() [1/3]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetJobName ( Aws::String &&  value)
inline

The name that you assigned the PII entities detection job.

Definition at line 196 of file PiiEntitiesDetectionJobProperties.h.

◆ SetJobName() [2/3]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetJobName ( const Aws::String value)
inline

The name that you assigned the PII entities detection job.

Definition at line 191 of file PiiEntitiesDetectionJobProperties.h.

◆ SetJobName() [3/3]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetJobName ( const char *  value)
inline

The name that you assigned the PII entities detection job.

Definition at line 201 of file PiiEntitiesDetectionJobProperties.h.

◆ SetJobStatus() [1/2]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetJobStatus ( const JobStatus value)
inline

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

Definition at line 238 of file PiiEntitiesDetectionJobProperties.h.

◆ SetJobStatus() [2/2]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetJobStatus ( JobStatus &&  value)
inline

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

Definition at line 245 of file PiiEntitiesDetectionJobProperties.h.

◆ SetLanguageCode() [1/2]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetLanguageCode ( const LanguageCode value)
inline

The language code of the input documents

Definition at line 507 of file PiiEntitiesDetectionJobProperties.h.

◆ SetLanguageCode() [2/2]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetLanguageCode ( LanguageCode &&  value)
inline

The language code of the input documents

Definition at line 512 of file PiiEntitiesDetectionJobProperties.h.

◆ SetMessage() [1/3]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetMessage ( Aws::String &&  value)
inline

A description of the status of a job.

Definition at line 280 of file PiiEntitiesDetectionJobProperties.h.

◆ SetMessage() [2/3]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetMessage ( const Aws::String value)
inline

A description of the status of a job.

Definition at line 275 of file PiiEntitiesDetectionJobProperties.h.

◆ SetMessage() [3/3]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetMessage ( const char *  value)
inline

A description of the status of a job.

Definition at line 285 of file PiiEntitiesDetectionJobProperties.h.

◆ SetMode() [1/2]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetMode ( const PiiEntitiesDetectionMode value)
inline

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

Definition at line 590 of file PiiEntitiesDetectionJobProperties.h.

◆ SetMode() [2/2]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetMode ( PiiEntitiesDetectionMode &&  value)
inline

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

Definition at line 596 of file PiiEntitiesDetectionJobProperties.h.

◆ SetOutputDataConfig() [1/2]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetOutputDataConfig ( const PiiOutputDataConfig value)
inline

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

Definition at line 418 of file PiiEntitiesDetectionJobProperties.h.

◆ SetOutputDataConfig() [2/2]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetOutputDataConfig ( PiiOutputDataConfig &&  value)
inline

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

Definition at line 424 of file PiiEntitiesDetectionJobProperties.h.

◆ SetRedactionConfig() [1/2]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetRedactionConfig ( const RedactionConfig value)
inline

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.

Definition at line 464 of file PiiEntitiesDetectionJobProperties.h.

◆ SetRedactionConfig() [2/2]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetRedactionConfig ( RedactionConfig &&  value)
inline

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.

Definition at line 473 of file PiiEntitiesDetectionJobProperties.h.

◆ SetSubmitTime() [1/2]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetSubmitTime ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 325 of file PiiEntitiesDetectionJobProperties.h.

◆ SetSubmitTime() [2/2]

void Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SetSubmitTime ( const Aws::Utils::DateTime value)
inline

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

Definition at line 319 of file PiiEntitiesDetectionJobProperties.h.

◆ SubmitTimeHasBeenSet()

bool Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::SubmitTimeHasBeenSet ( ) const
inline

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

Definition at line 313 of file PiiEntitiesDetectionJobProperties.h.

◆ WithDataAccessRoleArn() [1/3]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithDataAccessRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

Definition at line 565 of file PiiEntitiesDetectionJobProperties.h.

◆ WithDataAccessRoleArn() [2/3]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithDataAccessRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

Definition at line 559 of file PiiEntitiesDetectionJobProperties.h.

◆ WithDataAccessRoleArn() [3/3]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithDataAccessRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

Definition at line 571 of file PiiEntitiesDetectionJobProperties.h.

◆ WithEndTime() [1/2]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithEndTime ( Aws::Utils::DateTime &&  value)
inline

The time that the PII entities detection job completed.

Definition at line 368 of file PiiEntitiesDetectionJobProperties.h.

◆ WithEndTime() [2/2]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithEndTime ( const Aws::Utils::DateTime value)
inline

The time that the PII entities detection job completed.

Definition at line 363 of file PiiEntitiesDetectionJobProperties.h.

◆ WithInputDataConfig() [1/2]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithInputDataConfig ( const InputDataConfig value)
inline

The input properties for a PII entities detection job.

Definition at line 394 of file PiiEntitiesDetectionJobProperties.h.

◆ WithInputDataConfig() [2/2]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithInputDataConfig ( InputDataConfig &&  value)
inline

The input properties for a PII entities detection job.

Definition at line 399 of file PiiEntitiesDetectionJobProperties.h.

◆ WithJobArn() [1/3]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithJobArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, 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

Definition at line 164 of file PiiEntitiesDetectionJobProperties.h.

◆ WithJobArn() [2/3]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithJobArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, 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

Definition at line 153 of file PiiEntitiesDetectionJobProperties.h.

◆ WithJobArn() [3/3]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithJobArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, 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

Definition at line 175 of file PiiEntitiesDetectionJobProperties.h.

◆ WithJobId() [1/3]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithJobId ( Aws::String &&  value)
inline

The identifier assigned to the PII entities detection job.

Definition at line 81 of file PiiEntitiesDetectionJobProperties.h.

◆ WithJobId() [2/3]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithJobId ( const Aws::String value)
inline

The identifier assigned to the PII entities detection job.

Definition at line 76 of file PiiEntitiesDetectionJobProperties.h.

◆ WithJobId() [3/3]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithJobId ( const char *  value)
inline

The identifier assigned to the PII entities detection job.

Definition at line 86 of file PiiEntitiesDetectionJobProperties.h.

◆ WithJobName() [1/3]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithJobName ( Aws::String &&  value)
inline

The name that you assigned the PII entities detection job.

Definition at line 211 of file PiiEntitiesDetectionJobProperties.h.

◆ WithJobName() [2/3]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithJobName ( const Aws::String value)
inline

The name that you assigned the PII entities detection job.

Definition at line 206 of file PiiEntitiesDetectionJobProperties.h.

◆ WithJobName() [3/3]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithJobName ( const char *  value)
inline

The name that you assigned the PII entities detection job.

Definition at line 216 of file PiiEntitiesDetectionJobProperties.h.

◆ WithJobStatus() [1/2]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithJobStatus ( const JobStatus value)
inline

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

Definition at line 252 of file PiiEntitiesDetectionJobProperties.h.

◆ WithJobStatus() [2/2]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithJobStatus ( JobStatus &&  value)
inline

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

Definition at line 259 of file PiiEntitiesDetectionJobProperties.h.

◆ WithLanguageCode() [1/2]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithLanguageCode ( const LanguageCode value)
inline

The language code of the input documents

Definition at line 517 of file PiiEntitiesDetectionJobProperties.h.

◆ WithLanguageCode() [2/2]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithLanguageCode ( LanguageCode &&  value)
inline

The language code of the input documents

Definition at line 522 of file PiiEntitiesDetectionJobProperties.h.

◆ WithMessage() [1/3]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithMessage ( Aws::String &&  value)
inline

A description of the status of a job.

Definition at line 295 of file PiiEntitiesDetectionJobProperties.h.

◆ WithMessage() [2/3]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithMessage ( const Aws::String value)
inline

A description of the status of a job.

Definition at line 290 of file PiiEntitiesDetectionJobProperties.h.

◆ WithMessage() [3/3]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithMessage ( const char *  value)
inline

A description of the status of a job.

Definition at line 300 of file PiiEntitiesDetectionJobProperties.h.

◆ WithMode() [1/2]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithMode ( const PiiEntitiesDetectionMode value)
inline

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

Definition at line 602 of file PiiEntitiesDetectionJobProperties.h.

◆ WithMode() [2/2]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithMode ( PiiEntitiesDetectionMode &&  value)
inline

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

Definition at line 608 of file PiiEntitiesDetectionJobProperties.h.

◆ WithOutputDataConfig() [1/2]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithOutputDataConfig ( const PiiOutputDataConfig value)
inline

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

Definition at line 430 of file PiiEntitiesDetectionJobProperties.h.

◆ WithOutputDataConfig() [2/2]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithOutputDataConfig ( PiiOutputDataConfig &&  value)
inline

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

Definition at line 436 of file PiiEntitiesDetectionJobProperties.h.

◆ WithRedactionConfig() [1/2]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithRedactionConfig ( const RedactionConfig value)
inline

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.

Definition at line 482 of file PiiEntitiesDetectionJobProperties.h.

◆ WithRedactionConfig() [2/2]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithRedactionConfig ( RedactionConfig &&  value)
inline

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.

Definition at line 491 of file PiiEntitiesDetectionJobProperties.h.

◆ WithSubmitTime() [1/2]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithSubmitTime ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 337 of file PiiEntitiesDetectionJobProperties.h.

◆ WithSubmitTime() [2/2]

PiiEntitiesDetectionJobProperties& Aws::Comprehend::Model::PiiEntitiesDetectionJobProperties::WithSubmitTime ( const Aws::Utils::DateTime value)
inline

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

Definition at line 331 of file PiiEntitiesDetectionJobProperties.h.


The documentation for this class was generated from the following file: