Skip to content

Language level README template

Liz Kellebrew-Davies edited this page Aug 10, 2022 · 5 revisions

[Example](link to example) <-- Delete this sentence from template

AWS SDK for [language] [version] code examples

Overview

The code examples in this topic show you how to use the AWS SDK for [language] [version] with AWS.

The AWS SDK for [language] [version] provides a [language] API for AWS infrastructure services. Using the SDK, you can build applications on top of Amazon S3, Amazon EC2, Amazon DynamoDB, and more.

Types of code examples

  • Single-service actions - Code examples that show you how to call individual service functions.

  • Single-service scenarios - Code examples that show you how to accomplish a specific task by calling multiple functions within the same service.

  • Cross-service examples - Sample applications that work across multiple AWS services.

Find code examples

Single-service actions and scenarios are organized by AWS service in the [example_code folder](link to example folder). A README in each folder lists and describes how to run the examples.

Cross-service examples are located in the [cross-services folder](link to cross-services folder). A README in each folder describes how to run the example.

⚠️ Important

  • Running this code might result in charges to your AWS account.
  • Running the tests might result in charges to your AWS account.
  • We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see Grant least privilege.
  • This code is not tested in every AWS Region. For more information, see AWS Regional Services.

Prerequisites

List prerequisites that apply to all examples. <-- Delete this sentence from template

Tests

Note: Running the tests might result in charges to your AWS account.

A description of how to run the unit tests, and a note to see the service level/cross-service level for specific instructions. <-- Delete this sentence from template

Additional resources

  • [SDK API reference guide](link to API reference guide)

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

Clone this wiki locally