PiiEntitiesDetectionJobProperties

Provides information about a PII entities detection job.

DataAccessRoleArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

Required: No

EndTime

The time that the PII entities detection job completed.

Type: Timestamp

Required: No

InputDataConfig

The input properties for a PII entities detection job.

Type: InputDataConfig object

Required: No

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, AWS 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

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z0-9-]{1,64}/[a-zA-Z0-9](-*[a-zA-Z0-9])*((/dataset/[a-zA-Z0-9](-*[a-zA-Z0-9])*)|(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*))?

Required: No

JobId

The identifier assigned to the PII entities detection job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Required: No

JobName

The name that you assigned the PII entities detection job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Required: No

JobStatus

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

Type: String

Required: No

LanguageCode

The language code of the input documents.

Type: String

Valid Values: en | es

Required: No

Message

A description of the status of a job.

Type: String

Required: No

Mode

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

Type: String

Valid Values: ONLY_REDACTION | ONLY_OFFSETS

Required: No

OutputDataConfig

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

Type: PiiOutputDataConfig object

Required: No

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.

Type: RedactionConfig object

Required: No

SubmitTime

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

Type: Timestamp

Required: No

PiiEntitiesDetectionJobProperties

Contents

See Also