StartPiiEntitiesDetectionJobRequest

import type { StartPiiEntitiesDetectionJobRequest } from "https://aws-api.deno.dev/v0.4/services/comprehend.ts?docs=full";

interface StartPiiEntitiesDetectionJobRequest {

ClientRequestToken?: string | null;

DataAccessRoleArn: string;

InputDataConfig: InputDataConfig;

JobName?: string | null;

LanguageCode: LanguageCode;

Mode: PiiEntitiesDetectionMode;

OutputDataConfig: OutputDataConfig;

RedactionConfig?: RedactionConfig | null;

Tags?: Tag[] | null;

}

§Properties

ClientRequestToken?: string | null

[src]

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

DataAccessRoleArn: string

[src]

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

InputDataConfig: InputDataConfig

[src]

The input properties for a PII entities detection job.

JobName?: string | null

[src]

The identifier of the job.

LanguageCode: LanguageCode

[src]

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

Mode: PiiEntitiesDetectionMode

[src]

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

OutputDataConfig: OutputDataConfig

[src]

Provides conﬁguration parameters for the output of PII entity detection jobs.

RedactionConfig?: RedactionConfig | null

[src]

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[] | null

[src]

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.