Module Smaws_Client_Textract.StartDocumentTextDetection

Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.

StartDocumentTextDetection 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.

StartDocumentTextDetection returns a job identifier (JobId) that you use to get the results of the operation. When text detection 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 detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job identifier (JobId) from the initial call to StartDocumentTextDetection.

For more information, see Document Text Detection.

val error_to_string : [ Smaws_Lib.Protocols.AwsJson.error | `AccessDeniedException of Types.access_denied_exception | `BadDocumentException of Types.bad_document_exception | `DocumentTooLargeException of Types.document_too_large_exception | `IdempotentParameterMismatchException of Types.idempotent_parameter_mismatch_exception | `InternalServerError of Types.internal_server_error | `InvalidKMSKeyException of Types.invalid_kms_key_exception | `InvalidParameterException of Types.invalid_parameter_exception | `InvalidS3ObjectException of Types.invalid_s3_object_exception | `LimitExceededException of Types.limit_exceeded_exception | `ProvisionedThroughputExceededException of Types.provisioned_throughput_exceeded_exception | `ThrottlingException of Types.throttling_exception | `UnsupportedDocumentException of Types.unsupported_document_exception ] -> string
val request : 'http_type Smaws_Lib.Context.t -> Types.start_document_text_detection_request -> (Types.start_document_text_detection_response, [> Smaws_Lib.Protocols.AwsJson.error | `AccessDeniedException of Types.access_denied_exception | `BadDocumentException of Types.bad_document_exception | `DocumentTooLargeException of Types.document_too_large_exception | `IdempotentParameterMismatchException of Types.idempotent_parameter_mismatch_exception | `InternalServerError of Types.internal_server_error | `InvalidKMSKeyException of Types.invalid_kms_key_exception | `InvalidParameterException of Types.invalid_parameter_exception | `InvalidS3ObjectException of Types.invalid_s3_object_exception | `LimitExceededException of Types.limit_exceeded_exception | `ProvisionedThroughputExceededException of Types.provisioned_throughput_exceeded_exception | `ThrottlingException of Types.throttling_exception | `UnsupportedDocumentException of Types.unsupported_document_exception ]) Stdlib.result
val request_with_metadata : 'http_type Smaws_Lib.Context.t -> Types.start_document_text_detection_request -> (Types.start_document_text_detection_response Smaws_Lib.Response.t, [> Smaws_Lib.Protocols.AwsJson.error | `AccessDeniedException of Types.access_denied_exception | `BadDocumentException of Types.bad_document_exception | `DocumentTooLargeException of Types.document_too_large_exception | `IdempotentParameterMismatchException of Types.idempotent_parameter_mismatch_exception | `InternalServerError of Types.internal_server_error | `InvalidKMSKeyException of Types.invalid_kms_key_exception | `InvalidParameterException of Types.invalid_parameter_exception | `InvalidS3ObjectException of Types.invalid_s3_object_exception | `LimitExceededException of Types.limit_exceeded_exception | `ProvisionedThroughputExceededException of Types.provisioned_throughput_exceeded_exception | `ThrottlingException of Types.throttling_exception | `UnsupportedDocumentException of Types.unsupported_document_exception ] * Smaws_Lib.Response.metadata) Stdlib.result