.. Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License (the "License"). You may not use this file except in compliance with the License. A copy of the License is located at http://creativecommons.org/licenses/by-nc-sa/4.0/.
This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
This is the repository for various code examples used in the public
AWS documentation <https://docs.aws.amazon.com>. For more information, see
Tools to Build on AWS <https://aws.amazon.com/getting-started/tools-sdks/>.
The code examples are organized by AWS SDK or AWS programming tool. For example, among the top-level folders:
Code examples for older AWS SDK versions will be archived in this repository but no longer maintained. These include:
As AWS SDK major version numbers increment, this repository will begin to more consistently reflect their version numbers among these folders to make these distinctions clearer. For example, if and when the AWS SDK for Ruby moves to a version 4, a new rubyv4 folder will be added. Then when AWS officially announces that AWS SDK for Ruby version 3 has been deprecated, the ruby folder will be deleted.
Other top-level folders include:
Note that the scripts folder contains scripts that the AWS documentation team uses internally to build the code examples into various AWS documentation sets.
Inside each language-specific directory, we include a README file that explains how to build and run the examples in the directory.
The example code in the language-specific directories is organized by
the AWS service command in the
AWS Command Line Interface (AWS CLI) Command Reference <https://awscli.amazonaws.com/v2/documentation/api/latest/index.html>_ (s3 for
Amazon S3 <https://aws.amazon.com/s3>_ examples, and so
To propose a new code example for the AWS documentation team to consider working on,
create a request <https://github.com/awsdocs/aws-doc-sdk-examples/issues/new?assignees=&labels=code+sample+request&template=request-new-code-example.md&title=%5BNEW+EXAMPLE+REQUEST%5D+%3C%3CProvide+a+title+for+this+proposal%3E%3E>_.
Note that the AWS documentation team prefers to produce code examples that cover broader scenarios and use cases, versus simple code snippets that cover only individual API calls.
If you plan to contribute examples for use in the documentation (the purpose of this repository),
read this section carefully so that we can work together effectively.
For process instructions and additional guidance, see the
Guidelines for contributing <CONTRIBUTING.md>_.
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 <https://www.apache.org/licenses/LICENSE-2.0>_ (the "License"). The full
license text is provided in the
LICENSE file accompanying this repository.