Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/aws/aws-sdk-java-v2

The official AWS SDK for Java - Version 2
https://github.com/aws/aws-sdk-java-v2
amazon aws aws-sdk hacktoberfest java
Last synced: about 17 hours ago
JSON representation
The official AWS SDK for Java - Version 2
Host: GitHub
URL: https://github.com/aws/aws-sdk-java-v2
Owner: aws
License: apache-2.0
Created: 2017-06-23T18:56:01.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2025-01-18T01:52:33.000Z (3 days ago)
Last Synced: 2025-01-19T09:09:39.295Z (2 days ago)
Topics: amazon, aws, aws-sdk, hacktoberfest, java
Language: Java
Homepage:
Size: 540 MB
Stars: 2,236
Watchers: 93
Forks: 864
Open Issues: 409
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project

README

        # AWS SDK for Java 2.0

![Build Status](https://codebuild.us-west-2.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiTFJSRXBBN1hkU1ZEQzZ4M1hoaWlFUExuNER3WjNpVllSQ09Qam1YdFlTSDNTd3RpZzNia3F0VkJRUTBwZlQwR1BEelpSV2dWVnp4YTBCOFZKRzRUR004PSIsIml2UGFyYW1ldGVyU3BlYyI6ImdHdEp1UHhKckpDRmhmQU4iLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master)

[![Maven](https://img.shields.io/maven-central/v/software.amazon.awssdk/s3.svg?label=Maven)](https://search.maven.org/search?q=g:%22software.amazon.awssdk%22%20AND%20a:%22s3%22)

[![codecov](https://codecov.io/gh/aws/aws-sdk-java-v2/branch/master/graph/badge.svg)](https://codecov.io/gh/aws/aws-sdk-java-v2)

[![All Contributors](https://img.shields.io/badge/all_contributors-112-orange.svg?style=flat-square)](#contributors-)

The **AWS 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 with [Amazon Web Services][aws] but also includes features like

non-blocking IO and pluggable HTTP implementation to further customize your applications. You can

get started in minutes using ***Maven*** or any build system that supports MavenCentral as an

artifact source.

* [SDK Homepage][sdk-website]

* [1.11 to 2.0 Changelog](docs/LaunchChangelog.md)

* [Best Practices](docs/BestPractices.md)

* [Sample Code](#sample-code)

* [API Docs][docs-api]

* [Developer Guide][docs-guide] ([source][docs-guide-source])

* [Maven Archetypes](archetypes/README.md)

* [Issues][sdk-issues]

* [SDK Blog][blog]

* [Giving Feedback](#giving-feedback)

## Getting Started

#### Sign up for AWS ####

Before you begin, you need an AWS account. Please see the [Sign Up for AWS][docs-signup] 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.8+**. For more information about the requirements and optimum

settings for the SDK, please see the [Installing a Java Development Environment][docs-java-env]

section of the developer guide.

## Using the SDK

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

#### Importing the BOM ####

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

```xml

  

    

      software.amazon.awssdk

      bom

      2.30.2

      pom

      import

    

  

```

Then individual modules may omit the `version` from their dependency statement:

```xml

  

    software.amazon.awssdk

    ec2

  

  

    software.amazon.awssdk

    s3

  

  

    software.amazon.awssdk

    dynamodb

  

```

#### Individual Services ####

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

```xml

  software.amazon.awssdk

  ec2

  2.30.2

  software.amazon.awssdk

  s3

  2.30.2

```

#### Whole SDK ####

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

```xml

  software.amazon.awssdk

  aws-sdk-java

  2.30.2

```

See the [Set up the AWS SDK for Java][docs-setup] section of the developer guide for more usage information.

## New Features for 2.0

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

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

## Building From Source

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

Linux:

```sh

./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:

```sh

./mvnw.cmd clean install

```

## Sample Code

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 the `it` directory under each service module, eg: [s3-integration-tests]

## 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][maintenance-policy]

* [AWS SDKs and Tools Version Support Matrix][version-matrix]

## Maintenance and Support for Java Versions

We maintain full support on Long-Term Support(LTS) releases: Java 8, Java 11, Java 17, and Java 21. Note that there 

may be individual features in newer releases that are not supported, because the SDK must be compatible with Java 8.

## Giving Feedback

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:

* Submit [issues][sdk-issues] - this is the **preferred** channel to interact with our team

* Articulate your feature request or upvote existing ones on our [Issues][features] page

[aws-iam-credentials]: http://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/java-dg-roles.html

[aws]: http://aws.amazon.com/

[blog]: https://aws.amazon.com/blogs/developer/category/java/

[docs-api]: https://sdk.amazonaws.com/java/api/latest/overview-summary.html

[docs-guide]: http://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/welcome.html

[docs-guide-source]: https://github.com/awsdocs/aws-java-developer-guide-v2

[docs-java-env]: http://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/setup-install.html##java-dg-java-env

[docs-signup]: http://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/signup-create-iam-user.html

[docs-setup]: http://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/setup-install.html

[sdk-issues]: https://github.com/aws/aws-sdk-java-v2/issues

[sdk-license]: http://aws.amazon.com/apache2.0/

[sdk-website]: http://aws.amazon.com/sdkforjava

[aws-java-sdk-bom]: https://github.com/aws/aws-sdk-java-v2/tree/master/bom

[stack-overflow]: http://stackoverflow.com/questions/tagged/aws-java-sdk

[features]: https://github.com/aws/aws-sdk-java-v2/issues?q=is%3Aopen+is%3Aissue+label%3A%22feature-request%22

[support-center]: https://console.aws.amazon.com/support/

[console]: https://console.aws.amazon.com

[bom]: http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22software.amazon.awssdk%22%20AND%20a%3A%22bom%22

[aws-doc-sdk-examples]: https://github.com/awsdocs/aws-doc-sdk-examples/tree/master/javav2

[s3-integration-tests]: https://github.com/aws/aws-sdk-java-v2/tree/master/services/s3/src/it/java/software/amazon/awssdk/services/s3

[maintenance-policy]: https://docs.aws.amazon.com/credref/latest/refdocs/maint-policy.html

[version-matrix]: https://docs.aws.amazon.com/credref/latest/refdocs/version-support-matrix.html

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/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}
💻

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!