Skip to content

README.md

Latest commit

 

History

History
127 lines (85 loc) · 4.43 KB

README.md

File metadata and controls

127 lines (85 loc) · 4.43 KB
Raw

AWS SDK for Python code examples

Overview

The code examples in this topic show you how to use the AWS SDK for Python with AWS.

The AWS SDK for Python provides a Python API for AWS infrastructure services. Using the SDK, you can build applications on top of AWS services such as Amazon Transcribe Streaming, Amazon Bedrock Runtime, and Amazon DynamoDB.

Note: Examples for AWS SDK for Python (Boto3) are in the python directory of this repo.

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.

Finding code examples

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

⚠️ 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.

Run the examples

Prerequisites

Install packages

Depending on how you have Python installed and on your operating system, the commands to install and run might vary slightly. For example, on Windows, use py in place of python.

Each example folder contains a requirements.txt file that defines the packages needed to run that example. To install the required packages, first navigate to the example folder and create a virtual environment by running the following:

python -m venv .venv

This creates a virtual environment folder named .venv. Each virtual environment contains an independent set of Python packages. Activate the virtual environment by running one of the following:

.venv\Scripts\activate # Windows
source .venv/bin/activate # Linux, macOS, or Unix

Install the packages for the example by running the following:

python -m pip install -r requirements.txt

This installs all the packages listed in the requirements.txt file in the current folder.

Run the code

Most examples have one or more files that contain a __main__ runner. Each of these files can be run from the command line:

python file_with_main.py

Some examples require command line arguments. In these cases, you can run the example with a -h flag to get help. Each example has a README.md that describes additional specifics about how to run the example and any other prerequisites.

Tests

All tests use Pytest, and you can find them in the test folder for each example. When an example has additional requirements to run tests, you can find them in the README for that service or cross-service example.

Unit tests

Run unit tests in the folder for each service or cross-service example at a command prompt by excluding the integ mark.

python -m pytest -m "not integ"

Integration tests

⚠️ Running the integration tests might result in charges to your AWS account.

The integration tests in this module make actual requests to AWS. This means that when the integration tests are run, they can create and destroy resources in your account. These tests might also incur charges. Proceed with caution.

Run integration tests in the folder for each service or cross-service example at a command prompt by including the integ mark.

python -m pytest -m "integ"

Additional resources

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: Apache-2.0