com.amazonaws.services.textract

Class AmazonTextractAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.textract.AmazonTextractClient

com.amazonaws.services.textract.AmazonTextractAsyncClient

All Implemented Interfaces:

AmazonTextract, AmazonTextractAsync

public class AmazonTextractAsyncClient
extends AmazonTextractClient
implements AmazonTextractAsync

Interface for accessing Amazon Textract asynchronously.

Amazon Textract detects and analyzes text in documents and converts it into machine-readable text. This is the API reference documentation for Amazon Textract.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Constructor Summary

Constructors

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, java.util.concurrent.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, java.util.concurrent.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, java.util.concurrent.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, java.util.concurrent.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.

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.Future<AnalyzeDocumentResult>	analyzeDocumentAsync(AnalyzeDocumentRequest analyzeDocumentRequest) Analyzes an input document for relationships between detected items.
java.util.concurrent.Future<AnalyzeDocumentResult>	analyzeDocumentAsync(AnalyzeDocumentRequest analyzeDocumentRequest, AsyncHandler<AnalyzeDocumentRequest,AnalyzeDocumentResult> asyncHandler) Analyzes an input document for relationships between detected items.
java.util.concurrent.Future<DetectDocumentTextResult>	detectDocumentTextAsync(DetectDocumentTextRequest detectDocumentTextRequest) Detects text in the input document.
java.util.concurrent.Future<DetectDocumentTextResult>	detectDocumentTextAsync(DetectDocumentTextRequest detectDocumentTextRequest, AsyncHandler<DetectDocumentTextRequest,DetectDocumentTextResult> asyncHandler) Detects text in the input document.
java.util.concurrent.Future<GetDocumentAnalysisResult>	getDocumentAnalysisAsync(GetDocumentAnalysisRequest getDocumentAnalysisRequest) Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.
java.util.concurrent.Future<GetDocumentAnalysisResult>	getDocumentAnalysisAsync(GetDocumentAnalysisRequest getDocumentAnalysisRequest, AsyncHandler<GetDocumentAnalysisRequest,GetDocumentAnalysisResult> asyncHandler) Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.
java.util.concurrent.Future<GetDocumentTextDetectionResult>	getDocumentTextDetectionAsync(GetDocumentTextDetectionRequest getDocumentTextDetectionRequest) Gets the results for an Amazon Textract asynchronous operation that detects text in a document.
java.util.concurrent.Future<GetDocumentTextDetectionResult>	getDocumentTextDetectionAsync(GetDocumentTextDetectionRequest getDocumentTextDetectionRequest, AsyncHandler<GetDocumentTextDetectionRequest,GetDocumentTextDetectionResult> asyncHandler) Gets the results for an Amazon Textract asynchronous operation that detects text in a document.
java.util.concurrent.ExecutorService	getExecutorService() Returns the executor service used by this async client to execute requests.
void	shutdown() Shuts down the client, releasing all managed resources.
java.util.concurrent.Future<StartDocumentAnalysisResult>	startDocumentAnalysisAsync(StartDocumentAnalysisRequest startDocumentAnalysisRequest) Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.
java.util.concurrent.Future<StartDocumentAnalysisResult>	startDocumentAnalysisAsync(StartDocumentAnalysisRequest startDocumentAnalysisRequest, AsyncHandler<StartDocumentAnalysisRequest,StartDocumentAnalysisResult> asyncHandler) Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.
java.util.concurrent.Future<StartDocumentTextDetectionResult>	startDocumentTextDetectionAsync(StartDocumentTextDetectionRequest startDocumentTextDetectionRequest) Starts the asynchronous detection of text in a document.
java.util.concurrent.Future<StartDocumentTextDetectionResult>	startDocumentTextDetectionAsync(StartDocumentTextDetectionRequest startDocumentTextDetectionRequest, AsyncHandler<StartDocumentTextDetectionRequest,StartDocumentTextDetectionResult> asyncHandler) Starts the asynchronous detection of text in a document.

Methods inherited from class com.amazonaws.services.textract.AmazonTextractClient

analyzeDocument, detectDocumentText, getCachedResponseMetadata, getDocumentAnalysis, getDocumentTextDetection, startDocumentAnalysis, startDocumentTextDetection

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, getEndpoint, getEndpointPrefix, getRegions, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.textract.AmazonTextract

analyzeDocument, detectDocumentText, getCachedResponseMetadata, getDocumentAnalysis, getDocumentTextDetection, setEndpoint, setRegion, startDocumentAnalysis, startDocumentTextDetection

Constructor Detail

AmazonTextractAsyncClient

@Deprecated
public AmazonTextractAsyncClient()

Deprecated.

Constructs a new asynchronous client to invoke service methods on Amazon Textract. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AmazonTextractAsyncClient

@Deprecated
public AmazonTextractAsyncClient(ClientConfiguration clientConfiguration)

Deprecated.

Constructs a new asynchronous client to invoke service methods on Amazon Textract. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to Amazon Textract (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonTextractAsyncClient

public AmazonTextractAsyncClient(AWSCredentials awsCredentials)

Constructs a new asynchronous client to invoke service methods on Amazon Textract using the specified AWS account credentials. Default client settings will be used, and a fixed size thread pool will be created for executing the asynchronous tasks.

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.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonTextractAsyncClient

public AmazonTextractAsyncClient(AWSCredentials awsCredentials,
                                 java.util.concurrent.ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on Amazon Textract using the specified AWS account credentials and executor service. Default client settings will be used.

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.

Parameters:

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.

AmazonTextractAsyncClient

public AmazonTextractAsyncClient(AWSCredentials awsCredentials,
                                 ClientConfiguration clientConfiguration,
                                 java.util.concurrent.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.

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.

Parameters:

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.

AmazonTextractAsyncClient

public AmazonTextractAsyncClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new asynchronous client to invoke service methods on Amazon Textract using the specified AWS account credentials provider. Default client settings will be used, and a fixed size thread pool will be created for executing the asynchronous tasks.

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.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonTextractAsyncClient

public AmazonTextractAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                 java.util.concurrent.ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on Amazon Textract using the specified AWS account credentials provider and executor service. Default client settings will be used.

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.

Parameters:

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.

AmazonTextractAsyncClient

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

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.

Parameters:

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

AmazonTextractAsyncClient

public AmazonTextractAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                 ClientConfiguration clientConfiguration,
                                 java.util.concurrent.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.

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.

Parameters:

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.

Method Detail

getExecutorService

public java.util.concurrent.ExecutorService getExecutorService()

Returns the executor service used by this async client to execute requests.

Returns:

The executor service used by this async client to execute requests.

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AmazonTextract

Overrides:

shutdown in class AmazonWebServiceClient

analyzeDocumentAsync

public java.util.concurrent.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:

• Form data (key-value pairs). 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.

• Lines and words of text. A LINE Block object contains one or more WORD Block objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of FeatureTypes).

Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block object contains information about a selection element, including the selection status.

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.

Specified by:

analyzeDocumentAsync in interface AmazonTextractAsync

Parameters:

analyzeDocumentRequest -

Returns:

A Java Future object containing the response from the AnalyzeDocument service method, as returned by Amazon Textract.

Throws:

InvalidParameterException

InvalidS3ObjectException

UnsupportedDocumentException

DocumentTooLargeException

BadDocumentException

AccessDeniedException

ProvisionedThroughputExceededException

InternalServerErrorException

ThrottlingException

HumanLoopQuotaExceededException

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

analyzeDocumentAsync

public java.util.concurrent.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:

• Form data (key-value pairs). 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.

• Lines and words of text. A LINE Block object contains one or more WORD Block objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of FeatureTypes).

Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block object contains information about a selection element, including the selection status.

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.

Specified by:

analyzeDocumentAsync in interface AmazonTextractAsync

Parameters:

analyzeDocumentRequest -

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.

Returns:

A Java Future object containing the response from the AnalyzeDocument service method, as returned by Amazon Textract.

Throws:

InvalidParameterException

InvalidS3ObjectException

UnsupportedDocumentException

DocumentTooLargeException

BadDocumentException

AccessDeniedException

ProvisionedThroughputExceededException

InternalServerErrorException

ThrottlingException

HumanLoopQuotaExceededException

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

detectDocumentTextAsync

public java.util.concurrent.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 JPEG 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.

Specified by:

detectDocumentTextAsync in interface AmazonTextractAsync

Parameters:

detectDocumentTextRequest -

Returns:

A Java Future object containing the response from the DetectDocumentText service method, as returned by Amazon Textract.

Throws:

InvalidParameterException

InvalidS3ObjectException

UnsupportedDocumentException

DocumentTooLargeException

BadDocumentException

AccessDeniedException

ProvisionedThroughputExceededException

InternalServerErrorException

ThrottlingException

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

detectDocumentTextAsync

public java.util.concurrent.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 JPEG 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.

Specified by:

detectDocumentTextAsync in interface AmazonTextractAsync

Parameters:

detectDocumentTextRequest -

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.

Returns:

A Java Future object containing the response from the DetectDocumentText service method, as returned by Amazon Textract.

Throws:

InvalidParameterException

InvalidS3ObjectException

UnsupportedDocumentException

DocumentTooLargeException

BadDocumentException

AccessDeniedException

ProvisionedThroughputExceededException

InternalServerErrorException

ThrottlingException

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

getDocumentAnalysisAsync

public java.util.concurrent.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:

• Form data (key-value pairs). 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.

• Lines and words of text. A LINE Block object contains one or more WORD Block objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of the StartDocumentAnalysis FeatureTypes input parameter).

Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block object contains information about a selection element, including the selection status.

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

Specified by:

getDocumentAnalysisAsync in interface AmazonTextractAsync

Parameters:

getDocumentAnalysisRequest -

Returns:

A Java Future object containing the response from the GetDocumentAnalysis service method, as returned by Amazon Textract.

Throws:

InvalidParameterException

AccessDeniedException

ProvisionedThroughputExceededException

InvalidJobIdException

InternalServerErrorException

ThrottlingException

InvalidS3ObjectException

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

getDocumentAnalysisAsync

public java.util.concurrent.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:

• Form data (key-value pairs). 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.

• Lines and words of text. A LINE Block object contains one or more WORD Block objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of the StartDocumentAnalysis FeatureTypes input parameter).

Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block object contains information about a selection element, including the selection status.

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

Specified by:

getDocumentAnalysisAsync in interface AmazonTextractAsync

Parameters:

getDocumentAnalysisRequest -

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.

Returns:

A Java Future object containing the response from the GetDocumentAnalysis service method, as returned by Amazon Textract.

Throws:

InvalidParameterException

AccessDeniedException

ProvisionedThroughputExceededException

InvalidJobIdException

InternalServerErrorException

ThrottlingException

InvalidS3ObjectException

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

getDocumentTextDetectionAsync

public java.util.concurrent.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.

Specified by:

getDocumentTextDetectionAsync in interface AmazonTextractAsync

Parameters:

getDocumentTextDetectionRequest -

Returns:

A Java Future object containing the response from the GetDocumentTextDetection service method, as returned by Amazon Textract.

Throws:

InvalidParameterException

AccessDeniedException

ProvisionedThroughputExceededException

InvalidJobIdException

InternalServerErrorException

ThrottlingException

InvalidS3ObjectException

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

getDocumentTextDetectionAsync

public java.util.concurrent.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.

Specified by:

getDocumentTextDetectionAsync in interface AmazonTextractAsync

Parameters:

getDocumentTextDetectionRequest -

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.

Returns:

A Java Future object containing the response from the GetDocumentTextDetection service method, as returned by Amazon Textract.

Throws:

InvalidParameterException

AccessDeniedException

ProvisionedThroughputExceededException

InvalidJobIdException

InternalServerErrorException

ThrottlingException

InvalidS3ObjectException

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

startDocumentAnalysisAsync

public java.util.concurrent.Future<StartDocumentAnalysisResult> startDocumentAnalysisAsync(StartDocumentAnalysisRequest startDocumentAnalysisRequest)
                                                                                    throws AmazonServiceException,
                                                                                           AmazonClientException

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

Specified by:

startDocumentAnalysisAsync in interface AmazonTextractAsync

Parameters:

startDocumentAnalysisRequest -

Returns:

A Java Future object containing the response from the StartDocumentAnalysis service method, as returned by Amazon Textract.

Throws:

InvalidParameterException

InvalidS3ObjectException

InvalidKMSKeyException

UnsupportedDocumentException

DocumentTooLargeException

BadDocumentException

AccessDeniedException

ProvisionedThroughputExceededException

InternalServerErrorException

IdempotentParameterMismatchException

ThrottlingException

LimitExceededException

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

startDocumentAnalysisAsync

public java.util.concurrent.Future<StartDocumentAnalysisResult> startDocumentAnalysisAsync(StartDocumentAnalysisRequest startDocumentAnalysisRequest,
                                                                                           AsyncHandler<StartDocumentAnalysisRequest,StartDocumentAnalysisResult> asyncHandler)
                                                                                    throws AmazonServiceException,
                                                                                           AmazonClientException

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

Specified by:

startDocumentAnalysisAsync in interface AmazonTextractAsync

Parameters:

startDocumentAnalysisRequest -

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.

Returns:

A Java Future object containing the response from the StartDocumentAnalysis service method, as returned by Amazon Textract.

Throws:

InvalidParameterException

InvalidS3ObjectException

InvalidKMSKeyException

UnsupportedDocumentException

DocumentTooLargeException

BadDocumentException

AccessDeniedException

ProvisionedThroughputExceededException

InternalServerErrorException

IdempotentParameterMismatchException

ThrottlingException

LimitExceededException

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

startDocumentTextDetectionAsync

public java.util.concurrent.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 JPEG, 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.

Specified by:

startDocumentTextDetectionAsync in interface AmazonTextractAsync

Parameters:

startDocumentTextDetectionRequest -

Returns:

A Java Future object containing the response from the StartDocumentTextDetection service method, as returned by Amazon Textract.

Throws:

InvalidParameterException

InvalidS3ObjectException

InvalidKMSKeyException

UnsupportedDocumentException

DocumentTooLargeException

BadDocumentException

AccessDeniedException

ProvisionedThroughputExceededException

InternalServerErrorException

IdempotentParameterMismatchException

ThrottlingException

LimitExceededException

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

startDocumentTextDetectionAsync

public java.util.concurrent.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 JPEG, 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.

Specified by:

startDocumentTextDetectionAsync in interface AmazonTextractAsync

Parameters:

startDocumentTextDetectionRequest -

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.

Returns:

A Java Future object containing the response from the StartDocumentTextDetection service method, as returned by Amazon Textract.

Throws:

InvalidParameterException

InvalidS3ObjectException

InvalidKMSKeyException

UnsupportedDocumentException

DocumentTooLargeException

BadDocumentException

AccessDeniedException

ProvisionedThroughputExceededException

InternalServerErrorException

IdempotentParameterMismatchException

ThrottlingException

LimitExceededException

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