Module Values.StartPiiEntitiesDetectionJobResponseSource

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

Sourcetype nonrec t = {
  1. jobId : JobId.t option;
    (*

    The identifier generated for the job.

    *)
  2. jobArn : ComprehendArn.t option;
    (*

    The Amazon Resource Name (ARN) of the PII entity 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

    *)
  3. jobStatus : JobStatus.t option;
    (*

    The status of the job.

    *)
}
Sourcetype nonrec error = [
  1. | `InternalServerException of InternalServerException.t
  2. | `InvalidRequestException of InvalidRequestException.t
  3. | `KmsKeyValidationException of KmsKeyValidationException.t
  4. | `ResourceInUseException of ResourceInUseException.t
  5. | `TooManyRequestsException of TooManyRequestsException.t
  6. | `TooManyTagsException of TooManyTagsException.t
  7. | `Unknown_operation_error of string * string option
]
Sourceval make : ?jobId:??? -> ?jobArn:??? -> ?jobStatus:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `InternalServerException of InternalServerException.t | `InvalidRequestException of InvalidRequestException.t | `KmsKeyValidationException of KmsKeyValidationException.t | `ResourceInUseException of ResourceInUseException.t | `TooManyRequestsException of TooManyRequestsException.t | `TooManyTagsException of TooManyTagsException.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `InternalServerException of InternalServerException.t | `InvalidRequestException of InvalidRequestException.t | `KmsKeyValidationException of KmsKeyValidationException.t | `ResourceInUseException of ResourceInUseException.t | `TooManyRequestsException of TooManyRequestsException.t | `TooManyTagsException of TooManyTagsException.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `String of JobId.t ]) 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