Module Values.StartDocumentClassificationJobResponseSource

Starts an asynchronous document classification job using a custom classification model. Use the DescribeDocumentClassificationJob operation to track the progress of the job.

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

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

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

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

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

    The status of the job: SUBMITTED - The job has been received and 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. For details, use the DescribeDocumentClassificationJob 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. documentClassifierArn : DocumentClassifierArn.t option;
    (*

    The ARN of the custom classification 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:??? -> ?documentClassifierArn:??? -> 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