pii_entities_detection_jobs

Creates, updates, deletes, gets or lists a pii_entities_detection_jobs resource.

Overview

Name	pii_entities_detection_jobs
Type	Resource
Id	aws.comprehend.pii_entities_detection_jobs

Fields

The following fields are returned by SELECT queries:

describe_pii_entities_detection_job

Name	Datatype	Description
data_access_role_arn	string	The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. (pattern: <code>arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+</code>)
end_time	string (date-time)	The time that the PII entities detection job completed.
input_data_config	object	The input properties for a PII entities detection job.
job_arn	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 (pattern: <code>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])*))?</code>)
job_id	string	The identifier assigned to the PII entities detection job. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-%@]*)$</code>)
job_name	string	The name that you assigned the PII entities detection job. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-%@]*)$</code>)
job_status	string	The current status of the PII entities detection job. If the status is FAILED, the Message field shows the reason for the failure. (SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED)
language_code	string	The language code of the input documents. (en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW)
message	string	A description of the status of a job.
mode	string	Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted. (ONLY_REDACTION, ONLY_OFFSETS)
output_data_config	object	The output data configuration that you supplied when you created the PII entities detection job.
redaction_config	object	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	string (date-time)	The time that the PII entities detection job was submitted for processing.

list_pii_entities_detection_jobs

Name	Datatype	Description
data_access_role_arn	string	The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. (pattern: <code>arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+</code>)
end_time	string (date-time)	The time that the PII entities detection job completed.
input_data_config	object	The input properties for a PII entities detection job.
job_arn	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 (pattern: <code>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])*))?</code>)
job_id	string	The identifier assigned to the PII entities detection job. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-%@]*)$</code>)
job_name	string	The name that you assigned the PII entities detection job. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-%@]*)$</code>)
job_status	string	The current status of the PII entities detection job. If the status is FAILED, the Message field shows the reason for the failure. (SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED)
language_code	string	The language code of the input documents. (en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW)
message	string	A description of the status of a job.
mode	string	Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted. (ONLY_REDACTION, ONLY_OFFSETS)
output_data_config	object	The output data configuration that you supplied when you created the PII entities detection job.
redaction_config	object	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	string (date-time)	The time that the PII entities detection job was submitted for processing.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_pii_entities_detection_job	select	region		Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.
list_pii_entities_detection_jobs	select	region		Gets a list of the PII entity detection jobs that you have submitted.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_pii_entities_detection_job

Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.

SELECT
data_access_role_arn,
end_time,
input_data_config,
job_arn,
job_id,
job_name,
job_status,
language_code,
message,
mode,
output_data_config,
redaction_config,
submit_time
FROM aws.comprehend.pii_entities_detection_jobs
WHERE region = '{{ region }}' -- required
;

list_pii_entities_detection_jobs

Gets a list of the PII entity detection jobs that you have submitted.

SELECT
data_access_role_arn,
end_time,
input_data_config,
job_arn,
job_id,
job_name,
job_status,
language_code,
message,
mode,
output_data_config,
redaction_config,
submit_time
FROM aws.comprehend.pii_entities_detection_jobs
WHERE region = '{{ region }}' -- required
;