interface StartPiiEntitiesDetectionJobRequest {
    ClientRequestToken?: string;
    DataAccessRoleArn: undefined | string;
    InputDataConfig: undefined | InputDataConfig;
    JobName?: string;
    LanguageCode: undefined | LanguageCode;
    Mode: undefined | PiiEntitiesDetectionMode;
    OutputDataConfig: undefined | OutputDataConfig;
    RedactionConfig?: RedactionConfig;
    Tags?: Tag[];
}

Hierarchy (view full)

Properties

ClientRequestToken?: string

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

DataAccessRoleArn: undefined | string

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

InputDataConfig: undefined | InputDataConfig

The input properties for a PII entities detection job.

JobName?: string

The identifier of the job.

LanguageCode: undefined | LanguageCode

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

Mode: undefined | PiiEntitiesDetectionMode

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

OutputDataConfig: undefined | OutputDataConfig

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

RedactionConfig?: 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.

Tags?: Tag[]

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.