aws-doc-sdk-examples

README

AWS SDK Code Examples

This repository contains code examples that demonstrate how to use the AWS SDKs to interact with AWS services.

Many examples are injected into the AWS Documentation.

How this repository is organized

Code examples for each language's SDK can be found within the following subdirectories. The examples here demonstrate the most common uses of the SDK for each language.

SDK	folder	SDK version
.NET	dotnetv3/	3.5+
.NET	dotnet/	<3.5
C++	cpp/	1
Go	gov2/	2
Go	go/	1
Java	javav2/	2
Java	java/	1
JavaScript	javascriptv3/	3
JavaScript	javascript/	2
Kotlin	kotlin/	1
PHP	php/	3
Python	python/	3
Ruby	ruby/	3
Rust	rustv1/	1
Swift	swift/	preview

Within each directory, you will find SDK-specific instructions for understanding and invoking example code.

NOTE

In alignment with our SDKs and Tools Maintenance Policy, the AWS SDK for Java v1.x will enter maintenance mode on July 31, 2024, and reach end-of-support on December 31, 2025.

For more information, see Announcing end-of-support for AWS SDK for Java v1.x.

Additional directories

directory	purpose	usage
/applications	Contains the non-language-specific components of example applications, which show how the SDKs can be used in the context of a production-like application.	To view the language-specific components for each example application, see the cross-service folder in the sub-directory for your desired language (such as python/cross-service).
/test	Contains all components supporting the custom test automation framework used to routinely test the code in this repository.	Deploys to AWS as a polyglot container-based integration testing solution. WARNING: Still under active construction as of 2023.
/resources	Contains shared components used by many code examples across this repository.	Deploys as frontend (/clients) or backend (/cdk or /cfn) components.

Invoke example code

To invoke this example code, you must have an AWS account. For more information about creating an account, see AWS Free Tier.

You must also have AWS credentials configured. For steps on using the AWS Command Line Interface (AWS CLI) to configure credentials, see CLI Configuration basics

⚠️ Usage disclaimer

These code examples interact with services that may incur charges to your AWS account. For more information, see AWS Pricing.

Additionally, example code might theoretically modify or delete existing AWS resources. As a matter of due diligence, do the following:

• Be aware of the resources that these examples create or delete.
• Be aware of the costs that might be charged to your account as a result.
• Back up your important data.

Contributing

This repository thrives on your contributions! ❤️ To get involved, see the CONTRIBUTING.md. 🙏

Requests

Requests for examples can be made via Issue tracker.

How we prioritize contributions and requests

Our team reviews all requests, evaluating them for the following:

• Clarity
• Relevance
• Feasibility

All examples requests should be made as early as possible. For larger examples, this should be at least two months in advance of the required date.

Based on the evaluation, we determine the priority of each request and allocate resources accordingly. We prioritize requests that are clear, relevant, and can be completed in a reasonable amount of time. An accompanying high quality PR increases the chance we can address the request.

Please note that some requests, such as bug fixes and security issues, take priority over new code examples. Additionally, we have finite resources and our own priorities that guide the development of code examples. If you have any questions or would like to contribute, please refer to our contribution guide.

Tributaries

The AWS Documentation includes source code examples from several additional sources. These sources are called tributaries, flowing into the "river" of AWS Documentation.

• awsdocs/aws-doc-sdk-examples
• aws-samples/serverless-snippets
• aws/aws-tools-for-powershell

Copyright and license

All content in this repository, unless otherwise stated, is Copyright © Amazon Web Services, Inc. or its affiliates. All rights reserved.

Except where otherwise noted, all examples in this collection are licensed under the Apache license, version 2.0 (the "License"). The full license text is provided in the LICENSE file accompanying this repository.