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

#include <StartPiiEntitiesDetectionJobRequest.h>

+ Inheritance diagram for Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest:

Public Member Functions

 StartPiiEntitiesDetectionJobRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const InputDataConfigGetInputDataConfig () const
 
bool InputDataConfigHasBeenSet () const
 
void SetInputDataConfig (const InputDataConfig &value)
 
void SetInputDataConfig (InputDataConfig &&value)
 
StartPiiEntitiesDetectionJobRequestWithInputDataConfig (const InputDataConfig &value)
 
StartPiiEntitiesDetectionJobRequestWithInputDataConfig (InputDataConfig &&value)
 
const OutputDataConfigGetOutputDataConfig () const
 
bool OutputDataConfigHasBeenSet () const
 
void SetOutputDataConfig (const OutputDataConfig &value)
 
void SetOutputDataConfig (OutputDataConfig &&value)
 
StartPiiEntitiesDetectionJobRequestWithOutputDataConfig (const OutputDataConfig &value)
 
StartPiiEntitiesDetectionJobRequestWithOutputDataConfig (OutputDataConfig &&value)
 
const PiiEntitiesDetectionModeGetMode () const
 
bool ModeHasBeenSet () const
 
void SetMode (const PiiEntitiesDetectionMode &value)
 
void SetMode (PiiEntitiesDetectionMode &&value)
 
StartPiiEntitiesDetectionJobRequestWithMode (const PiiEntitiesDetectionMode &value)
 
StartPiiEntitiesDetectionJobRequestWithMode (PiiEntitiesDetectionMode &&value)
 
const RedactionConfigGetRedactionConfig () const
 
bool RedactionConfigHasBeenSet () const
 
void SetRedactionConfig (const RedactionConfig &value)
 
void SetRedactionConfig (RedactionConfig &&value)
 
StartPiiEntitiesDetectionJobRequestWithRedactionConfig (const RedactionConfig &value)
 
StartPiiEntitiesDetectionJobRequestWithRedactionConfig (RedactionConfig &&value)
 
const Aws::StringGetDataAccessRoleArn () const
 
bool DataAccessRoleArnHasBeenSet () const
 
void SetDataAccessRoleArn (const Aws::String &value)
 
void SetDataAccessRoleArn (Aws::String &&value)
 
void SetDataAccessRoleArn (const char *value)
 
StartPiiEntitiesDetectionJobRequestWithDataAccessRoleArn (const Aws::String &value)
 
StartPiiEntitiesDetectionJobRequestWithDataAccessRoleArn (Aws::String &&value)
 
StartPiiEntitiesDetectionJobRequestWithDataAccessRoleArn (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)
 
StartPiiEntitiesDetectionJobRequestWithJobName (const Aws::String &value)
 
StartPiiEntitiesDetectionJobRequestWithJobName (Aws::String &&value)
 
StartPiiEntitiesDetectionJobRequestWithJobName (const char *value)
 
const LanguageCodeGetLanguageCode () const
 
bool LanguageCodeHasBeenSet () const
 
void SetLanguageCode (const LanguageCode &value)
 
void SetLanguageCode (LanguageCode &&value)
 
StartPiiEntitiesDetectionJobRequestWithLanguageCode (const LanguageCode &value)
 
StartPiiEntitiesDetectionJobRequestWithLanguageCode (LanguageCode &&value)
 
const Aws::StringGetClientRequestToken () const
 
bool ClientRequestTokenHasBeenSet () const
 
void SetClientRequestToken (const Aws::String &value)
 
void SetClientRequestToken (Aws::String &&value)
 
void SetClientRequestToken (const char *value)
 
StartPiiEntitiesDetectionJobRequestWithClientRequestToken (const Aws::String &value)
 
StartPiiEntitiesDetectionJobRequestWithClientRequestToken (Aws::String &&value)
 
StartPiiEntitiesDetectionJobRequestWithClientRequestToken (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
StartPiiEntitiesDetectionJobRequestWithTags (const Aws::Vector< Tag > &value)
 
StartPiiEntitiesDetectionJobRequestWithTags (Aws::Vector< Tag > &&value)
 
StartPiiEntitiesDetectionJobRequestAddTags (const Tag &value)
 
StartPiiEntitiesDetectionJobRequestAddTags (Tag &&value)
 
- Public Member Functions inherited from Aws::Comprehend::ComprehendRequest
virtual ~ComprehendRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 29 of file StartPiiEntitiesDetectionJobRequest.h.

Constructor & Destructor Documentation

◆ StartPiiEntitiesDetectionJobRequest()

Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::StartPiiEntitiesDetectionJobRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

StartPiiEntitiesDetectionJobRequest& Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::AddTags ( const Tag value)
inline

Tags to be associated 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.

Definition at line 429 of file StartPiiEntitiesDetectionJobRequest.h.

◆ AddTags() [2/2]

StartPiiEntitiesDetectionJobRequest& Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::AddTags ( Tag &&  value)
inline

Tags to be associated 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.

Definition at line 437 of file StartPiiEntitiesDetectionJobRequest.h.

◆ ClientRequestTokenHasBeenSet()

bool Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::ClientRequestTokenHasBeenSet ( ) const
inline

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

Definition at line 336 of file StartPiiEntitiesDetectionJobRequest.h.

◆ DataAccessRoleArnHasBeenSet()

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

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

Definition at line 215 of file StartPiiEntitiesDetectionJobRequest.h.

◆ GetClientRequestToken()

const Aws::String& Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::GetClientRequestToken ( ) const
inline

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

Definition at line 330 of file StartPiiEntitiesDetectionJobRequest.h.

◆ GetDataAccessRoleArn()

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

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

Definition at line 209 of file StartPiiEntitiesDetectionJobRequest.h.

◆ GetInputDataConfig()

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

The input properties for a PII entities detection job.

Definition at line 48 of file StartPiiEntitiesDetectionJobRequest.h.

◆ GetJobName()

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

The identifier of the job.

Definition at line 257 of file StartPiiEntitiesDetectionJobRequest.h.

◆ GetLanguageCode()

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

The language of the input documents.

Definition at line 298 of file StartPiiEntitiesDetectionJobRequest.h.

◆ GetMode()

const PiiEntitiesDetectionMode& Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::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 117 of file StartPiiEntitiesDetectionJobRequest.h.

◆ GetOutputDataConfig()

const OutputDataConfig& Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::GetOutputDataConfig ( ) const
inline

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

Definition at line 80 of file StartPiiEntitiesDetectionJobRequest.h.

◆ GetRedactionConfig()

const RedactionConfig& Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::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 157 of file StartPiiEntitiesDetectionJobRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

◆ GetTags()

const Aws::Vector<Tag>& Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::GetTags ( ) const
inline

Tags to be associated 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.

Definition at line 381 of file StartPiiEntitiesDetectionJobRequest.h.

◆ InputDataConfigHasBeenSet()

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

The input properties for a PII entities detection job.

Definition at line 53 of file StartPiiEntitiesDetectionJobRequest.h.

◆ JobNameHasBeenSet()

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

The identifier of the job.

Definition at line 262 of file StartPiiEntitiesDetectionJobRequest.h.

◆ LanguageCodeHasBeenSet()

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

The language of the input documents.

Definition at line 303 of file StartPiiEntitiesDetectionJobRequest.h.

◆ ModeHasBeenSet()

bool Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::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 123 of file StartPiiEntitiesDetectionJobRequest.h.

◆ OutputDataConfigHasBeenSet()

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

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

Definition at line 86 of file StartPiiEntitiesDetectionJobRequest.h.

◆ RedactionConfigHasBeenSet()

bool Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::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 166 of file StartPiiEntitiesDetectionJobRequest.h.

◆ SerializePayload()

Aws::String Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientRequestToken() [1/3]

void Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::SetClientRequestToken ( Aws::String &&  value)
inline

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

Definition at line 348 of file StartPiiEntitiesDetectionJobRequest.h.

◆ SetClientRequestToken() [2/3]

void Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::SetClientRequestToken ( const Aws::String value)
inline

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

Definition at line 342 of file StartPiiEntitiesDetectionJobRequest.h.

◆ SetClientRequestToken() [3/3]

void Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::SetClientRequestToken ( const char *  value)
inline

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

Definition at line 354 of file StartPiiEntitiesDetectionJobRequest.h.

◆ SetDataAccessRoleArn() [1/3]

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

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

Definition at line 227 of file StartPiiEntitiesDetectionJobRequest.h.

◆ SetDataAccessRoleArn() [2/3]

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

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

Definition at line 221 of file StartPiiEntitiesDetectionJobRequest.h.

◆ SetDataAccessRoleArn() [3/3]

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

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

Definition at line 233 of file StartPiiEntitiesDetectionJobRequest.h.

◆ SetInputDataConfig() [1/2]

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

The input properties for a PII entities detection job.

Definition at line 58 of file StartPiiEntitiesDetectionJobRequest.h.

◆ SetInputDataConfig() [2/2]

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

The input properties for a PII entities detection job.

Definition at line 63 of file StartPiiEntitiesDetectionJobRequest.h.

◆ SetJobName() [1/3]

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

The identifier of the job.

Definition at line 272 of file StartPiiEntitiesDetectionJobRequest.h.

◆ SetJobName() [2/3]

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

The identifier of the job.

Definition at line 267 of file StartPiiEntitiesDetectionJobRequest.h.

◆ SetJobName() [3/3]

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

The identifier of the job.

Definition at line 277 of file StartPiiEntitiesDetectionJobRequest.h.

◆ SetLanguageCode() [1/2]

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

The language of the input documents.

Definition at line 308 of file StartPiiEntitiesDetectionJobRequest.h.

◆ SetLanguageCode() [2/2]

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

The language of the input documents.

Definition at line 313 of file StartPiiEntitiesDetectionJobRequest.h.

◆ SetMode() [1/2]

void Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::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 129 of file StartPiiEntitiesDetectionJobRequest.h.

◆ SetMode() [2/2]

void Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::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 135 of file StartPiiEntitiesDetectionJobRequest.h.

◆ SetOutputDataConfig() [1/2]

void Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::SetOutputDataConfig ( const OutputDataConfig value)
inline

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

Definition at line 92 of file StartPiiEntitiesDetectionJobRequest.h.

◆ SetOutputDataConfig() [2/2]

void Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::SetOutputDataConfig ( OutputDataConfig &&  value)
inline

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

Definition at line 98 of file StartPiiEntitiesDetectionJobRequest.h.

◆ SetRedactionConfig() [1/2]

void Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::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 175 of file StartPiiEntitiesDetectionJobRequest.h.

◆ SetRedactionConfig() [2/2]

void Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::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 184 of file StartPiiEntitiesDetectionJobRequest.h.

◆ SetTags() [1/2]

void Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

Tags to be associated 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.

Definition at line 405 of file StartPiiEntitiesDetectionJobRequest.h.

◆ SetTags() [2/2]

void Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

Tags to be associated 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.

Definition at line 397 of file StartPiiEntitiesDetectionJobRequest.h.

◆ TagsHasBeenSet()

bool Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::TagsHasBeenSet ( ) const
inline

Tags to be associated 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.

Definition at line 389 of file StartPiiEntitiesDetectionJobRequest.h.

◆ WithClientRequestToken() [1/3]

StartPiiEntitiesDetectionJobRequest& Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::WithClientRequestToken ( Aws::String &&  value)
inline

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

Definition at line 366 of file StartPiiEntitiesDetectionJobRequest.h.

◆ WithClientRequestToken() [2/3]

StartPiiEntitiesDetectionJobRequest& Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::WithClientRequestToken ( const Aws::String value)
inline

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

Definition at line 360 of file StartPiiEntitiesDetectionJobRequest.h.

◆ WithClientRequestToken() [3/3]

StartPiiEntitiesDetectionJobRequest& Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::WithClientRequestToken ( const char *  value)
inline

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

Definition at line 372 of file StartPiiEntitiesDetectionJobRequest.h.

◆ WithDataAccessRoleArn() [1/3]

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

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

Definition at line 245 of file StartPiiEntitiesDetectionJobRequest.h.

◆ WithDataAccessRoleArn() [2/3]

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

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

Definition at line 239 of file StartPiiEntitiesDetectionJobRequest.h.

◆ WithDataAccessRoleArn() [3/3]

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

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

Definition at line 251 of file StartPiiEntitiesDetectionJobRequest.h.

◆ WithInputDataConfig() [1/2]

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

The input properties for a PII entities detection job.

Definition at line 68 of file StartPiiEntitiesDetectionJobRequest.h.

◆ WithInputDataConfig() [2/2]

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

The input properties for a PII entities detection job.

Definition at line 73 of file StartPiiEntitiesDetectionJobRequest.h.

◆ WithJobName() [1/3]

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

The identifier of the job.

Definition at line 287 of file StartPiiEntitiesDetectionJobRequest.h.

◆ WithJobName() [2/3]

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

The identifier of the job.

Definition at line 282 of file StartPiiEntitiesDetectionJobRequest.h.

◆ WithJobName() [3/3]

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

The identifier of the job.

Definition at line 292 of file StartPiiEntitiesDetectionJobRequest.h.

◆ WithLanguageCode() [1/2]

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

The language of the input documents.

Definition at line 318 of file StartPiiEntitiesDetectionJobRequest.h.

◆ WithLanguageCode() [2/2]

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

The language of the input documents.

Definition at line 323 of file StartPiiEntitiesDetectionJobRequest.h.

◆ WithMode() [1/2]

StartPiiEntitiesDetectionJobRequest& Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::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 141 of file StartPiiEntitiesDetectionJobRequest.h.

◆ WithMode() [2/2]

StartPiiEntitiesDetectionJobRequest& Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::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 147 of file StartPiiEntitiesDetectionJobRequest.h.

◆ WithOutputDataConfig() [1/2]

StartPiiEntitiesDetectionJobRequest& Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::WithOutputDataConfig ( const OutputDataConfig value)
inline

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

Definition at line 104 of file StartPiiEntitiesDetectionJobRequest.h.

◆ WithOutputDataConfig() [2/2]

StartPiiEntitiesDetectionJobRequest& Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::WithOutputDataConfig ( OutputDataConfig &&  value)
inline

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

Definition at line 110 of file StartPiiEntitiesDetectionJobRequest.h.

◆ WithRedactionConfig() [1/2]

StartPiiEntitiesDetectionJobRequest& Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::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 193 of file StartPiiEntitiesDetectionJobRequest.h.

◆ WithRedactionConfig() [2/2]

StartPiiEntitiesDetectionJobRequest& Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::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 202 of file StartPiiEntitiesDetectionJobRequest.h.

◆ WithTags() [1/2]

StartPiiEntitiesDetectionJobRequest& Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

Tags to be associated 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.

Definition at line 421 of file StartPiiEntitiesDetectionJobRequest.h.

◆ WithTags() [2/2]

StartPiiEntitiesDetectionJobRequest& Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

Tags to be associated 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.

Definition at line 413 of file StartPiiEntitiesDetectionJobRequest.h.


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