com.amazonaws.services.textract

Class AmazonTextractClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.textract.AmazonTextractClient

All Implemented Interfaces:

AmazonTextract

Direct Known Subclasses:

AmazonTextractAsyncClient

public class AmazonTextractClient
extends AmazonWebServiceClient
implements AmazonTextract

Client for accessing Amazon Textract. All service calls made using this client are blocking, and will not return until the service call 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.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Constructor Summary

Constructors

Constructor and Description
AmazonTextractClient() Deprecated.
AmazonTextractClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AmazonTextract using the specified AWS account credentials.
AmazonTextractClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonTextract using the specified AWS account credentials and client configuration options.
AmazonTextractClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AmazonTextract using the specified AWS account credentials provider.
AmazonTextractClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonTextract using the specified AWS account credentials provider and client configuration options.
AmazonTextractClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, HttpClient httpClient) Constructs a new client to invoke service methods on AmazonTextract using the specified AWS account credentials provider, client configuration options and request metric collector.
AmazonTextractClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, com.amazonaws.metrics.RequestMetricCollector requestMetricCollector) Deprecated.
AmazonTextractClient(ClientConfiguration clientConfiguration) Deprecated.

Method Summary

Modifier and Type	Method and Description
AnalyzeDocumentResult	analyzeDocument(AnalyzeDocumentRequest analyzeDocumentRequest) Analyzes an input document for relationships between detected items.
DetectDocumentTextResult	detectDocumentText(DetectDocumentTextRequest detectDocumentTextRequest) Detects text in the input document.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.
GetDocumentAnalysisResult	getDocumentAnalysis(GetDocumentAnalysisRequest getDocumentAnalysisRequest) Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.
GetDocumentTextDetectionResult	getDocumentTextDetection(GetDocumentTextDetectionRequest getDocumentTextDetectionRequest) Gets the results for an Amazon Textract asynchronous operation that detects text in a document.
StartDocumentAnalysisResult	startDocumentAnalysis(StartDocumentAnalysisRequest startDocumentAnalysisRequest) Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.
StartDocumentTextDetectionResult	startDocumentTextDetection(StartDocumentTextDetectionRequest startDocumentTextDetectionRequest) Starts the asynchronous detection of text in a document.

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

setEndpoint, setRegion, shutdown

Constructor Detail

AmazonTextractClient

@Deprecated
public AmazonTextractClient()

Deprecated.

Constructs a new client to invoke service methods on AmazonTextract. 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

AmazonTextractClient

@Deprecated
public AmazonTextractClient(ClientConfiguration clientConfiguration)

Deprecated.

Constructs a new client to invoke service methods on AmazonTextract. 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 AmazonTextract (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonTextractClient

public AmazonTextractClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AmazonTextract using the specified AWS account credentials.

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonTextractClient client = new AmazonTextractClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

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

Parameters:

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

AmazonTextractClient

public AmazonTextractClient(AWSCredentials awsCredentials,
                            ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonTextract using the specified AWS account credentials and client configuration options.

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonTextractClient client = new AmazonTextractClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

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

Parameters:

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

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

AmazonTextractClient

public AmazonTextractClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AmazonTextract using the specified AWS account credentials provider.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonTextractClient client = new AmazonTextractClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

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

Parameters:

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

AmazonTextractClient

public AmazonTextractClient(AWSCredentialsProvider awsCredentialsProvider,
                            ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonTextract using the specified AWS account credentials provider and client configuration options.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonTextractClient client = new AmazonTextractClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

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

Parameters:

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

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

AmazonTextractClient

@Deprecated
public AmazonTextractClient(AWSCredentialsProvider awsCredentialsProvider,
                                        ClientConfiguration clientConfiguration,
                                        com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)

Deprecated.

Constructs a new client to invoke service methods on AmazonTextract using the specified AWS account credentials provider, client configuration options and request metric collector.

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

Parameters:

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

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

requestMetricCollector - optional request metric collector

AmazonTextractClient

public AmazonTextractClient(AWSCredentialsProvider awsCredentialsProvider,
                            ClientConfiguration clientConfiguration,
                            HttpClient httpClient)

Constructs a new client to invoke service methods on AmazonTextract using the specified AWS account credentials provider, client configuration options and request metric collector.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonTextractClient client = new AmazonTextractClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

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

Parameters:

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

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

httpClient - A http client

Method Detail

analyzeDocument

public AnalyzeDocumentResult analyzeDocument(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:

analyzeDocument in interface AmazonTextract

Parameters:

analyzeDocumentRequest -

Returns:

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

detectDocumentText

public DetectDocumentTextResult detectDocumentText(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:

detectDocumentText in interface AmazonTextract

Parameters:

detectDocumentTextRequest -

Returns:

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

getDocumentAnalysis

public GetDocumentAnalysisResult getDocumentAnalysis(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:

getDocumentAnalysis in interface AmazonTextract

Parameters:

getDocumentAnalysisRequest -

Returns:

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

getDocumentTextDetection

public GetDocumentTextDetectionResult getDocumentTextDetection(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:

getDocumentTextDetection in interface AmazonTextract

Parameters:

getDocumentTextDetectionRequest -

Returns:

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

startDocumentAnalysis

public StartDocumentAnalysisResult startDocumentAnalysis(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:

startDocumentAnalysis in interface AmazonTextract

Parameters:

startDocumentAnalysisRequest -

Returns:

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

startDocumentTextDetection

public StartDocumentTextDetectionResult startDocumentTextDetection(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:

startDocumentTextDetection in interface AmazonTextract

Parameters:

startDocumentTextDetectionRequest -

Returns:

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

getCachedResponseMetadata

@Deprecated
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonTextract

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.