Back to Aws Doc Sdk Examples

Amazon Textract code examples for the SDK for Java 2.x

javav2/example_code/textract/README.md

latest3.1 KB
Original Source

Amazon Textract code examples for the SDK for Java 2.x

Overview

Shows how to use the AWS SDK for Java 2.x to work with Amazon Textract.

<!--custom.overview.start--> <!--custom.overview.end-->

Amazon Textract enables you to add document text detection and analysis to your applications.

⚠ Important

  • Running this code might result in charges to your AWS account. For more details, see AWS Pricing and Free Tier.
  • Running the tests might result in charges to your AWS account.
  • We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see Grant least privilege.
  • This code is not tested in every AWS Region. For more information, see AWS Regional Services.
<!--custom.important.start--> <!--custom.important.end-->

Code examples

Prerequisites

For prerequisites, see the README in the javav2 folder.

<!--custom.prerequisites.start--> <!--custom.prerequisites.end-->

Single actions

Code excerpts that show you how to call individual service functions.

<!--custom.examples.start--> <!--custom.examples.end-->

Run the examples

Instructions

<!--custom.instructions.start--> <!--custom.instructions.end-->

Tests

⚠ Running tests might result in charges to your AWS account.

To find instructions for running these tests, see the README in the javav2 folder.

<!--custom.tests.start-->

Properties file

Before running the Amazon Textract JUnit tests, you must define values in the config.properties file located in the resources folder. This file contains values that are required to run the JUnit tests. For example, you define a cluster id value used in the tests. If you do not define all values, the JUnit tests fail.

Define these values to successfully run the JUnit tests:

  • sourceDoc - The path where the document is located.
  • bucketName - The name of the S3 bucket that contains the document.
  • docName - A document name (must be an image, for example, book.png).
<!--custom.tests.end-->

Additional resources

<!--custom.resources.start--> <!--custom.resources.end-->

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: Apache-2.0