public class AmazonTextractAsyncClient extends AmazonTextractClient implements AmazonTextractAsync
Amazon Textract detects and analyzes text in documents and converts it into machine-readable text. This is the API reference documentation for Amazon Textract.
jsonErrorUnmarshallersclient, clientConfiguration, endpoint, endpointPrefix, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset| Constructor and Description |
|---|
AmazonTextractAsyncClient()
Deprecated.
|
AmazonTextractAsyncClient(AWSCredentials awsCredentials)
Constructs a new asynchronous client to invoke service methods on Amazon
Textract using the specified AWS account credentials.
|
AmazonTextractAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on Amazon
Textract using the specified AWS account credentials, executor service,
and client configuration options.
|
AmazonTextractAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on Amazon
Textract using the specified AWS account credentials and executor
service.
|
AmazonTextractAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new asynchronous client to invoke service methods on Amazon
Textract using the specified AWS account credentials provider.
|
AmazonTextractAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on Amazon
Textract using the specified AWS account credentials provider and client
configuration options.
|
AmazonTextractAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on Amazon
Textract using the specified AWS account credentials provider, executor
service, and client configuration options.
|
AmazonTextractAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on Amazon
Textract using the specified AWS account credentials provider and
executor service.
|
AmazonTextractAsyncClient(ClientConfiguration clientConfiguration)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
Future<AnalyzeDocumentResult> |
analyzeDocumentAsync(AnalyzeDocumentRequest analyzeDocumentRequest)
Analyzes an input document for relationships between detected items.
|
Future<AnalyzeDocumentResult> |
analyzeDocumentAsync(AnalyzeDocumentRequest analyzeDocumentRequest,
AsyncHandler<AnalyzeDocumentRequest,AnalyzeDocumentResult> asyncHandler)
Analyzes an input document for relationships between detected items.
|
Future<DetectDocumentTextResult> |
detectDocumentTextAsync(DetectDocumentTextRequest detectDocumentTextRequest)
Detects text in the input document.
|
Future<DetectDocumentTextResult> |
detectDocumentTextAsync(DetectDocumentTextRequest detectDocumentTextRequest,
AsyncHandler<DetectDocumentTextRequest,DetectDocumentTextResult> asyncHandler)
Detects text in the input document.
|
Future<GetDocumentAnalysisResult> |
getDocumentAnalysisAsync(GetDocumentAnalysisRequest getDocumentAnalysisRequest)
Gets the results for an Amazon Textract asynchronous operation that
analyzes text in a document.
|
Future<GetDocumentAnalysisResult> |
getDocumentAnalysisAsync(GetDocumentAnalysisRequest getDocumentAnalysisRequest,
AsyncHandler<GetDocumentAnalysisRequest,GetDocumentAnalysisResult> asyncHandler)
Gets the results for an Amazon Textract asynchronous operation that
analyzes text in a document.
|
Future<GetDocumentTextDetectionResult> |
getDocumentTextDetectionAsync(GetDocumentTextDetectionRequest getDocumentTextDetectionRequest)
Gets the results for an Amazon Textract asynchronous operation that
detects text in a document.
|
Future<GetDocumentTextDetectionResult> |
getDocumentTextDetectionAsync(GetDocumentTextDetectionRequest getDocumentTextDetectionRequest,
AsyncHandler<GetDocumentTextDetectionRequest,GetDocumentTextDetectionResult> asyncHandler)
Gets the results for an Amazon Textract asynchronous operation that
detects text in a document.
|
ExecutorService |
getExecutorService()
Returns the executor service used by this async client to execute
requests.
|
void |
shutdown()
Shuts down the client, releasing all managed resources.
|
Future<StartDocumentAnalysisResult> |
startDocumentAnalysisAsync(StartDocumentAnalysisRequest startDocumentAnalysisRequest)
Starts asynchronous analysis of an input document for relationships
between detected items such as key and value pairs, tables, and selection
elements.
|
Future<StartDocumentAnalysisResult> |
startDocumentAnalysisAsync(StartDocumentAnalysisRequest startDocumentAnalysisRequest,
AsyncHandler<StartDocumentAnalysisRequest,StartDocumentAnalysisResult> asyncHandler)
Starts asynchronous analysis of an input document for relationships
between detected items such as key and value pairs, tables, and selection
elements.
|
Future<StartDocumentTextDetectionResult> |
startDocumentTextDetectionAsync(StartDocumentTextDetectionRequest startDocumentTextDetectionRequest)
Starts the asynchronous detection of text in a document.
|
Future<StartDocumentTextDetectionResult> |
startDocumentTextDetectionAsync(StartDocumentTextDetectionRequest startDocumentTextDetectionRequest,
AsyncHandler<StartDocumentTextDetectionRequest,StartDocumentTextDetectionResult> asyncHandler)
Starts the asynchronous detection of text in a document.
|
analyzeDocument, detectDocumentText, getCachedResponseMetadata, getDocumentAnalysis, getDocumentTextDetection, startDocumentAnalysis, startDocumentTextDetectionaddRequestHandler, addRequestHandler, configSigner, configSigner, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpoint, getEndpointPrefix, getRegions, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitanalyzeDocument, detectDocumentText, getCachedResponseMetadata, getDocumentAnalysis, getDocumentTextDetection, setEndpoint, setRegion, startDocumentAnalysis, startDocumentTextDetection@Deprecated public AmazonTextractAsyncClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AmazonTextractAsyncClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling
how this client connects to Amazon Textract (ex: proxy
settings, retry counts, etc.).DefaultAWSCredentialsProviderChainpublic AmazonTextractAsyncClient(AWSCredentials awsCredentials)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentials - The AWS credentials (access key ID and secret key)
to use when authenticating with AWS services.public AmazonTextractAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentials - The AWS credentials (access key ID and secret key)
to use when authenticating with AWS services.executorService - The executor service by which all asynchronous
requests will be executed.public AmazonTextractAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentials - The AWS credentials (access key ID and secret key)
to use when authenticating with AWS services.clientConfiguration - Client configuration options (ex: max retry
limit, proxy settings, etc).executorService - The executor service by which all asynchronous
requests will be executed.public AmazonTextractAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentialsProvider - The AWS credentials provider which will
provide credentials to authenticate requests with AWS
services.public AmazonTextractAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentialsProvider - The AWS credentials provider which will
provide credentials to authenticate requests with AWS
services.executorService - The executor service by which all asynchronous
requests will be executed.public AmazonTextractAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentialsProvider - The AWS credentials provider which will
provide credentials to authenticate requests with AWS
services.clientConfiguration - Client configuration options (ex: max retry
limit, proxy settings, etc).public AmazonTextractAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentialsProvider - The AWS credentials provider which will
provide credentials to authenticate requests with AWS
services.clientConfiguration - Client configuration options (ex: max retry
limit, proxy settings, etc).executorService - The executor service by which all asynchronous
requests will be executed.public ExecutorService getExecutorService()
public void shutdown()
shutdown in interface AmazonTextractshutdown in class AmazonWebServiceClientpublic Future<AnalyzeDocumentResult> analyzeDocumentAsync(AnalyzeDocumentRequest analyzeDocumentRequest) throws AmazonServiceException, AmazonClientException
Analyzes an input document for relationships between detected items.
The types of information returned are as follows:
Words and lines that are related to nearby lines and words. The related
information is returned in two Block objects each of type
KEY_VALUE_SET: 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 object contains information about a detected table. A CELL Block object is returned for each cell in a table.
Selectable elements such as checkboxes and radio buttons. A SELECTION_ELEMENT Block object contains information about a selectable element.
Lines and words of text. A LINE Block object contains one or more WORD Block objects.
You can choose which type of analysis to perform by specifying the
FeatureTypes list.
The output is returned in a list of BLOCK objects.
AnalyzeDocument is a synchronous operation. To analyze
documents asynchronously, use StartDocumentAnalysis.
For more information, see Document Text Analysis.
analyzeDocumentAsync in interface AmazonTextractAsyncanalyzeDocumentRequest - InvalidParameterExceptionInvalidS3ObjectExceptionUnsupportedDocumentExceptionDocumentTooLargeExceptionBadDocumentExceptionAccessDeniedExceptionProvisionedThroughputExceededExceptionInternalServerErrorExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Textract indicating either a problem with the data in the
request, or a server side issue.public Future<AnalyzeDocumentResult> analyzeDocumentAsync(AnalyzeDocumentRequest analyzeDocumentRequest, AsyncHandler<AnalyzeDocumentRequest,AnalyzeDocumentResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Analyzes an input document for relationships between detected items.
The types of information returned are as follows:
Words and lines that are related to nearby lines and words. The related
information is returned in two Block objects each of type
KEY_VALUE_SET: 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 object contains information about a detected table. A CELL Block object is returned for each cell in a table.
Selectable elements such as checkboxes and radio buttons. A SELECTION_ELEMENT Block object contains information about a selectable element.
Lines and words of text. A LINE Block object contains one or more WORD Block objects.
You can choose which type of analysis to perform by specifying the
FeatureTypes list.
The output is returned in a list of BLOCK objects.
AnalyzeDocument is a synchronous operation. To analyze
documents asynchronously, use StartDocumentAnalysis.
For more information, see Document Text Analysis.
analyzeDocumentAsync in interface AmazonTextractAsyncanalyzeDocumentRequest - asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the
implementation of the four callback methods in this interface
to process the operation result or handle the exception.InvalidParameterExceptionInvalidS3ObjectExceptionUnsupportedDocumentExceptionDocumentTooLargeExceptionBadDocumentExceptionAccessDeniedExceptionProvisionedThroughputExceededExceptionInternalServerErrorExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Textract indicating either a problem with the data in the
request, or a server side issue.public Future<DetectDocumentTextResult> detectDocumentTextAsync(DetectDocumentTextRequest detectDocumentTextRequest) throws AmazonServiceException, AmazonClientException
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.
Each document page has as an associated Block of type PAGE.
Each PAGE Block object is the parent of LINE
Block objects that represent the lines of detected text on a
page. A LINE Block object is a parent for each word that
makes up the line. Words are represented by Block objects of
type WORD.
DetectDocumentText is a synchronous operation. To analyze
documents asynchronously, use StartDocumentTextDetection.
For more information, see Document Text Detection.
detectDocumentTextAsync in interface AmazonTextractAsyncdetectDocumentTextRequest - InvalidParameterExceptionInvalidS3ObjectExceptionUnsupportedDocumentExceptionDocumentTooLargeExceptionBadDocumentExceptionAccessDeniedExceptionProvisionedThroughputExceededExceptionInternalServerErrorExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Textract indicating either a problem with the data in the
request, or a server side issue.public Future<DetectDocumentTextResult> detectDocumentTextAsync(DetectDocumentTextRequest detectDocumentTextRequest, AsyncHandler<DetectDocumentTextRequest,DetectDocumentTextResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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.
Each document page has as an associated Block of type PAGE.
Each PAGE Block object is the parent of LINE
Block objects that represent the lines of detected text on a
page. A LINE Block object is a parent for each word that
makes up the line. Words are represented by Block objects of
type WORD.
DetectDocumentText is a synchronous operation. To analyze
documents asynchronously, use StartDocumentTextDetection.
For more information, see Document Text Detection.
detectDocumentTextAsync in interface AmazonTextractAsyncdetectDocumentTextRequest - asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the
implementation of the four callback methods in this interface
to process the operation result or handle the exception.InvalidParameterExceptionInvalidS3ObjectExceptionUnsupportedDocumentExceptionDocumentTooLargeExceptionBadDocumentExceptionAccessDeniedExceptionProvisionedThroughputExceededExceptionInternalServerErrorExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Textract indicating either a problem with the data in the
request, or a server side issue.public Future<GetDocumentAnalysisResult> getDocumentAnalysisAsync(GetDocumentAnalysisRequest getDocumentAnalysisRequest) throws AmazonServiceException, AmazonClientException
Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.
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. The following 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 each of type
KEY_VALUE_SET: 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 object contains information about a detected table. A CELL Block object is returned for each cell in a table.
Selectable elements such as checkboxes and radio buttons. A SELECTION_ELEMENT Block object contains information about a selectable element.
Lines and words of text. A LINE Block object contains one or more WORD Block objects.
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.
For more information, see Document Text Analysis.
getDocumentAnalysisAsync in interface AmazonTextractAsyncgetDocumentAnalysisRequest - InvalidParameterExceptionAccessDeniedExceptionProvisionedThroughputExceededExceptionInvalidJobIdExceptionInternalServerErrorExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Textract indicating either a problem with the data in the
request, or a server side issue.public Future<GetDocumentAnalysisResult> getDocumentAnalysisAsync(GetDocumentAnalysisRequest getDocumentAnalysisRequest, AsyncHandler<GetDocumentAnalysisRequest,GetDocumentAnalysisResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.
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. The following 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 each of type
KEY_VALUE_SET: 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 object contains information about a detected table. A CELL Block object is returned for each cell in a table.
Selectable elements such as checkboxes and radio buttons. A SELECTION_ELEMENT Block object contains information about a selectable element.
Lines and words of text. A LINE Block object contains one or more WORD Block objects.
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.
For more information, see Document Text Analysis.
getDocumentAnalysisAsync in interface AmazonTextractAsyncgetDocumentAnalysisRequest - asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the
implementation of the four callback methods in this interface
to process the operation result or handle the exception.InvalidParameterExceptionAccessDeniedExceptionProvisionedThroughputExceededExceptionInvalidJobIdExceptionInternalServerErrorExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Textract indicating either a problem with the data in the
request, or a server side issue.public Future<GetDocumentTextDetectionResult> getDocumentTextDetectionAsync(GetDocumentTextDetectionRequest getDocumentTextDetectionRequest) throws AmazonServiceException, AmazonClientException
Gets the results for an Amazon Textract asynchronous operation that detects text in a document. 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.
Each document page has as an associated Block of type PAGE.
Each PAGE Block object is the parent of LINE
Block objects that represent the lines of detected text on a
page. A LINE Block object is a parent for each word that
makes up the line. Words are represented by Block objects of
type WORD.
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.
getDocumentTextDetectionAsync in interface AmazonTextractAsyncgetDocumentTextDetectionRequest - InvalidParameterExceptionAccessDeniedExceptionProvisionedThroughputExceededExceptionInvalidJobIdExceptionInternalServerErrorExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Textract indicating either a problem with the data in the
request, or a server side issue.public Future<GetDocumentTextDetectionResult> getDocumentTextDetectionAsync(GetDocumentTextDetectionRequest getDocumentTextDetectionRequest, AsyncHandler<GetDocumentTextDetectionRequest,GetDocumentTextDetectionResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Gets the results for an Amazon Textract asynchronous operation that detects text in a document. 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.
Each document page has as an associated Block of type PAGE.
Each PAGE Block object is the parent of LINE
Block objects that represent the lines of detected text on a
page. A LINE Block object is a parent for each word that
makes up the line. Words are represented by Block objects of
type WORD.
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.
getDocumentTextDetectionAsync in interface AmazonTextractAsyncgetDocumentTextDetectionRequest - asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the
implementation of the four callback methods in this interface
to process the operation result or handle the exception.InvalidParameterExceptionAccessDeniedExceptionProvisionedThroughputExceededExceptionInvalidJobIdExceptionInternalServerErrorExceptionThrottlingExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Textract indicating either a problem with the data in the
request, or a server side issue.public Future<StartDocumentAnalysisResult> startDocumentAnalysisAsync(StartDocumentAnalysisRequest startDocumentAnalysisRequest) throws AmazonServiceException, AmazonClientException
Starts asynchronous analysis of an input document for relationships between detected items such as key and value pairs, tables, and selection elements.
StartDocumentAnalysis can analyze text in documents that are
in JPG, PNG, 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.
startDocumentAnalysisAsync in interface AmazonTextractAsyncstartDocumentAnalysisRequest - InvalidParameterExceptionInvalidS3ObjectExceptionUnsupportedDocumentExceptionDocumentTooLargeExceptionBadDocumentExceptionAccessDeniedExceptionProvisionedThroughputExceededExceptionInternalServerErrorExceptionIdempotentParameterMismatchExceptionThrottlingExceptionLimitExceededExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Textract indicating either a problem with the data in the
request, or a server side issue.public Future<StartDocumentAnalysisResult> startDocumentAnalysisAsync(StartDocumentAnalysisRequest startDocumentAnalysisRequest, AsyncHandler<StartDocumentAnalysisRequest,StartDocumentAnalysisResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Starts asynchronous analysis of an input document for relationships between detected items such as key and value pairs, tables, and selection elements.
StartDocumentAnalysis can analyze text in documents that are
in JPG, PNG, 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.
startDocumentAnalysisAsync in interface AmazonTextractAsyncstartDocumentAnalysisRequest - asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the
implementation of the four callback methods in this interface
to process the operation result or handle the exception.InvalidParameterExceptionInvalidS3ObjectExceptionUnsupportedDocumentExceptionDocumentTooLargeExceptionBadDocumentExceptionAccessDeniedExceptionProvisionedThroughputExceededExceptionInternalServerErrorExceptionIdempotentParameterMismatchExceptionThrottlingExceptionLimitExceededExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Textract indicating either a problem with the data in the
request, or a server side issue.public Future<StartDocumentTextDetectionResult> startDocumentTextDetectionAsync(StartDocumentTextDetectionRequest startDocumentTextDetectionRequest) throws AmazonServiceException, AmazonClientException
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 JPG, PNG, 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.
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.
startDocumentTextDetectionAsync in interface AmazonTextractAsyncstartDocumentTextDetectionRequest - InvalidParameterExceptionInvalidS3ObjectExceptionUnsupportedDocumentExceptionDocumentTooLargeExceptionBadDocumentExceptionAccessDeniedExceptionProvisionedThroughputExceededExceptionInternalServerErrorExceptionIdempotentParameterMismatchExceptionThrottlingExceptionLimitExceededExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Textract indicating either a problem with the data in the
request, or a server side issue.public Future<StartDocumentTextDetectionResult> startDocumentTextDetectionAsync(StartDocumentTextDetectionRequest startDocumentTextDetectionRequest, AsyncHandler<StartDocumentTextDetectionRequest,StartDocumentTextDetectionResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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 JPG, PNG, 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.
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.
startDocumentTextDetectionAsync in interface AmazonTextractAsyncstartDocumentTextDetectionRequest - asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the
implementation of the four callback methods in this interface
to process the operation result or handle the exception.InvalidParameterExceptionInvalidS3ObjectExceptionUnsupportedDocumentExceptionDocumentTooLargeExceptionBadDocumentExceptionAccessDeniedExceptionProvisionedThroughputExceededExceptionInternalServerErrorExceptionIdempotentParameterMismatchExceptionThrottlingExceptionLimitExceededExceptionAmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException - If an error response is returned by Amazon
Textract indicating either a problem with the data in the
request, or a server side issue.Copyright © 2019. All rights reserved.