About this project

This repository is maintained by AWS and collects code examples showing how to use the AWS SDKs to interact with AWS services. Many of the examples are injected directly into the official AWS documentation and SDK developer guides. Organization is by language and SDK version. Each language has its own subdirectory, and some languages have separate folders for older and newer SDK generations: - .NET: dotnetv3 (SDK 3.5+) and dotnet (below 3.5) - C++: cpp (SDK 1) - Go: gov2 (SDK 2) and go (SDK 1) - Java: javav2 (SDK 2) and java (SDK 1) - JavaScript: javascriptv3 (SDK 3) and javascript (SDK 2) - Kotlin: kotlin (SDK 1) - PHP: php (SDK 3) - Python: pythonv4 (SDK 4) and python (SDK 3) - Ruby: ruby (SDK 3) - Rust: rustv1 (SDK 1) - Swift: swift (preview) Each directory contains SDK-specific instructions for understanding and running the examples. The README notes that the AWS SDK for Java v1.x entered maintenance mode on July 31, 2024 and reaches end-of-support on December 31, 2025. Beyond per-language folders, there are additional directories: - applications: non-language-specific components of example applications that show SDK usage in production-like scenarios. Language-specific parts live in each language's cross-service folder. - test: components supporting a custom test automation framework that routinely tests repository code, deployed to AWS as a polyglot container-based integration testing solution. The README marks this as still under active construction as of 2023. - resources: shared components used by many examples, deployed as frontend clients or backend CDK/CloudFormation components. Running the examples requires an AWS account and configured AWS credentials, for example via the AWS CLI. The README includes a usage disclaimer: examples interact with services that may incur charges, and may create or delete AWS resources. It advises users to be aware of created or deleted resources, potential costs, and to back up important data. Contributions are welcomed through the CONTRIBUTING.md guide. Example requests can be filed via the issue tracker using an enhancement template. The team evaluates requests for clarity, relevance and feasibility, and asks that requests be made as early as possible, ideally at least two months ahead for larger examples. Bug fixes and security issues take priority over new examples, and an accompanying high-quality pull request improves the chance a request is addressed. The README also mentions "tributaries": additional sources whose code examples flow into AWS documentation, including this repository, aws-samples/serverless-snippets, and aws/aws-tools-for-powershell. Licensing: content is copyright Amazon Web Services, Inc. or its affiliates. Unless otherwise noted, examples are licensed under Apache License 2.0, with the full text in the LICENSE file. The README asks contributors to include a copyright and SPDX-License-Identifier: Apache-2.0 comment at the top of files where possible.