PiiEntitiesDetectionJobProperties

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

Provides information about a PII entities detection job.

interface PiiEntitiesDetectionJobProperties {

DataAccessRoleArn?: string | null;

EndTime?: Date | number | null;

InputDataConfig?: InputDataConfig | null;

JobArn?: string | null;

JobId?: string | null;

JobName?: string | null;

JobStatus?: JobStatus | null;

LanguageCode?: LanguageCode | null;

Message?: string | null;

Mode?: PiiEntitiesDetectionMode | null;

OutputDataConfig?: PiiOutputDataConfig | null;

RedactionConfig?: RedactionConfig | null;

SubmitTime?: Date | number | null;

}

§Properties

DataAccessRoleArn?: string | null

[src]

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

EndTime?: Date | number | null

[src]

The time that the PII entities detection job completed.

InputDataConfig?: InputDataConfig | null

[src]

The input properties for a PII entities detection job.

JobArn?: string | null

[src]

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

JobId?: string | null

[src]

The identifier assigned to the PII entities detection job.

JobName?: string | null

[src]

The name that you assigned the PII entities detection job.

JobStatus?: JobStatus | null

[src]

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

LanguageCode?: LanguageCode | null

[src]

The language code of the input documents

Message?: string | null

[src]

A description of the status of a job.

Mode?: PiiEntitiesDetectionMode | null

[src]

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

OutputDataConfig?: PiiOutputDataConfig | null

[src]

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

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.

SubmitTime?: Date | number | null

[src]

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