Skip to content

Latest commit

 

History

History

python

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
cross_service
cross_service
 
 
demo_tools
demo_tools
 
 
example_code
example_code
 
 
test_tools
test_tools
 
 
.gitignore
.gitignore
 
 
Dockerfile
Dockerfile
 
 
README.md
README.md
 
 

README.md

AWS SDK for Python code examples

Overview

The code examples in this topic show you how to use the AWS SDK for Python (Boto3) 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 Simple Storage Service (Amazon S3), Amazon Elastic Compute Cloud (Amazon EC2), and Amazon DynamoDB.

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.

Cross-service examples are located in the cross_service 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.

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.

Linting and formatting

We rely on pylint and black to keep this code consistently formatted and styled. To contribute Python code to this project, please refer to the following installation and usage steps.

Using Pylint

We run Pylint using a custom configuration file against any changed file or directory. See the Python Github Action workflow for details.

To invoke Pylint yourself, first install it with pip install pylint.

Next, run:

pylint --rcfile=.github/linters/.python-lint path/to/python/file_or_directory

To lint all Python files in the current directory and its subdirectories, run:

pylint --rcfile=.github/linters/.python-lint .

Using Black

We run Black against any changed file or directory. See the Python Github Action workflow for details.

To invoke Black yourself, first install it with pip install black.

Next, run:

black path/to/python/file_or_directory

To format all Python files in the current directory and its subdirectories, run:

black .

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

The unit tests in this module use stubbed responses from the botocore Stubber. This means that when the unit tests are run, requests are not sent to AWS, mocked responses are returned, and no charges are incurred on your account.

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"

Docker image

This example code is available in a container image hosted on Amazon Elastic Container Registry (Amazon ECR). The image is preloaded with all Python examples, with dependencies pre-resolved. That way, you can explore the examples in an isolated environment.

See SDK for Python image for more information.

Build the Docker image

  1. Install and run Docker on your machine.
  2. Navigate to the same directory as this README.
  3. Run docker build -t <image_name> . and replace image_name with a name for the image.

Launch the Docker container

Run the Docker container with your image with the following command:

Windows

docker run -it --volume <user root>\.aws:/root/.aws <image_name>

macOS or Linux

docker run -it -v ~/.aws/credentials:/root/.aws/credentials <image_name>

The terminal initiates a bash instance at the root of the container. The Python code examples are in the python folder and can be run by following the instructions in the READMEs in the various folders.

Run tests in the Docker container

You can run all unit tests and write the output to a file by running the following command at the root of the container:

python -m python.test_tools.run_all_tests > test-run-$(date +"%Y-%m-%d").out

You can run integration tests by passing a -m "integ" flag to the run_all_tests module. Integration tests create and destroy AWS resources and will incur charges on your account. Proceed with caution.

Additional resources

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

SPDX-License-Identifier: Apache-2.0