Module Values.StartDocumentAnalysisResponseSource

Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements. StartDocumentAnalysis can analyze text in documents that are in JPEG, PNG, TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document. StartDocumentAnalysis returns a job identifier (JobId) that you use to get the results of the operation. When text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis. For more information, see Document Text Analysis.

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

    The identifier for the document text detection job. Use JobId to identify the job in a subsequent call to GetDocumentAnalysis. A JobId value is only valid for 7 days.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of AccessDeniedException.t
  2. | `BadDocumentException of BadDocumentException.t
  3. | `DocumentTooLargeException of DocumentTooLargeException.t
  4. | `IdempotentParameterMismatchException of IdempotentParameterMismatchException.t
  5. | `InternalServerError of InternalServerError.t
  6. | `InvalidKMSKeyException of InvalidKMSKeyException.t
  7. | `InvalidParameterException of InvalidParameterException.t
  8. | `InvalidS3ObjectException of InvalidS3ObjectException.t
  9. | `LimitExceededException of LimitExceededException.t
  10. | `ProvisionedThroughputExceededException of ProvisionedThroughputExceededException.t
  11. | `ThrottlingException of ThrottlingException.t
  12. | `UnsupportedDocumentException of UnsupportedDocumentException.t
  13. | `Unknown_operation_error of string * string option
]
Sourceval make : ?jobId:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of unit | `BadDocumentException of unit | `DocumentTooLargeException of unit | `IdempotentParameterMismatchException of unit | `InternalServerError of unit | `InvalidKMSKeyException of unit | `InvalidParameterException of unit | `InvalidS3ObjectException of unit | `LimitExceededException of unit | `ProvisionedThroughputExceededException of unit | `ThrottlingException of unit | `Unknown_operation_error of string * string option | `UnsupportedDocumentException of unit ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `AccessDeniedException of unit | `BadDocumentException of unit | `DocumentTooLargeException of unit | `IdempotentParameterMismatchException of unit | `InternalServerError of unit | `InvalidKMSKeyException of unit | `InvalidParameterException of unit | `InvalidS3ObjectException of unit | `LimitExceededException of unit | `ProvisionedThroughputExceededException of unit | `ThrottlingException of unit | `Unknown_operation_error of string * string option | `UnsupportedDocumentException of unit ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure 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