class Aws::Comprehend::Types::PiiEntitiesDetectionJobProperties

Provides information about a PII entities detection job.

@!attribute [rw] job_id

The identifier assigned to the PII entities detection job.
@return [String]

@!attribute [rw] job_arn

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`
@return [String]

@!attribute [rw] job_name

The name that you assigned the PII entities detection job.
@return [String]

@!attribute [rw] job_status

The current status of the PII entities detection job. If the status
is `FAILED`, the `Message` field shows the reason for the failure.
@return [String]

@!attribute [rw] message

A description of the status of a job.
@return [String]

@!attribute [rw] submit_time

The time that the PII entities detection job was submitted for
processing.
@return [Time]

@!attribute [rw] end_time

The time that the PII entities detection job completed.
@return [Time]

@!attribute [rw] input_data_config

The input properties for a PII entities detection job.
@return [Types::InputDataConfig]

@!attribute [rw] output_data_config

The output data configuration that you supplied when you created the
PII entities detection job.
@return [Types::PiiOutputDataConfig]

@!attribute [rw] redaction_config

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.
@return [Types::RedactionConfig]

@!attribute [rw] language_code

The language code of the input documents
@return [String]

@!attribute [rw] data_access_role_arn

The Amazon Resource Name (ARN) that gives Amazon Comprehend read
access to your input data.
@return [String]

@!attribute [rw] mode

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

@see docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PiiEntitiesDetectionJobProperties AWS API Documentation

Constants

SENSITIVE