Module Values.StartEntitiesDetectionJobResponseSource

Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job. This API can be used for either standard entity detection or custom entity recognition. In order to be used for custom entity recognition, the optional EntityRecognizerArn must be used in order to provide access to the recognizer being used to detect the custom entity.

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

    The identifier generated for the job. To get the status of job, use this identifier with the operation.

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

    The Amazon Resource Name (ARN) of the 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>:entities-detection-job/<job-id> The following is an example job ARN: arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab

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

    The status of the job. SUBMITTED - The job has been received and is queued for processing. IN_PROGRESS - Amazon Comprehend is processing the job. COMPLETED - The job was successfully completed and the output is available. FAILED - The job did not complete. To get details, use the operation. STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request. STOPPED - The job was successfully stopped without completing.

    *)
  4. entityRecognizerArn : EntityRecognizerArn.t option;
    (*

    The ARN of the custom entity recognition model.

    *)
}
Sourcetype nonrec error = [
  1. | `InternalServerException of InternalServerException.t
  2. | `InvalidRequestException of InvalidRequestException.t
  3. | `KmsKeyValidationException of KmsKeyValidationException.t
  4. | `ResourceInUseException of ResourceInUseException.t
  5. | `ResourceNotFoundException of ResourceNotFoundException.t
  6. | `ResourceUnavailableException of ResourceUnavailableException.t
  7. | `TooManyRequestsException of TooManyRequestsException.t
  8. | `TooManyTagsException of TooManyTagsException.t
  9. | `Unknown_operation_error of string * string option
]
Sourceval make : ?jobId:??? -> ?jobArn:??? -> ?jobStatus:??? -> ?entityRecognizerArn:??? -> 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 | `ResourceNotFoundException of ResourceNotFoundException.t | `ResourceUnavailableException of ResourceUnavailableException.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 | `ResourceNotFoundException of ResourceNotFoundException.t | `ResourceUnavailableException of ResourceUnavailableException.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