Documentation

Provides information about a PII entities detection job.

See: newPiiEntitiesDetectionJobProperties smart constructor.

Create a value of PiiEntitiesDetectionJobProperties with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:languageCode:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_languageCode - The language code of the input documents

$sel:jobId:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_jobId - The identifier assigned to the PII entities detection job.

$sel:jobArn:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_jobArn - 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

$sel:jobName:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_jobName - The name that you assigned the PII entities detection job.

$sel:mode:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_mode - Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.

$sel:inputDataConfig:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_inputDataConfig - The input properties for a PII entities detection job.

$sel:redactionConfig:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_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.

$sel:endTime:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_endTime - The time that the PII entities detection job completed.

$sel:outputDataConfig:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_outputDataConfig - The output data configuration that you supplied when you created the PII entities detection job.

$sel:dataAccessRoleArn:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

$sel:jobStatus:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_jobStatus - The current status of the PII entities detection job. If the status is FAILED, the Message field shows the reason for the failure.

$sel:message:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_message - A description of the status of a job.

$sel:submitTime:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_submitTime - The time that the PII entities detection job was submitted for processing.

The language code of the input documents

The identifier assigned to the PII entities detection job.

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

The name that you assigned the PII entities detection job.

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

The input properties for a PII entities detection job.

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.

The time that the PII entities detection job completed.

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

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

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

A description of the status of a job.

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