Module Values.StartPiiEntitiesDetectionJobRequestSource

Starts an asynchronous PII entity detection job for a collection of documents.

Sourcetype nonrec t = {
  1. inputDataConfig : InputDataConfig.t;
    (*

    The input properties for a PII entities detection job.

    *)
  2. outputDataConfig : OutputDataConfig.t;
    (*

    Provides configuration parameters for the output of PII entity detection jobs.

    *)
  3. mode : PiiEntitiesDetectionMode.t;
    (*

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

    *)
  4. 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.

    *)
  5. dataAccessRoleArn : IamRoleArn.t;
    (*

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

    *)
  6. jobName : JobName.t option;
    (*

    The identifier of the job.

    *)
  7. languageCode : LanguageCode.t;
    (*

    The language of the input documents. Enter the language code for English (en) or Spanish (es).

    *)
  8. clientRequestToken : ClientRequestTokenString.t option;
    (*

    A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

    *)
  9. tags : TagList.t option;
    (*

    Tags to associate with the PII entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

    *)
}
Sourceval context_ : string
Sourceval make : ?redactionConfig:??? -> ?jobName:??? -> ?clientRequestToken:??? -> ?tags:??? -> inputDataConfig:InputDataConfig.t -> outputDataConfig:OutputDataConfig.t -> mode:PiiEntitiesDetectionMode.t -> dataAccessRoleArn:IamRoleArn.t -> languageCode:LanguageCode.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `String of TagKey.t ]) list ] list | `String of IamRoleArn.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 ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t