Comprehend PII Entities Detection Job Properties
Comprehend PII Entities Detection Job Properties in AWS describe the details of a job that identifies and processes personally identifiable information (PII) within text. It includes information such as job status, input and output data configuration, language code, job name, and timestamps. This resource helps track and manage PII detection jobs, ensuring sensitive data is recognized and handled appropriately.
aws.comprehend_pii_entities_detection_job
Fields
| Title | ID | Type | Data Type | Description |
|---|
| _key | core | string | |
| account_id | core | string | |
| data_access_role_arn | core | string | The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. |
| end_time | core | timestamp | The time that the PII entities detection job completed. |
| input_data_config | core | json | The input properties for a PII entities detection job. |
| job_arn | core | 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:<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 |
| job_id | core | string | The identifier assigned to the PII entities detection job. |
| job_name | core | string | The name that you assigned the PII entities detection job. |
| job_status | core | string | The current status of the PII entities detection job. If the status is FAILED, the Message field shows the reason for the failure. |
| language_code | core | string | The language code of the input documents. |
| message | core | string | A description of the status of a job. |
| mode | core | string | Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted. |
| output_data_config | core | json | The output data configuration that you supplied when you created the PII entities detection job. |
| redaction_config | core | json | 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. |
| submit_time | core | timestamp | The time that the PII entities detection job was submitted for processing. |
| tags | core | hstore | |
