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

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
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

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
AnalyzeDocumentResult	analyzeDocument(AnalyzeDocumentRequest request) Analyzes an input document for relationships in the detected text and tables.
static AmazonTextractClientBuilder	builder()
DetectDocumentTextResult	detectDocumentText(DetectDocumentTextRequest request) Detects text in the input document.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetDocumentAnalysisResult	getDocumentAnalysis(GetDocumentAnalysisRequest request) Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document image.
GetDocumentTextDetectionResult	getDocumentTextDetection(GetDocumentTextDetectionRequest request) Gets the results for an Amazon Textract asynchronous operation that detects text in a document image.
StartDocumentAnalysisResult	startDocumentAnalysis(StartDocumentAnalysisRequest request) Starts asynchronous analysis of text for relationships in the text and tables that are detected in a document.
StartDocumentTextDetectionResult	startDocumentTextDetection(StartDocumentTextDetectionRequest request) Starts the asynchronous detection of text in a document.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, 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

shutdown

Method Detail

builder

public static AmazonTextractClientBuilder builder()

analyzeDocument

public AnalyzeDocumentResult analyzeDocument(AnalyzeDocumentRequest request)

Analyzes an input document for relationships in the detected text and tables.

Two types of information are returned:

• Words and lines that are related to nearby lines and words. The related information is returned in two Block objects: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.

• Table and table cell data. A TABLE Block contains information about a detected table. A CELL block is returned for each cell in a table.

You can choose which type of analysis to perform by specifying the FeatureTypes list.

The output is returned in a list of BLOCK objects (Blocks). For more information, see how-it-works-analyzing.

AnalyzeDocument is a synchronous operation. To analyze documents asynchronously, use StartDocumentAnalysis.

Specified by:

analyzeDocument in interface AmazonTextract

Parameters:

analyzeDocumentRequest -

Returns:

Result of the AnalyzeDocument operation returned by the service.

Throws:

InvalidParameterException - An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

InvalidS3ObjectException - Amazon Textract is unable to access the S3 object that's specified in the request.

UnsupportedDocumentException - The format of the input document isn't supported. Amazon Textract supports documents that are .png or .jpg format.

DocumentTooLargeException - The document can't be processed because it's too large. The maximum document size for synchronous operations 5 MB. The maximum document size for asynchronous operations is 500 MB for PDF format files.

BadDocumentException - Amazon Textract isn't able to read the document.

AccessDeniedException - You aren't authorized to perform the action.

ProvisionedThroughputExceededException - The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InternalServerErrorException - Amazon Textract experienced a service issue. Try your call again.

ThrottlingException - Amazon Textract is temporarily unable to process the request. Try your call again.

See Also:

AWS API Documentation

detectDocumentText

public DetectDocumentTextResult detectDocumentText(DetectDocumentTextRequest request)

Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of text. The input document must be an image in JPG or PNG format. DetectDocumentText returns the detected text in an array of Block objects. For more information, see how-it-works-detecting.

DetectDocumentText is a synchronous operation. To analyze documents asynchronously, use StartDocumentTextDetection.

Specified by:

detectDocumentText in interface AmazonTextract

Parameters:

detectDocumentTextRequest -

Returns:

Result of the DetectDocumentText operation returned by the service.

Throws:

InvalidParameterException - An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

InvalidS3ObjectException - Amazon Textract is unable to access the S3 object that's specified in the request.

UnsupportedDocumentException - The format of the input document isn't supported. Amazon Textract supports documents that are .png or .jpg format.

DocumentTooLargeException - The document can't be processed because it's too large. The maximum document size for synchronous operations 5 MB. The maximum document size for asynchronous operations is 500 MB for PDF format files.

BadDocumentException - Amazon Textract isn't able to read the document.

AccessDeniedException - You aren't authorized to perform the action.

ProvisionedThroughputExceededException - The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InternalServerErrorException - Amazon Textract experienced a service issue. Try your call again.

ThrottlingException - Amazon Textract is temporarily unable to process the request. Try your call again.

See Also:

AWS API Documentation

getDocumentAnalysis

public GetDocumentAnalysisResult getDocumentAnalysis(GetDocumentAnalysisRequest request)

Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document image.

You start asynchronous text analysis by calling StartDocumentAnalysis, which returns a job identifier ( JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartDocumentAnalysis. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis.

GetDocumentAnalysis returns an array of Block objects. For more information, see how-it-works-analyzing.

Use the MaxResults parameter to limit the number of blocks returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetDocumentAnalysis, and populate the NextToken request parameter with the token value that's returned from the previous call to GetDocumentAnalysis.

Specified by:

getDocumentAnalysis in interface AmazonTextract

Parameters:

getDocumentAnalysisRequest -

Returns:

Result of the GetDocumentAnalysis operation returned by the service.

Throws:

InvalidParameterException - An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

AccessDeniedException - You aren't authorized to perform the action.

ProvisionedThroughputExceededException - The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InvalidJobIdException - An invalid job identifier was passed to GetDocumentAnalysis or to GetDocumentAnalysis.

InternalServerErrorException - Amazon Textract experienced a service issue. Try your call again.

ThrottlingException - Amazon Textract is temporarily unable to process the request. Try your call again.

See Also:

AWS API Documentation

getDocumentTextDetection

public GetDocumentTextDetectionResult getDocumentTextDetection(GetDocumentTextDetectionRequest request)

Gets the results for an Amazon Textract asynchronous operation that detects text in a document image. Amazon Textract can detect lines of text and the words that make up a line of text.

You start asynchronous text detection by calling StartDocumentTextDetection, which returns a job identifier (JobId). When the text detection operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartDocumentTextDetection. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job identifier (JobId) from the initial call to StartDocumentTextDetection.

GetDocumentTextDetection returns an array of Block objects. For more information, see how-it-works-detecting.

Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetDocumentTextDetection, and populate the NextToken request parameter with the token value that's returned from the previous call to GetDocumentTextDetection.

For more information, see Document Text Detection in the Amazon Textract Developer Guide.

Specified by:

getDocumentTextDetection in interface AmazonTextract

Parameters:

getDocumentTextDetectionRequest -

Returns:

Result of the GetDocumentTextDetection operation returned by the service.

Throws:

InvalidParameterException - An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

AccessDeniedException - You aren't authorized to perform the action.

ProvisionedThroughputExceededException - The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InvalidJobIdException - An invalid job identifier was passed to GetDocumentAnalysis or to GetDocumentAnalysis.

InternalServerErrorException - Amazon Textract experienced a service issue. Try your call again.

ThrottlingException - Amazon Textract is temporarily unable to process the request. Try your call again.

See Also:

AWS API Documentation

startDocumentAnalysis

public StartDocumentAnalysisResult startDocumentAnalysis(StartDocumentAnalysisRequest request)

Starts asynchronous analysis of text for relationships in the text and tables that are detected in a document. Amazon Textract returns for two types of information:

• Words and lines that are related to nearby lines and words. The related information is returned in two Block objects: A KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.

• Table and table cell data. A TABLE block contains information about a detected table. A CELL block is returned for each cell in a table.

Amazon Textract can analyze text in document images and PDF files that are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document image.

StartDocumentAnalysis returns a job identifier (JobId) that you use to get the results of the operation. When text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis.

Specified by:

startDocumentAnalysis in interface AmazonTextract

Parameters:

startDocumentAnalysisRequest -

Returns:

Result of the StartDocumentAnalysis operation returned by the service.

Throws:

InvalidParameterException - An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

InvalidS3ObjectException - Amazon Textract is unable to access the S3 object that's specified in the request.

UnsupportedDocumentException - The format of the input document isn't supported. Amazon Textract supports documents that are .png or .jpg format.

DocumentTooLargeException - The document can't be processed because it's too large. The maximum document size for synchronous operations 5 MB. The maximum document size for asynchronous operations is 500 MB for PDF format files.

BadDocumentException - Amazon Textract isn't able to read the document.

AccessDeniedException - You aren't authorized to perform the action.

ProvisionedThroughputExceededException - The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InternalServerErrorException - Amazon Textract experienced a service issue. Try your call again.

IdempotentParameterMismatchException - A ClientRequestToken input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

ThrottlingException - Amazon Textract is temporarily unable to process the request. Try your call again.

LimitExceededException - An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (StartDocumentTextDetection, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit.

See Also:

AWS API Documentation

startDocumentTextDetection

public StartDocumentTextDetectionResult startDocumentTextDetection(StartDocumentTextDetectionRequest request)

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.

Amazon Textract can detect text in document images and PDF files that are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and the file name of the document image.

StartTextDetection returns a job identifier (JobId) that you use to get the results of the operation. When text detection is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job identifier ( JobId) from the initial call to StartDocumentTextDetection.

For more information, see Document Text Detection in the Amazon Textract Developer Guide.

Specified by:

startDocumentTextDetection in interface AmazonTextract

Parameters:

startDocumentTextDetectionRequest -

Returns:

Result of the StartDocumentTextDetection operation returned by the service.

Throws:

InvalidParameterException - An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

InvalidS3ObjectException - Amazon Textract is unable to access the S3 object that's specified in the request.

UnsupportedDocumentException - The format of the input document isn't supported. Amazon Textract supports documents that are .png or .jpg format.

DocumentTooLargeException - The document can't be processed because it's too large. The maximum document size for synchronous operations 5 MB. The maximum document size for asynchronous operations is 500 MB for PDF format files.

BadDocumentException - Amazon Textract isn't able to read the document.

AccessDeniedException - You aren't authorized to perform the action.

ProvisionedThroughputExceededException - The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

InternalServerErrorException - Amazon Textract experienced a service issue. Try your call again.

IdempotentParameterMismatchException - A ClientRequestToken input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

ThrottlingException - Amazon Textract is temporarily unable to process the request. Try your call again.

LimitExceededException - An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (StartDocumentTextDetection, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

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.