Interface TextractClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface TextractClient
extends AwsClient

Service client for accessing Amazon Textract. This can be created using the static builder() method.

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

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default AnalyzeDocumentResponse	analyzeDocument(Consumer<AnalyzeDocumentRequest.Builder> analyzeDocumentRequest)	Analyzes an input document for relationships between detected items.
default AnalyzeDocumentResponse	analyzeDocument(AnalyzeDocumentRequest analyzeDocumentRequest)	Analyzes an input document for relationships between detected items.
default AnalyzeExpenseResponse	analyzeExpense(Consumer<AnalyzeExpenseRequest.Builder> analyzeExpenseRequest)	AnalyzeExpense synchronously analyzes an input document for financially related relationships between text.
default AnalyzeExpenseResponse	analyzeExpense(AnalyzeExpenseRequest analyzeExpenseRequest)	AnalyzeExpense synchronously analyzes an input document for financially related relationships between text.
default AnalyzeIdResponse	analyzeID(Consumer<AnalyzeIdRequest.Builder> analyzeIdRequest)	Analyzes identity documents for relevant information.
default AnalyzeIdResponse	analyzeID(AnalyzeIdRequest analyzeIdRequest)	Analyzes identity documents for relevant information.
static TextractClientBuilder	builder()	Create a builder that can be used to configure and create a TextractClient.
static TextractClient	create()	Create a TextractClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateAdapterResponse	createAdapter(Consumer<CreateAdapterRequest.Builder> createAdapterRequest)	Creates an adapter, which can be fine-tuned for enhanced performance on user provided documents.
default CreateAdapterResponse	createAdapter(CreateAdapterRequest createAdapterRequest)	Creates an adapter, which can be fine-tuned for enhanced performance on user provided documents.
default CreateAdapterVersionResponse	createAdapterVersion(Consumer<CreateAdapterVersionRequest.Builder> createAdapterVersionRequest)	Creates a new version of an adapter.
default CreateAdapterVersionResponse	createAdapterVersion(CreateAdapterVersionRequest createAdapterVersionRequest)	Creates a new version of an adapter.
default DeleteAdapterResponse	deleteAdapter(Consumer<DeleteAdapterRequest.Builder> deleteAdapterRequest)	Deletes an Amazon Textract adapter.
default DeleteAdapterResponse	deleteAdapter(DeleteAdapterRequest deleteAdapterRequest)	Deletes an Amazon Textract adapter.
default DeleteAdapterVersionResponse	deleteAdapterVersion(Consumer<DeleteAdapterVersionRequest.Builder> deleteAdapterVersionRequest)	Deletes an Amazon Textract adapter version.
default DeleteAdapterVersionResponse	deleteAdapterVersion(DeleteAdapterVersionRequest deleteAdapterVersionRequest)	Deletes an Amazon Textract adapter version.
default DetectDocumentTextResponse	detectDocumentText(Consumer<DetectDocumentTextRequest.Builder> detectDocumentTextRequest)	Detects text in the input document.
default DetectDocumentTextResponse	detectDocumentText(DetectDocumentTextRequest detectDocumentTextRequest)	Detects text in the input document.
default GetAdapterResponse	getAdapter(Consumer<GetAdapterRequest.Builder> getAdapterRequest)	Gets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description, CreationTime, AutoUpdate status, and FeatureTypes.
default GetAdapterResponse	getAdapter(GetAdapterRequest getAdapterRequest)	Gets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description, CreationTime, AutoUpdate status, and FeatureTypes.
default GetAdapterVersionResponse	getAdapterVersion(Consumer<GetAdapterVersionRequest.Builder> getAdapterVersionRequest)	Gets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics.
default GetAdapterVersionResponse	getAdapterVersion(GetAdapterVersionRequest getAdapterVersionRequest)	Gets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics.
default GetDocumentAnalysisResponse	getDocumentAnalysis(Consumer<GetDocumentAnalysisRequest.Builder> getDocumentAnalysisRequest)	Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.
default GetDocumentAnalysisResponse	getDocumentAnalysis(GetDocumentAnalysisRequest getDocumentAnalysisRequest)	Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.
default GetDocumentTextDetectionResponse	getDocumentTextDetection(Consumer<GetDocumentTextDetectionRequest.Builder> getDocumentTextDetectionRequest)	Gets the results for an Amazon Textract asynchronous operation that detects text in a document.
default GetDocumentTextDetectionResponse	getDocumentTextDetection(GetDocumentTextDetectionRequest getDocumentTextDetectionRequest)	Gets the results for an Amazon Textract asynchronous operation that detects text in a document.
default GetExpenseAnalysisResponse	getExpenseAnalysis(Consumer<GetExpenseAnalysisRequest.Builder> getExpenseAnalysisRequest)	Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts.
default GetExpenseAnalysisResponse	getExpenseAnalysis(GetExpenseAnalysisRequest getExpenseAnalysisRequest)	Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts.
default GetLendingAnalysisResponse	getLendingAnalysis(Consumer<GetLendingAnalysisRequest.Builder> getLendingAnalysisRequest)	Gets the results for an Amazon Textract asynchronous operation that analyzes text in a lending document.
default GetLendingAnalysisResponse	getLendingAnalysis(GetLendingAnalysisRequest getLendingAnalysisRequest)	Gets the results for an Amazon Textract asynchronous operation that analyzes text in a lending document.
default GetLendingAnalysisSummaryResponse	getLendingAnalysisSummary(Consumer<GetLendingAnalysisSummaryRequest.Builder> getLendingAnalysisSummaryRequest)	Gets summarized results for the StartLendingAnalysis operation, which analyzes text in a lending document.
default GetLendingAnalysisSummaryResponse	getLendingAnalysisSummary(GetLendingAnalysisSummaryRequest getLendingAnalysisSummaryRequest)	Gets summarized results for the StartLendingAnalysis operation, which analyzes text in a lending document.
default ListAdaptersResponse	listAdapters(Consumer<ListAdaptersRequest.Builder> listAdaptersRequest)	Lists all adapters that match the specified filtration criteria.
default ListAdaptersResponse	listAdapters(ListAdaptersRequest listAdaptersRequest)	Lists all adapters that match the specified filtration criteria.
default ListAdaptersIterable	listAdaptersPaginator(Consumer<ListAdaptersRequest.Builder> listAdaptersRequest)	This is a variant of listAdapters(software.amazon.awssdk.services.textract.model.ListAdaptersRequest) operation.
default ListAdaptersIterable	listAdaptersPaginator(ListAdaptersRequest listAdaptersRequest)	This is a variant of listAdapters(software.amazon.awssdk.services.textract.model.ListAdaptersRequest) operation.
default ListAdapterVersionsResponse	listAdapterVersions(Consumer<ListAdapterVersionsRequest.Builder> listAdapterVersionsRequest)	List all version of an adapter that meet the specified filtration criteria.
default ListAdapterVersionsResponse	listAdapterVersions(ListAdapterVersionsRequest listAdapterVersionsRequest)	List all version of an adapter that meet the specified filtration criteria.
default ListAdapterVersionsIterable	listAdapterVersionsPaginator(Consumer<ListAdapterVersionsRequest.Builder> listAdapterVersionsRequest)	This is a variant of listAdapterVersions(software.amazon.awssdk.services.textract.model.ListAdapterVersionsRequest) operation.
default ListAdapterVersionsIterable	listAdapterVersionsPaginator(ListAdapterVersionsRequest listAdapterVersionsRequest)	This is a variant of listAdapterVersions(software.amazon.awssdk.services.textract.model.ListAdapterVersionsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists all tags for an Amazon Textract resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists all tags for an Amazon Textract resource.
default TextractServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartDocumentAnalysisResponse	startDocumentAnalysis(Consumer<StartDocumentAnalysisRequest.Builder> startDocumentAnalysisRequest)	Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.
default StartDocumentAnalysisResponse	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.
default StartDocumentTextDetectionResponse	startDocumentTextDetection(Consumer<StartDocumentTextDetectionRequest.Builder> startDocumentTextDetectionRequest)	Starts the asynchronous detection of text in a document.
default StartDocumentTextDetectionResponse	startDocumentTextDetection(StartDocumentTextDetectionRequest startDocumentTextDetectionRequest)	Starts the asynchronous detection of text in a document.
default StartExpenseAnalysisResponse	startExpenseAnalysis(Consumer<StartExpenseAnalysisRequest.Builder> startExpenseAnalysisRequest)	Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names.
default StartExpenseAnalysisResponse	startExpenseAnalysis(StartExpenseAnalysisRequest startExpenseAnalysisRequest)	Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names.
default StartLendingAnalysisResponse	startLendingAnalysis(Consumer<StartLendingAnalysisRequest.Builder> startLendingAnalysisRequest)	Starts the classification and analysis of an input document.
default StartLendingAnalysisResponse	startLendingAnalysis(StartLendingAnalysisRequest startLendingAnalysisRequest)	Starts the classification and analysis of an input document.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds one or more tags to the specified resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds one or more tags to the specified resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes any tags with the specified keys from the specified resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes any tags with the specified keys from the specified resource.
default UpdateAdapterResponse	updateAdapter(Consumer<UpdateAdapterRequest.Builder> updateAdapterRequest)	Update the configuration for an adapter.
default UpdateAdapterResponse	updateAdapter(UpdateAdapterRequest updateAdapterRequest)	Update the configuration for an adapter.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

analyzeDocument

default AnalyzeDocumentResponse analyzeDocument(AnalyzeDocumentRequest analyzeDocumentRequest)
                                         throws InvalidParameterException,
InvalidS3ObjectException,
UnsupportedDocumentException,
DocumentTooLargeException,
BadDocumentException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
HumanLoopQuotaExceededException,
AwsServiceException,
SdkClientException,
TextractException

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

• Signatures. A SIGNATURE Block object contains the location information of a signature in a document. If used in conjunction with forms or tables, a signature can be given a Key-Value pairing or be detected in the cell of a table.

• Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object.

• Query Result. A QUERY_RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score.

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.

Parameters:

analyzeDocumentRequest -

Returns:

Result of the AnalyzeDocument operation returned by the service.

See Also:

• AWS API Documentation

analyzeDocument

default AnalyzeDocumentResponse analyzeDocument(Consumer<AnalyzeDocumentRequest.Builder> analyzeDocumentRequest)
                                         throws InvalidParameterException,
InvalidS3ObjectException,
UnsupportedDocumentException,
DocumentTooLargeException,
BadDocumentException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
HumanLoopQuotaExceededException,
AwsServiceException,
SdkClientException,
TextractException

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

• Signatures. A SIGNATURE Block object contains the location information of a signature in a document. If used in conjunction with forms or tables, a signature can be given a Key-Value pairing or be detected in the cell of a table.

• Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object.

• Query Result. A QUERY_RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score.

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.

This is a convenience which creates an instance of the AnalyzeDocumentRequest.Builder avoiding the need to create one manually via AnalyzeDocumentRequest.builder()

Parameters:

analyzeDocumentRequest - A Consumer that will call methods on AnalyzeDocumentRequest.Builder to create a request.

Returns:

Result of the AnalyzeDocument operation returned by the service.

See Also:

• AWS API Documentation

analyzeExpense

default AnalyzeExpenseResponse analyzeExpense(AnalyzeExpenseRequest analyzeExpenseRequest)
                                       throws InvalidParameterException,
InvalidS3ObjectException,
UnsupportedDocumentException,
DocumentTooLargeException,
BadDocumentException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
AwsServiceException,
SdkClientException,
TextractException

AnalyzeExpense synchronously analyzes an input document for financially related relationships between text.

Information is returned as ExpenseDocuments and seperated as follows:

• LineItemGroups- A data set containing LineItems which store information about the lines of text, such as an item purchased and its price on a receipt.

• SummaryFields- Contains all other information a receipt, such as header information or the vendors name.

Parameters:

analyzeExpenseRequest -

Returns:

Result of the AnalyzeExpense operation returned by the service.

See Also:

• AWS API Documentation

analyzeExpense

default AnalyzeExpenseResponse analyzeExpense(Consumer<AnalyzeExpenseRequest.Builder> analyzeExpenseRequest)
                                       throws InvalidParameterException,
InvalidS3ObjectException,
UnsupportedDocumentException,
DocumentTooLargeException,
BadDocumentException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
AwsServiceException,
SdkClientException,
TextractException

AnalyzeExpense synchronously analyzes an input document for financially related relationships between text.

Information is returned as ExpenseDocuments and seperated as follows:

• LineItemGroups- A data set containing LineItems which store information about the lines of text, such as an item purchased and its price on a receipt.

• SummaryFields- Contains all other information a receipt, such as header information or the vendors name.

This is a convenience which creates an instance of the AnalyzeExpenseRequest.Builder avoiding the need to create one manually via AnalyzeExpenseRequest.builder()

Parameters:

analyzeExpenseRequest - A Consumer that will call methods on AnalyzeExpenseRequest.Builder to create a request.

Returns:

Result of the AnalyzeExpense operation returned by the service.

See Also:

• AWS API Documentation

analyzeID

default AnalyzeIdResponse analyzeID(AnalyzeIdRequest analyzeIdRequest)
                             throws InvalidParameterException,
InvalidS3ObjectException,
UnsupportedDocumentException,
DocumentTooLargeException,
BadDocumentException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
AwsServiceException,
SdkClientException,
TextractException

Analyzes identity documents for relevant information. This information is extracted and returned as IdentityDocumentFields, which records both the normalized field and value of the extracted text. Unlike other Amazon Textract operations, AnalyzeID doesn't return any Geometry data.

Parameters:

analyzeIdRequest -

Returns:

Result of the AnalyzeID operation returned by the service.

See Also:

• AWS API Documentation

analyzeID

default AnalyzeIdResponse analyzeID(Consumer<AnalyzeIdRequest.Builder> analyzeIdRequest)
                             throws InvalidParameterException,
InvalidS3ObjectException,
UnsupportedDocumentException,
DocumentTooLargeException,
BadDocumentException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
AwsServiceException,
SdkClientException,
TextractException

Analyzes identity documents for relevant information. This information is extracted and returned as IdentityDocumentFields, which records both the normalized field and value of the extracted text. Unlike other Amazon Textract operations, AnalyzeID doesn't return any Geometry data.

This is a convenience which creates an instance of the AnalyzeIdRequest.Builder avoiding the need to create one manually via AnalyzeIdRequest.builder()

Parameters:

analyzeIdRequest - A Consumer that will call methods on AnalyzeIdRequest.Builder to create a request.

Returns:

Result of the AnalyzeID operation returned by the service.

See Also:

• AWS API Documentation

createAdapter

default CreateAdapterResponse createAdapter(CreateAdapterRequest createAdapterRequest)
                                     throws InvalidParameterException,
AccessDeniedException,
ConflictException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
IdempotentParameterMismatchException,
ThrottlingException,
LimitExceededException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
TextractException

Creates an adapter, which can be fine-tuned for enhanced performance on user provided documents. Takes an AdapterName and FeatureType. Currently the only supported feature type is QUERIES. You can also provide a Description, Tags, and a ClientRequestToken. You can choose whether or not the adapter should be AutoUpdated with the AutoUpdate argument. By default, AutoUpdate is set to DISABLED.

Parameters:

createAdapterRequest -

Returns:

Result of the CreateAdapter operation returned by the service.

See Also:

• AWS API Documentation

createAdapter

default CreateAdapterResponse createAdapter(Consumer<CreateAdapterRequest.Builder> createAdapterRequest)
                                     throws InvalidParameterException,
AccessDeniedException,
ConflictException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
IdempotentParameterMismatchException,
ThrottlingException,
LimitExceededException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
TextractException

Creates an adapter, which can be fine-tuned for enhanced performance on user provided documents. Takes an AdapterName and FeatureType. Currently the only supported feature type is QUERIES. You can also provide a Description, Tags, and a ClientRequestToken. You can choose whether or not the adapter should be AutoUpdated with the AutoUpdate argument. By default, AutoUpdate is set to DISABLED.

This is a convenience which creates an instance of the CreateAdapterRequest.Builder avoiding the need to create one manually via CreateAdapterRequest.builder()

Parameters:

createAdapterRequest - A Consumer that will call methods on CreateAdapterRequest.Builder to create a request.

Returns:

Result of the CreateAdapter operation returned by the service.

See Also:

• AWS API Documentation

createAdapterVersion

default CreateAdapterVersionResponse createAdapterVersion(CreateAdapterVersionRequest createAdapterVersionRequest)
                                                   throws InvalidParameterException,
InvalidS3ObjectException,
InvalidKmsKeyException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
IdempotentParameterMismatchException,
ThrottlingException,
LimitExceededException,
ValidationException,
ServiceQuotaExceededException,
ResourceNotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
TextractException

Creates a new version of an adapter. Operates on a provided AdapterId and a specified dataset provided via the DatasetConfig argument. Requires that you specify an Amazon S3 bucket with the OutputConfig argument. You can provide an optional KMSKeyId, an optional ClientRequestToken, and optional tags.

Parameters:

createAdapterVersionRequest -

Returns:

Result of the CreateAdapterVersion operation returned by the service.

See Also:

• AWS API Documentation

createAdapterVersion

default CreateAdapterVersionResponse createAdapterVersion(Consumer<CreateAdapterVersionRequest.Builder> createAdapterVersionRequest)
                                                   throws InvalidParameterException,
InvalidS3ObjectException,
InvalidKmsKeyException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
IdempotentParameterMismatchException,
ThrottlingException,
LimitExceededException,
ValidationException,
ServiceQuotaExceededException,
ResourceNotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
TextractException

Creates a new version of an adapter. Operates on a provided AdapterId and a specified dataset provided via the DatasetConfig argument. Requires that you specify an Amazon S3 bucket with the OutputConfig argument. You can provide an optional KMSKeyId, an optional ClientRequestToken, and optional tags.

This is a convenience which creates an instance of the CreateAdapterVersionRequest.Builder avoiding the need to create one manually via CreateAdapterVersionRequest.builder()

Parameters:

createAdapterVersionRequest - A Consumer that will call methods on CreateAdapterVersionRequest.Builder to create a request.

Returns:

Result of the CreateAdapterVersion operation returned by the service.

See Also:

• AWS API Documentation

deleteAdapter

default DeleteAdapterResponse deleteAdapter(DeleteAdapterRequest deleteAdapterRequest)
                                     throws InvalidParameterException,
AccessDeniedException,
ConflictException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
TextractException

Deletes an Amazon Textract adapter. Takes an AdapterId and deletes the adapter specified by the ID.

Parameters:

deleteAdapterRequest -

Returns:

Result of the DeleteAdapter operation returned by the service.

See Also:

• AWS API Documentation

deleteAdapter

default DeleteAdapterResponse deleteAdapter(Consumer<DeleteAdapterRequest.Builder> deleteAdapterRequest)
                                     throws InvalidParameterException,
AccessDeniedException,
ConflictException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
TextractException

Deletes an Amazon Textract adapter. Takes an AdapterId and deletes the adapter specified by the ID.

This is a convenience which creates an instance of the DeleteAdapterRequest.Builder avoiding the need to create one manually via DeleteAdapterRequest.builder()

Parameters:

deleteAdapterRequest - A Consumer that will call methods on DeleteAdapterRequest.Builder to create a request.

Returns:

Result of the DeleteAdapter operation returned by the service.

See Also:

• AWS API Documentation

deleteAdapterVersion

default DeleteAdapterVersionResponse deleteAdapterVersion(DeleteAdapterVersionRequest deleteAdapterVersionRequest)
                                                   throws InvalidParameterException,
AccessDeniedException,
ConflictException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
TextractException

Deletes an Amazon Textract adapter version. Requires that you specify both an AdapterId and a AdapterVersion. Deletes the adapter version specified by the AdapterId and the AdapterVersion.

Parameters:

deleteAdapterVersionRequest -

Returns:

Result of the DeleteAdapterVersion operation returned by the service.

See Also:

• AWS API Documentation

deleteAdapterVersion

default DeleteAdapterVersionResponse deleteAdapterVersion(Consumer<DeleteAdapterVersionRequest.Builder> deleteAdapterVersionRequest)
                                                   throws InvalidParameterException,
AccessDeniedException,
ConflictException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
TextractException

Deletes an Amazon Textract adapter version. Requires that you specify both an AdapterId and a AdapterVersion. Deletes the adapter version specified by the AdapterId and the AdapterVersion.

This is a convenience which creates an instance of the DeleteAdapterVersionRequest.Builder avoiding the need to create one manually via DeleteAdapterVersionRequest.builder()

Parameters:

deleteAdapterVersionRequest - A Consumer that will call methods on DeleteAdapterVersionRequest.Builder to create a request.

Returns:

Result of the DeleteAdapterVersion operation returned by the service.

See Also:

• AWS API Documentation

detectDocumentText

default DetectDocumentTextResponse detectDocumentText(DetectDocumentTextRequest detectDocumentTextRequest)
                                               throws InvalidParameterException,
InvalidS3ObjectException,
UnsupportedDocumentException,
DocumentTooLargeException,
BadDocumentException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
AwsServiceException,
SdkClientException,
TextractException

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 in one of the following image formats: JPEG, PNG, PDF, or TIFF. 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.

Parameters:

detectDocumentTextRequest -

Returns:

Result of the DetectDocumentText operation returned by the service.

See Also:

• AWS API Documentation

detectDocumentText

default DetectDocumentTextResponse detectDocumentText(Consumer<DetectDocumentTextRequest.Builder> detectDocumentTextRequest)
                                               throws InvalidParameterException,
InvalidS3ObjectException,
UnsupportedDocumentException,
DocumentTooLargeException,
BadDocumentException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
AwsServiceException,
SdkClientException,
TextractException

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 in one of the following image formats: JPEG, PNG, PDF, or TIFF. 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.

This is a convenience which creates an instance of the DetectDocumentTextRequest.Builder avoiding the need to create one manually via DetectDocumentTextRequest.builder()

Parameters:

detectDocumentTextRequest - A Consumer that will call methods on DetectDocumentTextRequest.Builder to create a request.

Returns:

Result of the DetectDocumentText operation returned by the service.

See Also:

• AWS API Documentation

getAdapter

default GetAdapterResponse getAdapter(GetAdapterRequest getAdapterRequest)
                               throws InvalidParameterException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
TextractException

Gets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description, CreationTime, AutoUpdate status, and FeatureTypes.

Parameters:

getAdapterRequest -

Returns:

Result of the GetAdapter operation returned by the service.

See Also:

• AWS API Documentation

getAdapter

default GetAdapterResponse getAdapter(Consumer<GetAdapterRequest.Builder> getAdapterRequest)
                               throws InvalidParameterException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
TextractException

Gets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description, CreationTime, AutoUpdate status, and FeatureTypes.

This is a convenience which creates an instance of the GetAdapterRequest.Builder avoiding the need to create one manually via GetAdapterRequest.builder()

Parameters:

getAdapterRequest - A Consumer that will call methods on GetAdapterRequest.Builder to create a request.

Returns:

Result of the GetAdapter operation returned by the service.

See Also:

• AWS API Documentation

getAdapterVersion

default GetAdapterVersionResponse getAdapterVersion(GetAdapterVersionRequest getAdapterVersionRequest)
                                             throws InvalidParameterException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
TextractException

Gets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics.

Parameters:

getAdapterVersionRequest -

Returns:

Result of the GetAdapterVersion operation returned by the service.

See Also:

• AWS API Documentation

getAdapterVersion

default GetAdapterVersionResponse getAdapterVersion(Consumer<GetAdapterVersionRequest.Builder> getAdapterVersionRequest)
                                             throws InvalidParameterException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
TextractException

Gets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics.

This is a convenience which creates an instance of the GetAdapterVersionRequest.Builder avoiding the need to create one manually via GetAdapterVersionRequest.builder()

Parameters:

getAdapterVersionRequest - A Consumer that will call methods on GetAdapterVersionRequest.Builder to create a request.

Returns:

Result of the GetAdapterVersion operation returned by the service.

See Also:

• AWS API Documentation

getDocumentAnalysis

default GetDocumentAnalysisResponse getDocumentAnalysis(GetDocumentAnalysisRequest getDocumentAnalysisRequest)
                                                 throws InvalidParameterException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InvalidJobIdException,
InternalServerErrorException,
ThrottlingException,
InvalidS3ObjectException,
InvalidKmsKeyException,
AwsServiceException,
SdkClientException,
TextractException

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

• Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object.

• Query Results. A QUERY_RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score.

While processing a document with queries, look out for INVALID_REQUEST_PARAMETERS output. This indicates that either the per page query limit has been exceeded or that the operation is trying to query a page in the document which doesn’t exist.

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.

Parameters:

getDocumentAnalysisRequest -

Returns:

Result of the GetDocumentAnalysis operation returned by the service.

See Also:

• AWS API Documentation

getDocumentAnalysis

default GetDocumentAnalysisResponse getDocumentAnalysis(Consumer<GetDocumentAnalysisRequest.Builder> getDocumentAnalysisRequest)
                                                 throws InvalidParameterException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InvalidJobIdException,
InternalServerErrorException,
ThrottlingException,
InvalidS3ObjectException,
InvalidKmsKeyException,
AwsServiceException,
SdkClientException,
TextractException

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

• Query. A QUERY Block object contains the query text, alias and link to the associated Query results block object.

• Query Results. A QUERY_RESULT Block object contains the answer to the query and an ID that connects it to the query asked. This Block also contains a confidence score.

While processing a document with queries, look out for INVALID_REQUEST_PARAMETERS output. This indicates that either the per page query limit has been exceeded or that the operation is trying to query a page in the document which doesn’t exist.

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.

This is a convenience which creates an instance of the GetDocumentAnalysisRequest.Builder avoiding the need to create one manually via GetDocumentAnalysisRequest.builder()

Parameters:

getDocumentAnalysisRequest - A Consumer that will call methods on GetDocumentAnalysisRequest.Builder to create a request.

Returns:

Result of the GetDocumentAnalysis operation returned by the service.

See Also:

• AWS API Documentation

getDocumentTextDetection

default GetDocumentTextDetectionResponse getDocumentTextDetection(GetDocumentTextDetectionRequest getDocumentTextDetectionRequest)
                                                           throws InvalidParameterException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InvalidJobIdException,
InternalServerErrorException,
ThrottlingException,
InvalidS3ObjectException,
InvalidKmsKeyException,
AwsServiceException,
SdkClientException,
TextractException

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.

Parameters:

getDocumentTextDetectionRequest -

Returns:

Result of the GetDocumentTextDetection operation returned by the service.

See Also:

• AWS API Documentation

getDocumentTextDetection

default GetDocumentTextDetectionResponse getDocumentTextDetection(Consumer<GetDocumentTextDetectionRequest.Builder> getDocumentTextDetectionRequest)
                                                           throws InvalidParameterException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InvalidJobIdException,
InternalServerErrorException,
ThrottlingException,
InvalidS3ObjectException,
InvalidKmsKeyException,
AwsServiceException,
SdkClientException,
TextractException

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.

This is a convenience which creates an instance of the GetDocumentTextDetectionRequest.Builder avoiding the need to create one manually via GetDocumentTextDetectionRequest.builder()

Parameters:

getDocumentTextDetectionRequest - A Consumer that will call methods on GetDocumentTextDetectionRequest.Builder to create a request.

Returns:

Result of the GetDocumentTextDetection operation returned by the service.

See Also:

• AWS API Documentation

getExpenseAnalysis

default GetExpenseAnalysisResponse getExpenseAnalysis(GetExpenseAnalysisRequest getExpenseAnalysisRequest)
                                               throws InvalidParameterException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InvalidJobIdException,
InternalServerErrorException,
ThrottlingException,
InvalidS3ObjectException,
InvalidKmsKeyException,
AwsServiceException,
SdkClientException,
TextractException

Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts. Amazon Textract finds contact information, items purchased, and vendor name, from input invoices and receipts.

You start asynchronous invoice/receipt analysis by calling StartExpenseAnalysis, which returns a job identifier (JobId). Upon completion of the invoice/receipt analysis, Amazon Textract publishes the completion status to the Amazon Simple Notification Service (Amazon SNS) topic. This topic must be registered in the initial call to StartExpenseAnalysis. To get the results of the invoice/receipt analysis operation, first ensure that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetExpenseAnalysis, and pass the job identifier (JobId) from the initial call to StartExpenseAnalysis.

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 GetExpenseAnalysis, and populate the NextToken request parameter with the token value that's returned from the previous call to GetExpenseAnalysis.

For more information, see Analyzing Invoices and Receipts.

Parameters:

getExpenseAnalysisRequest -

Returns:

Result of the GetExpenseAnalysis operation returned by the service.

See Also:

• AWS API Documentation

getExpenseAnalysis

default GetExpenseAnalysisResponse getExpenseAnalysis(Consumer<GetExpenseAnalysisRequest.Builder> getExpenseAnalysisRequest)
                                               throws InvalidParameterException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InvalidJobIdException,
InternalServerErrorException,
ThrottlingException,
InvalidS3ObjectException,
InvalidKmsKeyException,
AwsServiceException,
SdkClientException,
TextractException

Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts. Amazon Textract finds contact information, items purchased, and vendor name, from input invoices and receipts.

You start asynchronous invoice/receipt analysis by calling StartExpenseAnalysis, which returns a job identifier (JobId). Upon completion of the invoice/receipt analysis, Amazon Textract publishes the completion status to the Amazon Simple Notification Service (Amazon SNS) topic. This topic must be registered in the initial call to StartExpenseAnalysis. To get the results of the invoice/receipt analysis operation, first ensure that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetExpenseAnalysis, and pass the job identifier (JobId) from the initial call to StartExpenseAnalysis.

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 GetExpenseAnalysis, and populate the NextToken request parameter with the token value that's returned from the previous call to GetExpenseAnalysis.

For more information, see Analyzing Invoices and Receipts.

This is a convenience which creates an instance of the GetExpenseAnalysisRequest.Builder avoiding the need to create one manually via GetExpenseAnalysisRequest.builder()

Parameters:

getExpenseAnalysisRequest - A Consumer that will call methods on GetExpenseAnalysisRequest.Builder to create a request.

Returns:

Result of the GetExpenseAnalysis operation returned by the service.

See Also:

• AWS API Documentation

getLendingAnalysis

default GetLendingAnalysisResponse getLendingAnalysis(GetLendingAnalysisRequest getLendingAnalysisRequest)
                                               throws InvalidParameterException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InvalidJobIdException,
InternalServerErrorException,
ThrottlingException,
InvalidS3ObjectException,
InvalidKmsKeyException,
AwsServiceException,
SdkClientException,
TextractException

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

You start asynchronous text analysis by calling StartLendingAnalysis, 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 StartLendingAnalysis.

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 GetLendingAnalysis, and pass the job identifier (JobId) from the initial call to StartLendingAnalysis.

Parameters:

getLendingAnalysisRequest -

Returns:

Result of the GetLendingAnalysis operation returned by the service.

See Also:

• AWS API Documentation

getLendingAnalysis

default GetLendingAnalysisResponse getLendingAnalysis(Consumer<GetLendingAnalysisRequest.Builder> getLendingAnalysisRequest)
                                               throws InvalidParameterException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InvalidJobIdException,
InternalServerErrorException,
ThrottlingException,
InvalidS3ObjectException,
InvalidKmsKeyException,
AwsServiceException,
SdkClientException,
TextractException

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

You start asynchronous text analysis by calling StartLendingAnalysis, 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 StartLendingAnalysis.

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 GetLendingAnalysis, and pass the job identifier (JobId) from the initial call to StartLendingAnalysis.

This is a convenience which creates an instance of the GetLendingAnalysisRequest.Builder avoiding the need to create one manually via GetLendingAnalysisRequest.builder()

Parameters:

getLendingAnalysisRequest - A Consumer that will call methods on GetLendingAnalysisRequest.Builder to create a request.

Returns:

Result of the GetLendingAnalysis operation returned by the service.

See Also:

• AWS API Documentation

getLendingAnalysisSummary

default GetLendingAnalysisSummaryResponse getLendingAnalysisSummary(GetLendingAnalysisSummaryRequest getLendingAnalysisSummaryRequest)
                                                             throws InvalidParameterException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InvalidJobIdException,
InternalServerErrorException,
ThrottlingException,
InvalidS3ObjectException,
InvalidKmsKeyException,
AwsServiceException,
SdkClientException,
TextractException

Gets summarized results for the StartLendingAnalysis operation, which analyzes text in a lending document. The returned summary consists of information about documents grouped together by a common document type. Information like detected signatures, page numbers, and split documents is returned with respect to the type of grouped document.

You start asynchronous text analysis by calling StartLendingAnalysis, 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 StartLendingAnalysis.

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 GetLendingAnalysisSummary, and pass the job identifier ( JobId) from the initial call to StartLendingAnalysis.

Parameters:

getLendingAnalysisSummaryRequest -

Returns:

Result of the GetLendingAnalysisSummary operation returned by the service.

See Also:

• AWS API Documentation

getLendingAnalysisSummary

default GetLendingAnalysisSummaryResponse getLendingAnalysisSummary(Consumer<GetLendingAnalysisSummaryRequest.Builder> getLendingAnalysisSummaryRequest)
                                                             throws InvalidParameterException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InvalidJobIdException,
InternalServerErrorException,
ThrottlingException,
InvalidS3ObjectException,
InvalidKmsKeyException,
AwsServiceException,
SdkClientException,
TextractException

Gets summarized results for the StartLendingAnalysis operation, which analyzes text in a lending document. The returned summary consists of information about documents grouped together by a common document type. Information like detected signatures, page numbers, and split documents is returned with respect to the type of grouped document.

You start asynchronous text analysis by calling StartLendingAnalysis, 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 StartLendingAnalysis.

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 GetLendingAnalysisSummary, and pass the job identifier ( JobId) from the initial call to StartLendingAnalysis.

This is a convenience which creates an instance of the GetLendingAnalysisSummaryRequest.Builder avoiding the need to create one manually via GetLendingAnalysisSummaryRequest.builder()

Parameters:

getLendingAnalysisSummaryRequest - A Consumer that will call methods on GetLendingAnalysisSummaryRequest.Builder to create a request.

Returns:

Result of the GetLendingAnalysisSummary operation returned by the service.

See Also:

• AWS API Documentation

listAdapterVersions

default ListAdapterVersionsResponse listAdapterVersions(ListAdapterVersionsRequest listAdapterVersionsRequest)
                                                 throws InvalidParameterException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
TextractException

List all version of an adapter that meet the specified filtration criteria.

Parameters:

listAdapterVersionsRequest -

Returns:

Result of the ListAdapterVersions operation returned by the service.

See Also:

• AWS API Documentation

listAdapterVersions

default ListAdapterVersionsResponse listAdapterVersions(Consumer<ListAdapterVersionsRequest.Builder> listAdapterVersionsRequest)
                                                 throws InvalidParameterException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
TextractException

List all version of an adapter that meet the specified filtration criteria.

This is a convenience which creates an instance of the ListAdapterVersionsRequest.Builder avoiding the need to create one manually via ListAdapterVersionsRequest.builder()

Parameters:

listAdapterVersionsRequest - A Consumer that will call methods on ListAdapterVersionsRequest.Builder to create a request.

Returns:

Result of the ListAdapterVersions operation returned by the service.

See Also:

• AWS API Documentation

listAdapterVersionsPaginator

default ListAdapterVersionsIterable listAdapterVersionsPaginator(ListAdapterVersionsRequest listAdapterVersionsRequest)
                                                          throws InvalidParameterException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
TextractException

This is a variant of listAdapterVersions(software.amazon.awssdk.services.textract.model.ListAdapterVersionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.textract.paginators.ListAdapterVersionsIterable responses = client.listAdapterVersionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.textract.paginators.ListAdapterVersionsIterable responses = client
             .listAdapterVersionsPaginator(request);
     for (software.amazon.awssdk.services.textract.model.ListAdapterVersionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.textract.paginators.ListAdapterVersionsIterable responses = client.listAdapterVersionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAdapterVersions(software.amazon.awssdk.services.textract.model.ListAdapterVersionsRequest) operation.

Parameters:

listAdapterVersionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAdapterVersionsPaginator

default ListAdapterVersionsIterable listAdapterVersionsPaginator(Consumer<ListAdapterVersionsRequest.Builder> listAdapterVersionsRequest)
                                                          throws InvalidParameterException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
TextractException

This is a variant of listAdapterVersions(software.amazon.awssdk.services.textract.model.ListAdapterVersionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.textract.paginators.ListAdapterVersionsIterable responses = client.listAdapterVersionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.textract.paginators.ListAdapterVersionsIterable responses = client
             .listAdapterVersionsPaginator(request);
     for (software.amazon.awssdk.services.textract.model.ListAdapterVersionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.textract.paginators.ListAdapterVersionsIterable responses = client.listAdapterVersionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAdapterVersions(software.amazon.awssdk.services.textract.model.ListAdapterVersionsRequest) operation.

This is a convenience which creates an instance of the ListAdapterVersionsRequest.Builder avoiding the need to create one manually via ListAdapterVersionsRequest.builder()

Parameters:

listAdapterVersionsRequest - A Consumer that will call methods on ListAdapterVersionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAdapters

default ListAdaptersResponse listAdapters(ListAdaptersRequest listAdaptersRequest)
                                   throws InvalidParameterException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
TextractException

Lists all adapters that match the specified filtration criteria.

Parameters:

listAdaptersRequest -

Returns:

Result of the ListAdapters operation returned by the service.

See Also:

• AWS API Documentation

listAdapters

default ListAdaptersResponse listAdapters(Consumer<ListAdaptersRequest.Builder> listAdaptersRequest)
                                   throws InvalidParameterException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
TextractException

Lists all adapters that match the specified filtration criteria.

This is a convenience which creates an instance of the ListAdaptersRequest.Builder avoiding the need to create one manually via ListAdaptersRequest.builder()

Parameters:

listAdaptersRequest - A Consumer that will call methods on ListAdaptersRequest.Builder to create a request.

Returns:

Result of the ListAdapters operation returned by the service.

See Also:

• AWS API Documentation

listAdaptersPaginator

default ListAdaptersIterable listAdaptersPaginator(ListAdaptersRequest listAdaptersRequest)
                                            throws InvalidParameterException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
TextractException

This is a variant of listAdapters(software.amazon.awssdk.services.textract.model.ListAdaptersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.textract.paginators.ListAdaptersIterable responses = client.listAdaptersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.textract.paginators.ListAdaptersIterable responses = client.listAdaptersPaginator(request);
     for (software.amazon.awssdk.services.textract.model.ListAdaptersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.textract.paginators.ListAdaptersIterable responses = client.listAdaptersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAdapters(software.amazon.awssdk.services.textract.model.ListAdaptersRequest) operation.

Parameters:

listAdaptersRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAdaptersPaginator

default ListAdaptersIterable listAdaptersPaginator(Consumer<ListAdaptersRequest.Builder> listAdaptersRequest)
                                            throws InvalidParameterException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
TextractException

This is a variant of listAdapters(software.amazon.awssdk.services.textract.model.ListAdaptersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.textract.paginators.ListAdaptersIterable responses = client.listAdaptersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.textract.paginators.ListAdaptersIterable responses = client.listAdaptersPaginator(request);
     for (software.amazon.awssdk.services.textract.model.ListAdaptersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.textract.paginators.ListAdaptersIterable responses = client.listAdaptersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAdapters(software.amazon.awssdk.services.textract.model.ListAdaptersRequest) operation.

This is a convenience which creates an instance of the ListAdaptersRequest.Builder avoiding the need to create one manually via ListAdaptersRequest.builder()

Parameters:

listAdaptersRequest - A Consumer that will call methods on ListAdaptersRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
InvalidParameterException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
TextractException

Lists all tags for an Amazon Textract resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
InvalidParameterException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
TextractException

Lists all tags for an Amazon Textract resource.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

startDocumentAnalysis

default StartDocumentAnalysisResponse startDocumentAnalysis(StartDocumentAnalysisRequest startDocumentAnalysisRequest)
                                                     throws InvalidParameterException,
InvalidS3ObjectException,
InvalidKmsKeyException,
UnsupportedDocumentException,
DocumentTooLargeException,
BadDocumentException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
IdempotentParameterMismatchException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
TextractException

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

Parameters:

startDocumentAnalysisRequest -

Returns:

Result of the StartDocumentAnalysis operation returned by the service.

See Also:

• AWS API Documentation

startDocumentAnalysis

default StartDocumentAnalysisResponse startDocumentAnalysis(Consumer<StartDocumentAnalysisRequest.Builder> startDocumentAnalysisRequest)
                                                     throws InvalidParameterException,
InvalidS3ObjectException,
InvalidKmsKeyException,
UnsupportedDocumentException,
DocumentTooLargeException,
BadDocumentException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
IdempotentParameterMismatchException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
TextractException

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

This is a convenience which creates an instance of the StartDocumentAnalysisRequest.Builder avoiding the need to create one manually via StartDocumentAnalysisRequest.builder()

Parameters:

startDocumentAnalysisRequest - A Consumer that will call methods on StartDocumentAnalysisRequest.Builder to create a request.

Returns:

Result of the StartDocumentAnalysis operation returned by the service.

See Also:

• AWS API Documentation

startDocumentTextDetection

default StartDocumentTextDetectionResponse startDocumentTextDetection(StartDocumentTextDetectionRequest startDocumentTextDetectionRequest)
                                                               throws InvalidParameterException,
InvalidS3ObjectException,
InvalidKmsKeyException,
UnsupportedDocumentException,
DocumentTooLargeException,
BadDocumentException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
IdempotentParameterMismatchException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
TextractException

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

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

Parameters:

startDocumentTextDetectionRequest -

Returns:

Result of the StartDocumentTextDetection operation returned by the service.

See Also:

• AWS API Documentation

startDocumentTextDetection

default StartDocumentTextDetectionResponse startDocumentTextDetection(Consumer<StartDocumentTextDetectionRequest.Builder> startDocumentTextDetectionRequest)
                                                               throws InvalidParameterException,
InvalidS3ObjectException,
InvalidKmsKeyException,
UnsupportedDocumentException,
DocumentTooLargeException,
BadDocumentException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
IdempotentParameterMismatchException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
TextractException

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

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

This is a convenience which creates an instance of the StartDocumentTextDetectionRequest.Builder avoiding the need to create one manually via StartDocumentTextDetectionRequest.builder()

Parameters:

startDocumentTextDetectionRequest - A Consumer that will call methods on StartDocumentTextDetectionRequest.Builder to create a request.

Returns:

Result of the StartDocumentTextDetection operation returned by the service.

See Also:

• AWS API Documentation

startExpenseAnalysis

default StartExpenseAnalysisResponse startExpenseAnalysis(StartExpenseAnalysisRequest startExpenseAnalysisRequest)
                                                   throws InvalidParameterException,
InvalidS3ObjectException,
InvalidKmsKeyException,
UnsupportedDocumentException,
DocumentTooLargeException,
BadDocumentException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
IdempotentParameterMismatchException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
TextractException

Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names.

StartExpenseAnalysis can analyze text in documents that are in JPEG, PNG, and PDF format. The documents must be stored in an Amazon S3 bucket. Use the DocumentLocation parameter to specify the name of your S3 bucket and the name of the document in that bucket.

StartExpenseAnalysis returns a job identifier (JobId) that you will provide to GetExpenseAnalysis to retrieve the results of the operation. When the analysis of the input invoices/receipts is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you provide to the NotificationChannel. To obtain the results of the invoice and receipt analysis operation, ensure that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetExpenseAnalysis, and pass the job identifier (JobId) that was returned by your call to StartExpenseAnalysis.

For more information, see Analyzing Invoices and Receipts.

Parameters:

startExpenseAnalysisRequest -

Returns:

Result of the StartExpenseAnalysis operation returned by the service.

See Also:

• AWS API Documentation

startExpenseAnalysis

default StartExpenseAnalysisResponse startExpenseAnalysis(Consumer<StartExpenseAnalysisRequest.Builder> startExpenseAnalysisRequest)
                                                   throws InvalidParameterException,
InvalidS3ObjectException,
InvalidKmsKeyException,
UnsupportedDocumentException,
DocumentTooLargeException,
BadDocumentException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
IdempotentParameterMismatchException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
TextractException

Starts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names.

StartExpenseAnalysis can analyze text in documents that are in JPEG, PNG, and PDF format. The documents must be stored in an Amazon S3 bucket. Use the DocumentLocation parameter to specify the name of your S3 bucket and the name of the document in that bucket.

StartExpenseAnalysis returns a job identifier (JobId) that you will provide to GetExpenseAnalysis to retrieve the results of the operation. When the analysis of the input invoices/receipts is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you provide to the NotificationChannel. To obtain the results of the invoice and receipt analysis operation, ensure that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetExpenseAnalysis, and pass the job identifier (JobId) that was returned by your call to StartExpenseAnalysis.

For more information, see Analyzing Invoices and Receipts.

This is a convenience which creates an instance of the StartExpenseAnalysisRequest.Builder avoiding the need to create one manually via StartExpenseAnalysisRequest.builder()

Parameters:

startExpenseAnalysisRequest - A Consumer that will call methods on StartExpenseAnalysisRequest.Builder to create a request.

Returns:

Result of the StartExpenseAnalysis operation returned by the service.

See Also:

• AWS API Documentation

startLendingAnalysis

default StartLendingAnalysisResponse startLendingAnalysis(StartLendingAnalysisRequest startLendingAnalysisRequest)
                                                   throws InvalidParameterException,
InvalidS3ObjectException,
InvalidKmsKeyException,
UnsupportedDocumentException,
DocumentTooLargeException,
BadDocumentException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
IdempotentParameterMismatchException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
TextractException

Starts the classification and analysis of an input document. StartLendingAnalysis initiates the classification and analysis of a packet of lending documents. StartLendingAnalysis operates on a document file located in an Amazon S3 bucket.

StartLendingAnalysis can analyze text in documents that are in one of the following formats: JPEG, PNG, TIFF, PDF. Use DocumentLocation to specify the bucket name and the file name of the document.

StartLendingAnalysis returns a job identifier (JobId) that you use to get the results of the operation. When the 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 the status is SUCCEEDED you can call either GetLendingAnalysis or GetLendingAnalysisSummary and provide the JobId to obtain the results of the analysis.

If using OutputConfig to specify an Amazon S3 bucket, the output will be contained within the specified prefix in a directory labeled with the job-id. In the directory there are 3 sub-directories:

• detailedResponse (contains the GetLendingAnalysis response)

• summaryResponse (for the GetLendingAnalysisSummary response)

• splitDocuments (documents split across logical boundaries)

Parameters:

startLendingAnalysisRequest -

Returns:

Result of the StartLendingAnalysis operation returned by the service.

See Also:

• AWS API Documentation

startLendingAnalysis

default StartLendingAnalysisResponse startLendingAnalysis(Consumer<StartLendingAnalysisRequest.Builder> startLendingAnalysisRequest)
                                                   throws InvalidParameterException,
InvalidS3ObjectException,
InvalidKmsKeyException,
UnsupportedDocumentException,
DocumentTooLargeException,
BadDocumentException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
IdempotentParameterMismatchException,
ThrottlingException,
LimitExceededException,
AwsServiceException,
SdkClientException,
TextractException

Starts the classification and analysis of an input document. StartLendingAnalysis initiates the classification and analysis of a packet of lending documents. StartLendingAnalysis operates on a document file located in an Amazon S3 bucket.

StartLendingAnalysis can analyze text in documents that are in one of the following formats: JPEG, PNG, TIFF, PDF. Use DocumentLocation to specify the bucket name and the file name of the document.

StartLendingAnalysis returns a job identifier (JobId) that you use to get the results of the operation. When the 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 the status is SUCCEEDED you can call either GetLendingAnalysis or GetLendingAnalysisSummary and provide the JobId to obtain the results of the analysis.

If using OutputConfig to specify an Amazon S3 bucket, the output will be contained within the specified prefix in a directory labeled with the job-id. In the directory there are 3 sub-directories:

• detailedResponse (contains the GetLendingAnalysis response)

• summaryResponse (for the GetLendingAnalysisSummary response)

• splitDocuments (documents split across logical boundaries)

This is a convenience which creates an instance of the StartLendingAnalysisRequest.Builder avoiding the need to create one manually via StartLendingAnalysisRequest.builder()

Parameters:

startLendingAnalysisRequest - A Consumer that will call methods on StartLendingAnalysisRequest.Builder to create a request.

Returns:

Result of the StartLendingAnalysis operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ResourceNotFoundException,
InvalidParameterException,
ServiceQuotaExceededException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
TextractException

Adds one or more tags to the specified resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ResourceNotFoundException,
InvalidParameterException,
ServiceQuotaExceededException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
TextractException

Adds one or more tags to the specified resource.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ResourceNotFoundException,
InvalidParameterException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
TextractException

Removes any tags with the specified keys from the specified resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ResourceNotFoundException,
InvalidParameterException,
AccessDeniedException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
TextractException

Removes any tags with the specified keys from the specified resource.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateAdapter

default UpdateAdapterResponse updateAdapter(UpdateAdapterRequest updateAdapterRequest)
                                     throws InvalidParameterException,
AccessDeniedException,
ConflictException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
TextractException

Update the configuration for an adapter. FeatureTypes configurations cannot be updated. At least one new parameter must be specified as an argument.

Parameters:

updateAdapterRequest -

Returns:

Result of the UpdateAdapter operation returned by the service.

See Also:

• AWS API Documentation

updateAdapter

default UpdateAdapterResponse updateAdapter(Consumer<UpdateAdapterRequest.Builder> updateAdapterRequest)
                                     throws InvalidParameterException,
AccessDeniedException,
ConflictException,
ProvisionedThroughputExceededException,
InternalServerErrorException,
ThrottlingException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
TextractException

Update the configuration for an adapter. FeatureTypes configurations cannot be updated. At least one new parameter must be specified as an argument.

This is a convenience which creates an instance of the UpdateAdapterRequest.Builder avoiding the need to create one manually via UpdateAdapterRequest.builder()

Parameters:

updateAdapterRequest - A Consumer that will call methods on UpdateAdapterRequest.Builder to create a request.

Returns:

Result of the UpdateAdapter operation returned by the service.

See Also:

• AWS API Documentation

create

static TextractClient create()

Create a TextractClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static TextractClientBuilder builder()

Create a builder that can be used to configure and create a TextractClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default TextractServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration