Skip to content

Latest commit

 

History

History
74 lines (46 loc) · 5.95 KB

README.md

File metadata and controls

74 lines (46 loc) · 5.95 KB

AWS SDK for Kotlin code examples

Purpose

These examples demonstrate how to perform AWS service operations using the beta version of the AWS SDK for Kotlin.

Prerequisites

You must have an AWS account, and have configured your default credentials and AWS Region as described in AWS SDK for Kotlin Developer Guide.

Running the code

To run these examples, you can setup your development environment to use Gradle to configure and build AWS SDK for Kotlin projects. For more information, see Get started with the AWS SDK for Kotlin.

See the individual readme files in each service directory for information about specific code examples for that service.

Tests

You can run the JUnit tests from an IDE, such as IntelliJ, or from the command line. 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.

Test 3 passed

Before running the 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. If you do not define all values, the JUnit tests fail.

Usecases

In the usecases folder, find step-by-step development tutorials that use multiple AWS services and the AWS SDK for Kotlin. By following these tutorials, you will gain a deeper understanding of how to create applications that use the AWS SDK for Kotlin. These tutorials include:

Notes

  • We recommend that you grant this code least privilege, or at most the minimum permissions required to perform the task. For more information, see Grant Least Privilege in the AWS Identity and Access Management User Guide.
  • This code has not been tested in all AWS Regions. Some AWS services are available only in specific Regions.
  • Running this code might result in charges to your AWS account.

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 Kotlin examples with dependencies pre-resolved, allowing you to explore these examples in an isolated environment.

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


Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0