Repository files navigation

TheAWS SDK for Java 2.0 is a rewrite of 1.0 with some great new features. As with version 1.0,it enables you to easily work withAmazon Web Services but also includes features likenon-blocking IO and pluggable HTTP implementation to further customize your applications. You canget started in minutes usingMaven or any build system that supports MavenCentral as anartifact source.

• SDK Homepage
• 1.11 to 2.0 Changelog
• Best Practices
• Sample Code
• API Docs
• Developer Guide (source)
• Maven Archetypes
• Issues
• SDK Blog
• Giving Feedback

Before you begin, you need an AWS account. Please see theSign Up for AWS section ofthe developer guide for information about how to create an AWS account and retrieve your AWScredentials.

To run the SDK you will needJava 1.8+. For more information about the requirements and optimumsettings for the SDK, please see theInstalling a Java Development Environmentsection of the developer guide.

The recommended way to use the AWS SDK for Java in your project is to consume it from Maven Central.

To automatically manage module versions (currently all modules have the same version, but this may not always be the case) we recommend you use theBill of Materials import as follows:

<dependencyManagement>  <dependencies>    <dependency>      <groupId>software.amazon.awssdk</groupId>      <artifactId>bom</artifactId>      <version>2.38.0</version>      <type>pom</type>      <scope>import</scope>    </dependency>  </dependencies></dependencyManagement>

Then individual modules may omit theversion from their dependency statement:

<dependencies>  <dependency>    <groupId>software.amazon.awssdk</groupId>    <artifactId>ec2</artifactId>  </dependency>  <dependency>    <groupId>software.amazon.awssdk</groupId>    <artifactId>s3</artifactId>  </dependency>  <dependency>    <groupId>software.amazon.awssdk</groupId>    <artifactId>dynamodb</artifactId>  </dependency></dependencies>

Alternatively you can add dependencies for the specific services you use only:

<dependency>  <groupId>software.amazon.awssdk</groupId>  <artifactId>ec2</artifactId>  <version>2.38.0</version></dependency><dependency>  <groupId>software.amazon.awssdk</groupId>  <artifactId>s3</artifactId>  <version>2.38.0</version></dependency>

You can import the whole SDK into your project (includesALL services). Please note that it is recommended to only import the modules you need.

<dependency>  <groupId>software.amazon.awssdk</groupId>  <artifactId>aws-sdk-java</artifactId>  <version>2.38.0</version></dependency>

See theSet up the AWS SDK for Java section of the developer guide for more usage information.

• Provides a way to plug in your own HTTP implementation.

• Provides first class support for non-blocking IO in Async clients.

Once you check out the code from GitHub, you can build it using the following commands.

Linux:

./mvnw clean install# Skip tests, checkstyles, findbugs, etc for quick build./mvnw clean install -P quick# Build a specific service module./mvnw clean install -pl :s3 -P quick --am

Windows:

./mvnw.cmd clean install

You can find sample code for v2 in the following places:

• aws-doc-sdk-examples repo.
• Integration tests in this repo. They are located in theit directory under each service module, eg:s3-integration-tests

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

We maintain full support on Long-Term Support(LTS) releases: Java 8, Java 11, Java 17, and Java 21. Note that theremay be individual features in newer releases that are not supported, because the SDK must be compatible with Java 8.

We need your help in making this SDK great. Please participate in the community and contribute to this effort by submitting issues, participating in discussion forums and submitting pull requests through the following channels:

• Submitissues - this is thepreferred channel to interact with our team
• Articulate your feature request or upvote existing ones on ourIssues page

Thanks goes to these wonderful people (emoji key):

sullis 💻	Austin Brooks 💻	Konrad `ktoso` Malawski 💻	Andrew Hopkins 💻	Adam Thomas 💻	Steven Swor 💻	Carey Burgess 💻
Anuraag Agrawal 💻	jeffalder 💻	Boris 💻	Guillaume Corré 💻	Henri Yandell 💻	Ryan Schmitt 💻	Somaya 💻
Steven Aerts 💻	Steven Wong 💻	Tomasz Elendt 💻	Will Erickson 💻	Julien Hoarau 💻	SEOKHYOENCHOI 💻	adriannistor 💻
Xian Sun 💻	Andreas Scheja 💻	Anton Egorov 💻	roexber 💻	brharrington 💻	Christopher Radek 💻	Foivos 💻
Frank Wesemann 💻	Gergely Varga 💻	Guillermo 💻	Henry Heikkinen 💻	Jochen Schalanda 💻	Joe Barnett 💻	Kazuhiro Sera 💻
Krishna Chaithanya Ganta 💻	Lee Packham 💻	Matteo Carrara 💻	Michael Scharp 💻	Miguel Jimenez 💻	Russell Bolles 💻	Russell Scheerer 💻
Scott 💻	Shin'ya Ueoka 💻	sushilamazon 💻	tomliu4uber 💻	Vladimir Orany 💻	Xinyu Hu 💻	Yosef Fertel 💻
Denys Konakhevych 💻	Alex Weibel 💻	Ryan Carper 💻	Jonathan M. Henson 💻	Debora N. Ito 💻	Bret Ambrose 💻	Anna-Karin Salander 💻
John Viegas 💻	Dongie Agnir 💻	Matthew Miller 💻	Benjamin Maizels 💻	Quan Zhou 💻	Zoe Wang 💻	Varun Nandi 💻
Andrew Shore 💻	Kyle Thomson 💻	Sam Fink 💻	Jonathan Bond 💻	ajs139 💻	Dewey Nguyen 💻	David Leen 💻
Michael Li 💻	Bennett Lynch 💻	Ikko Ashimine 📖	Jamie Liu 📖	guillepb10 💻	Lorenz Nickel 📖	Erin Yang 💻
Roberto Tyley 💻	Alvin See 💻	ron1 💻	Sai Kumar Reddy Chandupatla 💻	David Ho 💻	Thomas Turrell-Croft 💻	Steven Shan 💻
Barry O'Neill 💻	Andy Kiesler 💻	Martin 💻	Paulo Lieuthier 💻	Sébastien Crocquesel 💻	David Negrete 💻	Stephen Flavin 💻
Olivier L Applin 💻	Adrian Chlebosz 💻	Chad Wilson 💻	Manish Dait 📖	Dennis Kieselhorst 💻	Nilesh PS 💻	Steven Swartz 💻
Michael Dimchuk 💻	Nikita Sokolov 💻	Manuel Sugawara 💻	Anirudh 💻	Hayden Baker 💻	Jaykumar Gosar 💻	Michael Graeb 💻
Michael Grundie 💻	Eckard Mühlich 💻	Tobias Soloschenko 💻	Luis Madrigal 📖	Kirill Chaykin 💻	prateek-vats 💻	Bole1155 💻
Thomas Farr 💻	Saranya Somepalli 💻	Ran Vaknin 💻	Greg Oledzki 💻	Kevin Stich 💻	Jency Joseph 💻	Drew Davis 💻
Merlin Bögershausen 💻

This project follows theall-contributors specification. Contributions of any kind welcome!