AWS SDK for Java (v2) code examples

To build and run these AWS SDK for Java (v2) code examples, you need the following:

Local access to this repository by cloning, forking, or downloading a zip file.
An installation of Apache Maven (>3.0)
All Java (v2) examples assume that the Java SDK can obtain AWS credentials using its default credentials provider chain.
- You can set up the default profile in the shared AWS configuration files:
  - with IAM Identity Center SSO settings in ~/.aws/config
  - temporary credentials in ~/.aws/credentials
Default Region configuration. You can set this in your default profile along with settings for access to AWS credentials. If a Region is not set, the default Region used is us-east-1.

Note: For more information about configuring access to your AWS credentials, see Supplying and retrieving AWS credentials.

AWS SDK for Java

The javav2 folder in this repository contains examples of complete use cases, and AWS service-based code examples.

Each use case example and service-based code example directory includes an Apache Maven pom.xml file with dependency and configuration settings for that example.

Use cases

In the usecases folder, find step-by-step development tutorials that use multiple AWS services. By following these tutorials, you will gain a deeper understanding of how to create Java-based applications that use the AWS SDK for Java. Most of these AWS SDK for Java tutorials use synchronous Java clients.

If you are interested in using asynchronous Java service clients, see one of these tutorials:

Creating a Feedback Sentiment Analyzer application using the SDK for Java - Discusses how to develop a Feedback Sentiment Analyzer application using Machine Learning AWS services. The application solves a fictitious use case of a hotel that receives guest feedback on comment cards in a variety of languages. The application is developed by using the AWS SDK for Java (v2) and asynchronous Java clients.
Creating a dynamic web application that asynchronously analyzes photos using the AWS SDK for Java - Discusses using the AWS SDK for Java (asynchronous client) and various AWS services, such as the Amazon Rekognition service, to analyze images. This web MVC application can analyze many images and generate a report that breaks down each image into a series of labels.
Creating an asynchronous publish/subscription web application that translates messages using the AWS SDK for Java - Discusses how to create a web MVC application that has subscription and publish functionality. In this tutorial, the Spring Framework is used with the AWS SDK for Java asynchronous client for Amazon Simple Notification Service (Amazon SNS).

The following tutorials use the synchronous Java client to build sample relational and non-relational database applications:

Creating your first AWS Java web application - Discusses using Amazon DynamoDB, Amazon Simple Notification Service (Amazon SNS), and AWS Elastic Beanstalk to create a web application.
Creating a React and Spring REST application that queries Amazon Redshift data - Discusses how to develop a Spring REST API that queries Amazon Redshift data. The Spring REST API uses the AWS SDK for Java to invoke AWS services and is used by a React application that displays the data.
Creating a React and Spring REST application that queries Amazon Aurora Serverless data - Discusses how to develop a Spring REST API that queries Amazon Aurora Serverless data. The Spring REST API uses the AWS SDK for Java to invoke AWS services and is used by a React application that displays the data.
Creating a React and Spring REST application that queries Amazon RDS for MySQL - Discusses how to develop a Spring REST API that queries Amazon Relational Database Service (Amazon RDS) MySQL data. The Spring REST API uses the Java JDBC API to query MySQL data that is used by a React application that displays the data.
Creating a React and Spring REST application that queries Amazon DynamoDB data - Discusses how to develop a Spring REST API that queries Amazon DynamoDB data. The Spring REST API uses the AWS SDK for Java to invoke AWS services and is used by a React application that displays the data.

The following tutorials use the synchronous Java client to build sample applications:

Creating a dynamic web application that analyzes photos using the AWS SDK for Java - Discusses using the AWS SDK for Java and various AWS services, such as Amazon Rekognition, to analyze images. This web MVC applicatio analyzes many images and generate a report that breaks down each image into a series of labels.
Creating a Spring Boot Application that has publish/subscription functionality - Discusses how to create a web MVC application that has subscription and publish functionality. In this tutorial, the application is created using the Spring Framework with the AWS SDK for Java API for Amazon SNS.
Creating an Amazon Simple Queue Service message application - Discusses using the AWS SDK for Java and the Amazon Simple Queue Service (Amazon SQS) to create a basic messaging web application.
Building a Spring Boot web application that Streams Amazon S3 content over HTTP - Discusses how to create a web MVC application that streams Amazon Simple Storage Service (Amazon S3) video content over HTTP. The video is displayed in the application’s view. In this tutorial, the Spring Framework is used with the AWS SDK for Java API to create the application.
Using Amazon Cognito to require a user to log into a web application - Discusses how to use Amazon Cognito to require a web MVC application to authenticate with users defined in an Amazon Cognito user pool.
Building an Amazon Lex chatbot that handles multiple languages - Discusses how to create an Amazon Lex chatbot within a web application to engage your website visitors. In addition, this chatbot supports multiple languages that lets users interact with the chatbot in the languages of their choice (for example, French).
Create an Amazon personalize app with the AWS SDK for Java - Discusses how to complete the Amazon personalize workflow from start to finish with the AWS SDK for Java. The project trains two different models with the movie-lens dataset: one with the user-personalization (aws-user-personalization) recipe for creating personalized recommendations for your users, and one with the item-to-item similarities (aws-sims) recipe to generate recommendations for items that are similar to a given item.

The following tutorials are AWS Lambda use cases:

Creating a photo asset management application using the AWS SDK for Java - Discusses how to develop a photo asset management application that lets users manage photos using labels. This serverless application uses many AWS services.
Creating AWS serverless workflows using the AWS SDK for Java - Discusses using the AWS SDK for Java and AWS Step Functions to create a workflow that invokes AWS services. Each workflow step is implemented by using an AWS Lambda function.
Building an AWS Workflow that sends notifications over multiple channels - Discusses how to develop an AWS serverless workflow that sends notifications over multiple channels. In this AWS tutorial, you create an AWS serverless workflow by using AWS Step Functions, the AWS SDK for Java, and Lambda functions. Each workflow step is implemented by using an AWS Lambda function.
Creating an AWS serverless workflow that modifies Amazon Redshift data by using the AWS SDK for Java - Discusses how to develop a workflow using AWS Step Functions that can modify Amazon Redshift data using the AWS SDK for Java.
Creating an ETL workflow by using AWS Step Functions and the AWS SDK for Java - Discusses how to develop an AWS serverless workflow that performs an Extract, Transform, and Load (ETL) job. In this AWS tutorial, you create an AWS serverless workflow by using AWS Step Functions, the AWS SDK for Java, and Lambda functions. Each workflow step is implemented by using an AWS Lambda function.
Creating scheduled events to invoke Lambda functions - Discusses how to create a scheduled event that invokes an AWS Lambda function by using Amazon CloudWatch Events. In addition, the AWS Lambda function is created by using the AWS Lambda Java runtime API and invokes multiple AWS services to perform a specific use case.
Creating an Amazon Web Services Lambda function that detects images with Personal Protective Equipment - Discusses how to create a Lambda function that detects personal protective equipment (PPE) in digital assets located in an Amazon S3 bucket. The Lambda function updates an Amazon DynamoDB table with the results and sends an email message.
Building an AWS workflow that sends notifications over multiple channels - Discusses how to develop an AWS serverless workflow that sends notifications over multiple channels. In this AWS tutorial, you create an AWS serverless workflow by using AWS Step Functions, the AWS SDK for Java, and Lambda functions. Each workflow step is implemented by using an AWS Lambda function.
Creating Lambda functions that tags digital assets located in Amazon S3 buckets - Discusses how to create a Lambda function that automatically tags digital assets located in an Amazon Simple Storage Service (Amazon S3) bucket.

If you want to learn how to monitor the performance of an Amazon DynamoDB application in Amazon CloudWatch, see

Monitor performance of a DynamoDB application

AWS service examples

The AWS service-specific Java examples are located in the example_code folder. The examples are divided into directories by AWS service (s3, sqs, and so on). Within each, you'll find a pom.xml file used for building the examples with Maven.

Build and run the service examples

Build the examples using Apache Maven or Gradle

To run these examples, you can setup your development environment to use Apache Maven or Gradle to configure and build AWS SDK for Java projects. For more information,
see "Get started with the AWS SDK for Java 2.x" located at https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html.

Note: Add the POM file you find in a service-specific folder to the POM file in the project. Then create a package that you find in the examples and you can start adding the Java classes to your project.

Build the examples from the command line

To build any of the service examples, open a command-prompt (terminal) window and change to the directory containing the examples you want to build or run. Then type::

mvn package

You can use the Apache Maven Shade Plugin to package your JAR file with the artifacts in an uber JAR, which consists of all dependencies required to run the project. Ensure that the POM file has the required plugin to build the JAR with the dependencies.

<plugin>
   <groupId>org.apache.maven.plugins</groupId>

   <artifactId>maven-shade-plugin</artifactId>

   <version>3.0.0</version>

   <executions>

   <execution>

   <phase>package</phase>

   <goals>

   <goal>shade</goal>

   </goals>

   </execution>

   </executions>

   </plugin>

For example, if you execute this command from the s3 directory, you will find a JAR file named S3J2Project-1.0-SNAPSHOT.jar in the target folder.

Or, if you have make, you can begin the build process by typing::

make

Maven will download any dependencies (such as components of the AWS SDK for Java) that it needs for building.

Once the examples are built, you can run them to see them in action.

.. note:: If you are running on a platform with make, you can also use the provided Makefiles to build the examples, by running make in any directory with a Makefile present. You must still have Maven installed, however (the Makefile wraps Maven commands).

Run the service examples

IMPORTANT

The examples perform AWS operations for the account and AWS Region for which you've specified credentials, and you may incur AWS service charges by running them. See the AWS Pricing <https://aws.amazon.com/pricing/>_ page for details about the charges you can expect for a given service and operation.

Some of these examples perform destructive operations on AWS resources, such as deleting an Amazon S3 bucket or an Amazon DynamoDB table. Be very careful when running an operation that may delete or modify AWS resources in your account. It's best to create separate test-only resources when experimenting with these examples.

Because you built the JAR file that contains the dependencies, you can run an example using the following command. For example, you can run an S3 Java V2 example using this command:

      java -cp target/S3J2Project-1.0-SNAPSHOT.jar com.example.s3.ListObjects mybucket

Tests

You can test the Java code examples for a given AWS service by running a test file located in this GitHub repository. The test file uses JUnit 5 to run the JUnit tests. It's located in the src/test/java folder. For more information, see https://junit.org/junit5/.

You can run the JUnit tests from a Java IDE, such as IntelliJ, or from the command line by using Maven. As each test runs, you can view messages that inform you if the various tests succeed or fail. For example, the following message informs you that Test 3 passed.

To run the JUnit tests from the command line, you can use the following command.

	mvn test

You will see output from the JUnit tests, with an example shown here.

[INFO] -------------------------------------------------------
[INFO]  T E S T S
[INFO] -------------------------------------------------------
[INFO] Running AmazonTranslateTest
Test 1 passed
Test 2 passed
...
Done!
[INFO] Results:
[INFO]
[INFO] Tests run: 5, Failures: 0, Errors: 0, Skipped: 0
[INFO]
[INFO] --------------------------------------------
[INFO] BUILD SUCCESS
[INFO]--------------------------------------------
[INFO] Total time:  12.003 s
[INFO] Finished at: 2020-02-10T14:25:08-05:00
[INFO] --------------------------------------------

WARNING: Running these JUnit tests manipulates real Amazon resources and might incur charges on your account.

Properties file

Before running the JUnit tests, you must define required values in the config.properties file that's located in the resources folder. To learn what the values represent, you can refer to the Java code examples. For example, if you are running Amazon S3 tests, look in the various Amazon S3 code example Java files for an explanation of the values.

Docker image (Beta)

This example code will soon be available in a container image hosted on Amazon Elastic Container Registry (ECR). This image will be pre-loaded with all Java v2 examples with dependencies pre-resolved, allowing you to explore these examples in an isolated environment.

⚠️ As of January 2023, the SDK for Java v2 image is available on ECR Public but is still undergoing active development. Refer to this GitHub issue for more information.