@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonTextractAsyncClient extends AmazonTextractClient implements AmazonTextractAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Amazon Textract detects and analyzes text in documents and converts it into machine-readable text. This is the API reference documentation for Amazon Textract.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXanalyzeDocument, builder, detectDocumentText, getCachedResponseMetadata, getDocumentAnalysis, getDocumentTextDetection, startDocumentAnalysis, startDocumentTextDetectionaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitanalyzeDocument, detectDocumentText, getCachedResponseMetadata, getDocumentAnalysis, getDocumentTextDetection, startDocumentAnalysis, startDocumentTextDetectionpublic static AmazonTextractAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<AnalyzeDocumentResult> analyzeDocumentAsync(AnalyzeDocumentRequest request)
AmazonTextractAsyncAnalyzes an input document for relationships in the detected text and tables.
Two types of information are returned:
Words and lines that are related to nearby lines and words. The related information is returned in two Block objects: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.
Table and table cell data. A TABLE Block contains information about a detected table. A CELL block is returned for each cell in a table.
You can choose which type of analysis to perform by specifying the FeatureTypes list.
The output is returned in a list of BLOCK objects (Blocks). For more information, see
how-it-works-analyzing.
AnalyzeDocument is a synchronous operation. To analyze documents asynchronously, use
StartDocumentAnalysis.
analyzeDocumentAsync in interface AmazonTextractAsyncpublic Future<AnalyzeDocumentResult> analyzeDocumentAsync(AnalyzeDocumentRequest request, AsyncHandler<AnalyzeDocumentRequest,AnalyzeDocumentResult> asyncHandler)
AmazonTextractAsyncAnalyzes an input document for relationships in the detected text and tables.
Two types of information are returned:
Words and lines that are related to nearby lines and words. The related information is returned in two Block objects: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.
Table and table cell data. A TABLE Block contains information about a detected table. A CELL block is returned for each cell in a table.
You can choose which type of analysis to perform by specifying the FeatureTypes list.
The output is returned in a list of BLOCK objects (Blocks). For more information, see
how-it-works-analyzing.
AnalyzeDocument is a synchronous operation. To analyze documents asynchronously, use
StartDocumentAnalysis.
analyzeDocumentAsync in interface AmazonTextractAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DetectDocumentTextResult> detectDocumentTextAsync(DetectDocumentTextRequest request)
AmazonTextractAsync
Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of
text. The input document must be an image in JPG or PNG format. DetectDocumentText returns the
detected text in an array of Block objects. For more information, see how-it-works-detecting.
DetectDocumentText is a synchronous operation. To analyze documents asynchronously, use
StartDocumentTextDetection.
detectDocumentTextAsync in interface AmazonTextractAsyncpublic Future<DetectDocumentTextResult> detectDocumentTextAsync(DetectDocumentTextRequest request, AsyncHandler<DetectDocumentTextRequest,DetectDocumentTextResult> asyncHandler)
AmazonTextractAsync
Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of
text. The input document must be an image in JPG or PNG format. DetectDocumentText returns the
detected text in an array of Block objects. For more information, see how-it-works-detecting.
DetectDocumentText is a synchronous operation. To analyze documents asynchronously, use
StartDocumentTextDetection.
detectDocumentTextAsync in interface AmazonTextractAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetDocumentAnalysisResult> getDocumentAnalysisAsync(GetDocumentAnalysisRequest request)
AmazonTextractAsyncGets the results for an Amazon Textract asynchronous operation that analyzes text in a document image.
You start asynchronous text analysis by calling StartDocumentAnalysis, which returns a job identifier (
JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to
the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to
StartDocumentAnalysis. 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
GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to
StartDocumentAnalysis.
GetDocumentAnalysis returns an array of Block objects. For more information, see
how-it-works-analyzing.
Use the MaxResults parameter to limit the number of blocks returned. If there are more results than
specified in MaxResults, the value of NextToken in the operation response contains a
pagination token for getting the next set of results. To get the next page of results, call
GetDocumentAnalysis, and populate the NextToken request parameter with the token value
that's returned from the previous call to GetDocumentAnalysis.
getDocumentAnalysisAsync in interface AmazonTextractAsyncpublic Future<GetDocumentAnalysisResult> getDocumentAnalysisAsync(GetDocumentAnalysisRequest request, AsyncHandler<GetDocumentAnalysisRequest,GetDocumentAnalysisResult> asyncHandler)
AmazonTextractAsyncGets the results for an Amazon Textract asynchronous operation that analyzes text in a document image.
You start asynchronous text analysis by calling StartDocumentAnalysis, which returns a job identifier (
JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to
the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to
StartDocumentAnalysis. 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
GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to
StartDocumentAnalysis.
GetDocumentAnalysis returns an array of Block objects. For more information, see
how-it-works-analyzing.
Use the MaxResults parameter to limit the number of blocks returned. If there are more results than
specified in MaxResults, the value of NextToken in the operation response contains a
pagination token for getting the next set of results. To get the next page of results, call
GetDocumentAnalysis, and populate the NextToken request parameter with the token value
that's returned from the previous call to GetDocumentAnalysis.
getDocumentAnalysisAsync in interface AmazonTextractAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetDocumentTextDetectionResult> getDocumentTextDetectionAsync(GetDocumentTextDetectionRequest request)
AmazonTextractAsyncGets the results for an Amazon Textract asynchronous operation that detects text in a document image. Amazon Textract can detect lines of text and the words that make up a line of text.
You start asynchronous text detection by calling StartDocumentTextDetection, which returns a job
identifier (JobId). When the text detection operation finishes, Amazon Textract publishes a
completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial
call to StartDocumentTextDetection. 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.
GetDocumentTextDetection returns an array of Block objects. For more information, see
how-it-works-detecting.
Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than
specified in MaxResults, the value of NextToken in the operation response contains a
pagination token for getting the next set of results. To get the next page of results, call
GetDocumentTextDetection, and populate the NextToken request parameter with the token
value that's returned from the previous call to GetDocumentTextDetection.
For more information, see Document Text Detection in the Amazon Textract Developer Guide.
getDocumentTextDetectionAsync in interface AmazonTextractAsyncpublic Future<GetDocumentTextDetectionResult> getDocumentTextDetectionAsync(GetDocumentTextDetectionRequest request, AsyncHandler<GetDocumentTextDetectionRequest,GetDocumentTextDetectionResult> asyncHandler)
AmazonTextractAsyncGets the results for an Amazon Textract asynchronous operation that detects text in a document image. Amazon Textract can detect lines of text and the words that make up a line of text.
You start asynchronous text detection by calling StartDocumentTextDetection, which returns a job
identifier (JobId). When the text detection operation finishes, Amazon Textract publishes a
completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial
call to StartDocumentTextDetection. 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.
GetDocumentTextDetection returns an array of Block objects. For more information, see
how-it-works-detecting.
Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than
specified in MaxResults, the value of NextToken in the operation response contains a
pagination token for getting the next set of results. To get the next page of results, call
GetDocumentTextDetection, and populate the NextToken request parameter with the token
value that's returned from the previous call to GetDocumentTextDetection.
For more information, see Document Text Detection in the Amazon Textract Developer Guide.
getDocumentTextDetectionAsync in interface AmazonTextractAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartDocumentAnalysisResult> startDocumentAnalysisAsync(StartDocumentAnalysisRequest request)
AmazonTextractAsyncStarts asynchronous analysis of text for relationships in the text and tables that are detected in a document. Amazon Textract returns for two types of information:
Words and lines that are related to nearby lines and words. The related information is returned in two Block objects: A KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.
Table and table cell data. A TABLE block contains information about a detected table. A CELL block is returned for each cell in a table.
Amazon Textract can analyze text in document images and PDF files that are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document image.
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.
startDocumentAnalysisAsync in interface AmazonTextractAsyncpublic Future<StartDocumentAnalysisResult> startDocumentAnalysisAsync(StartDocumentAnalysisRequest request, AsyncHandler<StartDocumentAnalysisRequest,StartDocumentAnalysisResult> asyncHandler)
AmazonTextractAsyncStarts asynchronous analysis of text for relationships in the text and tables that are detected in a document. Amazon Textract returns for two types of information:
Words and lines that are related to nearby lines and words. The related information is returned in two Block objects: A KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.
Table and table cell data. A TABLE block contains information about a detected table. A CELL block is returned for each cell in a table.
Amazon Textract can analyze text in document images and PDF files that are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document image.
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.
startDocumentAnalysisAsync in interface AmazonTextractAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartDocumentTextDetectionResult> startDocumentTextDetectionAsync(StartDocumentTextDetectionRequest request)
AmazonTextractAsyncStarts 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.
Amazon Textract can detect text in document images and PDF files that are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and the file name of the document image.
StartTextDetection 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 in the Amazon Textract Developer Guide.
startDocumentTextDetectionAsync in interface AmazonTextractAsyncpublic Future<StartDocumentTextDetectionResult> startDocumentTextDetectionAsync(StartDocumentTextDetectionRequest request, AsyncHandler<StartDocumentTextDetectionRequest,StartDocumentTextDetectionResult> asyncHandler)
AmazonTextractAsyncStarts 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.
Amazon Textract can detect text in document images and PDF files that are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and the file name of the document image.
StartTextDetection 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 in the Amazon Textract Developer Guide.
startDocumentTextDetectionAsync in interface AmazonTextractAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonTextractshutdown in class AmazonWebServiceClientCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.