Skip to contents

Starts an asynchronous PII entity detection job for a collection of documents

Source: R/comprehend_operations.R
comprehend_start_pii_entities_detection_job.Rd

Starts an asynchronous PII entity detection job for a collection of documents.

See https://www.paws-r-sdk.com/docs/comprehend_start_pii_entities_detection_job/ for full documentation.

Usage

comprehend_start_pii_entities_detection_job(
  InputDataConfig,
  OutputDataConfig,
  Mode,
  RedactionConfig = NULL,
  DataAccessRoleArn,
  JobName = NULL,
  LanguageCode,
  ClientRequestToken = NULL,
  Tags = NULL
)

Arguments

InputDataConfig

[required] The input properties for a PII entities detection job.

OutputDataConfig

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

Mode

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

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.

DataAccessRoleArn

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

JobName

The identifier of the job.

LanguageCode

[required] The language of the input documents. Enter the language code for English (en) or Spanish (es).

ClientRequestToken

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

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.