Values.PiiEntitiesDetectionJobPropertiesSourceProvides information about a PII entities detection job.
type nonrec t = {jobId : JobId.t option;The identifier assigned to the PII entities detection job.
*)jobArn : ComprehendArn.t option;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
*)jobName : JobName.t option;The name that you assigned the PII entities detection job.
*)jobStatus : JobStatus.t option;The current status of the PII entities detection job. If the status is FAILED, the Message field shows the reason for the failure.
*)message : AnyLengthString.t option;A description of the status of a job.
*)submitTime : Timestamp.t option;The time that the PII entities detection job was submitted for processing.
*)endTime : Timestamp.t option;The time that the PII entities detection job completed.
*)inputDataConfig : InputDataConfig.t option;The input properties for a PII entities detection job.
*)outputDataConfig : PiiOutputDataConfig.t option;The output data configuration that you supplied when you created the PII entities detection job.
*)redactionConfig : RedactionConfig.t option;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.
*)languageCode : LanguageCode.t option;The language code of the input documents.
*)dataAccessRoleArn : IamRoleArn.t option;The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
*)mode : PiiEntitiesDetectionMode.t option;Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
*)}val to_value :
t ->
[> `Structure of
(string
* [> `Enum of string
| `String of JobId.t
| `Structure of
(string
* [> `Enum of string
| `List of [> `Enum of string ] list
| `String of S3Uri.t
| `Structure of
(string
* [> `Enum of string | `List of [> `Enum of string ] list ])
list ])
list
| `Timestamp of Timestamp.t ])
list ]