Module Values.StartExpenseAnalysisResponseSource

Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names. StartExpenseAnalysis can analyze text in documents that are in JPEG, PNG, and PDF format. The documents must be stored in an Amazon S3 bucket. Use the DocumentLocation parameter to specify the name of your S3 bucket and the name of the document in that bucket. StartExpenseAnalysis returns a job identifier (JobId) that you will provide to GetExpenseAnalysis to retrieve the results of the operation. When the analysis of the input invoices/receipts is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you provide to the NotificationChannel. To obtain the results of the invoice and receipt analysis operation, ensure that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetExpenseAnalysis, and pass the job identifier (JobId) that was returned by your call to StartExpenseAnalysis. For more information, see Analyzing Invoices and Receipts.

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

    A unique identifier for the text detection job. The JobId is returned from StartExpenseAnalysis. 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