aws-doc-sdk-examples README

The project's README from github.com/awsdocs/aws-doc-sdk-examples. As one markdown file: README.md.

Build Status GitHub Super-Linter []

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 pythonv1/ 1
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:

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:

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.

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.

Please include the following licensing text as a comment at top of all possible files:

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

aws-doc-sdk-examples (awsdocs/aws-doc-sdk-examples)

Searching Database…

10.5K ·GitHub
Aws-doc-sdk-examples
What is this?The official AWS repository of code examples showing how to use the AWS SDKs to work with AWS services. Many of these examples are injected straight into the AWS documentation and SDK Developer Guides.
Is this one big dump of snippets, or is it organized?It's organized by language SDK into subdirectories, with a README table mapping each folder to its SDK version: python/ holds SDK 3 examples, javav2/ is Java SDK 2, plus javascriptv3/, dotnetv3/, gov2/, ruby/ and more.
How do I actually run one of these examples?Open the folder for your language, such as python/ or javascriptv3/, and follow its SDK-specific instructions for invoking the example code.
Do I need an AWS account to run these?Yes — an AWS account (the Free Tier is fine to start) plus configured credentials, which the README says to set up with the AWS CLI.
Will running these examples cost me money or touch my existing resources?They can do both: the code calls real AWS services that may incur charges, and examples could theoretically modify or delete existing resources. The README advises knowing what each example creates or deletes and backing up important data.
Who is this for — people learning AWS, or developers who need a quick reference?Both: each example demonstrates the most common uses of the SDK for its language, so the repo works as a learning path and as copy-paste reference material.
Can I copy this code into my own project?Yes, under Apache License 2.0, as long as you keep the copyright comment with the SPDX-License-Identifier at the top of any file you reuse.
Which programming languages does the repo cover?.NET, C++, Go, Java, JavaScript, Kotlin, PHP, Python, Ruby, Rust and Swift each get their own folder, with the README table showing which SDK version each folder targets.
Are there full sample applications, or only small snippets?There are both: an /applications folder holds production-like example applications, and their language-specific parts live in each language's cross-service folder, such as python/cross-service.
Is everything in here still current?Watch the legacy folders: old SDK versions have their own directories (dotnet/, go/, javascript/, pythonv1/), and Java v1 examples reached end-of-support on December 31, 2025. Prefer the v2/v3 folders.
Is the example code actually tested?Yes — a custom test automation framework under /test routinely exercises the examples by deploying them to AWS as a polyglot, container-based integration setup, though the README notes it was still under active construction in 2023.
What are similar projects?hello-algo, CtCI-6th-Edition, telnyx-code-examples, flatbuffers, rust-learning, DesignPatternsPHP, TabNine, awesome-awesomeness
Which topics is it in?examples, aws, ruby, dotnet, php, programming, kotlin, swift, testing, cpp, sdk, learning-resources
Creator
awsdocs
Size
266 MB
Stars
10.5K
Updated
CommitOct 15
Age
10y
Commits · 90 Days