AWS SDK for Java

The AWS SDK for Java enables Java developers to easily work with Amazon Web Services and build scalable solutions with Amazon S3, Amazon DynamoDB, Amazon Glacier, and more. You can get started in minutes using Maven or by downloading a single zip file.

📣 Note: A version 2.x of the SDK is available, see the AWS SDK for Java 2.x section for more information

• SDK Homepage
• API Docs
• Developer Guide (source)
• Issues
• SDK Blog
• Getting Help

Release Notes

Changes to the SDK beginning with version 1.12.1 (June 2021) are tracked in CHANGELOG.md.

Changes in the retired 1.11.x series of the SDK, beginning with version 1.11.82, are listed in the CHANGELOG-1.11.x.md file.

Release notes for versions prior to 1.11.82 can still be found on the AWS Release Notes Website.

Getting Started

Sign up for AWS

Before you begin, you need an AWS account. Please see the Sign Up for AWS section of the developer guide for information about how to create an AWS account and retrieve your AWS credentials.

Minimum requirements

To run the SDK you will need Java 1.7+. For more information about the requirements and optimum settings for the SDK, please see the Installing a Java Development Environment section of the developer guide.

Install the SDK

The recommended way to use the AWS SDK for Java in your project is to consume it from Maven. Import the aws-java-sdk-bom and specify the SDK Maven modules that your project needs in the dependencies.

Importing the BOM

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.amazonaws</groupId>
      <artifactId>aws-java-sdk-bom</artifactId>
      <version>1.12.541</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

Using the SDK Maven modules

<dependencies>
  <dependency>
    <groupId>com.amazonaws</groupId>
    <artifactId>aws-java-sdk-ec2</artifactId>
  </dependency>
  <dependency>
    <groupId>com.amazonaws</groupId>
    <artifactId>aws-java-sdk-s3</artifactId>
  </dependency>
  <dependency>
    <groupId>com.amazonaws</groupId>
    <artifactId>aws-java-sdk-dynamodb</artifactId>
  </dependency>
</dependencies>

See the Set up the AWS SDK for Java section of the developer guide for more information about installing the SDK through other means.

Features

• Provides easy-to-use HTTP clients for all supported AWS services, regions, and authentication protocols.

• Client-Side Data Encryption for Amazon S3 - Helps improve the security of storing application data in Amazon S3.

• Amazon DynamoDB Object Mapper - Uses Plain Old Java Object (POJOs) to store and retrieve Amazon DynamoDB data.

• Amazon S3 Transfer Manager - With a simple API, achieve enhanced the throughput, performance, and reliability by using multi-threaded Amazon S3 multipart calls.

• Amazon SQS Client-Side Buffering - Collect and send SQS requests in asynchronous batches, improving application and network performance.

• Automatically uses IAM Instance Profile Credentials on configured Amazon EC2 instances.

• And more!

Building From Source

Once you check out the code from GitHub, you can build it using Maven. To disable the GPG-signing in the build, use:

mvn clean install -Dgpg.skip=true

Getting Help

GitHub issues is the preferred channel to interact with our team. Also check these community resources for getting help:

• Ask a question on StackOverflow and tag it with aws-java-sdk
• Come join the AWS Java community chat on Gitter
• Articulate your feature request or upvote existing ones on our Issues page
• Take a look at the blog for plenty of helpful walkthroughs and tips
• Open a case via the AWS Support Center in the AWS console
• If it turns out that you may have found a bug, please open an issue

Maintenance and Support for SDK Major Versions

For information about maintenance and support for SDK major versions and their underlying dependencies, see the following in the AWS SDKs and Tools Reference Guide:

• AWS SDKs and Tools Maintenance Policy
• AWS SDKs and Tools Version Support Matrix

Supported Minor Versions

• 1.12.x - Recommended.

• 1.11.x - No longer supported, but migration to 1.12.x should require no code changes.

AWS SDK for Java 2.x

A version 2.x of the SDK is generally available. It is a major rewrite of the 1.x code base, built on top of Java 8+ and adds several frequently requested features. These include support for non-blocking I/O, improved start-up performance, automatic iteration over paginated responses and the ability to plug in a different HTTP implementation at run time.

For more information see the AWS SDK for Java 2.x Developer Guide or check the project repository in https://github.com/aws/aws-sdk-java-v2.

Maintenance and Support for Java Versions

The AWS Java SDK version 1 (v1) supports Java versions from 7 to 16. The Java 17 version introduces strong encapsulation of internal Java elements, which is not backwards-compatible with the Java SDK v1. This may cause issues for certain use-cases of the SDK. If you plan to use Java 17+, we recommend that you migrate to AWS SDK for Java 2.x that fully supports Java 8, Java 11, and Java 17 Long-Term Support(LTS) releases.

If you are experiencing issues with Java 17+ and unable to migrate to AWS SDK for Java v2 at this time, below are the workarounds that you might find helpful. Please keep in mind that these workarounds may not work in the future versions of Java. See JEP 403: Strongly Encapsulate JDK Internals and Breaking Encapsulation for more details.

Error: com.amazonaws.AmazonServiceException: Unable to unmarshall exception response with the unmarshallers provided caused by java.lang. reflect.InaccessibleObjectException

• use JVM option --add-opens java.base/java.lang=ALL-UNNAMED at JVM startup

WARNING: Illegal reflective access by com.amazonaws.util.XpathUtils

• use JVM option --add-opens=java.xml/com.sun.org.apache.xpath.internal=ALL-UNNAMED at JVM startup