Provides information about a PII entities detection job.

interface PiiEntitiesDetectionJobProperties {
    DataAccessRoleArn?: string;
    EndTime?: Date;
    InputDataConfig?: InputDataConfig;
    JobArn?: string;
    JobId?: string;
    JobName?: string;
    JobStatus?: JobStatus;
    LanguageCode?: LanguageCode;
    Message?: string;
    Mode?: PiiEntitiesDetectionMode;
    OutputDataConfig?: PiiOutputDataConfig;
    RedactionConfig?: RedactionConfig;
    SubmitTime?: Date;
}

Properties

DataAccessRoleArn?: string

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

EndTime?: Date

The time that the PII entities detection job completed.

InputDataConfig?: InputDataConfig

The input properties for a PII entities detection job.

JobArn?: string

The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

arn::comprehend:::pii-entities-detection-job/

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab

JobId?: string

The identifier assigned to the PII entities detection job.

JobName?: string

The name that you assigned the PII entities detection job.

JobStatus?: JobStatus

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

The language code of the input documents.

Message?: string

A description of the status of a job.

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

OutputDataConfig?: PiiOutputDataConfig

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

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.

SubmitTime?: Date

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