Project Links

Meta

Author: Vlad Emelianov

Requires Python: >=3.8

Classifiers

Development Status

5 - Production/Stable

Intended Audience

Developers

Environment

Console

License

OSI Approved :: MIT License

Natural Language

English

Operating System

OS Independent

Programming Language

Python :: 3
Python :: 3.8
Python :: 3.9
Python :: 3.10
Python :: 3.11
Python :: 3.12
Python :: 3.13
Python :: 3.14
Python :: 3 :: Only
Python :: Implementation :: CPython

Typing

Stubs Only

boto3-stubs

Type annotations for boto3 1.40.56 compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.

Generated with mypy-boto3-builder 8.11.0.

More information can be found in boto3-stubs docs.

See how it helps you find and fix potential bugs:

types-boto3 demo

boto3-stubs

How to install

Generate locally (recommended)

You can generate type annotations for boto3 package locally with mypy-boto3-builder. Use uv for build isolation.

Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.40.56' mypy-boto3-builder
Select boto3-stubs AWS SDK.
Select services you use in the current project.
Use provided commands to install generated packages.

VSCode extension

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Auto-discover services and select services you use in the current project.

From PyPI with pip

Install boto3-stubs to add type checking for boto3 package.

# install type annotations only for boto3
python -m pip install boto3-stubs

# install boto3 type annotations
# for cloudformation, dynamodb, ec2, lambda, rds, s3, sqs
python -m pip install 'boto3-stubs[essential]'

# or install annotations for services you use
python -m pip install 'boto3-stubs[acm,apigateway]'

# or install annotations in sync with boto3 version
python -m pip install 'boto3-stubs[boto3]'

# or install all-in-one annotations for all services
python -m pip install 'boto3-stubs[full]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[essential]'

From conda-forge

Add conda-forge to your channels with:

conda config --add channels conda-forge
conda config --set channel_priority strict

Once the conda-forge channel has been enabled, boto3-stubs and boto3-stubs-essential can be installed with:

conda install boto3-stubs boto3-stubs-essential

List all available versions of boto3-stubs available on your platform with:

conda search boto3-stubs --channel conda-forge

How to uninstall

# uninstall boto3-stubs
python -m pip uninstall -y boto3-stubs

Usage

VSCode

Install Python extension
Install Pylance extension
Set Pylance as your Python Language Server
Install boto3-stubs[essential] in your environment:

python -m pip install 'boto3-stubs[essential]'

Both type checking and code completion should now work. No explicit type annotations required, write your boto3 code as usual.

PyCharm

⚠️ Due to slow PyCharm performance on Literal overloads (issue PY-40997), it is recommended to use boto3-stubs-lite until the issue is resolved.

⚠️ If you experience slow performance and high CPU usage, try to disable PyCharm type checker and use mypy or pyright instead.

⚠️ To continue using PyCharm type checker, you can try to replace boto3-stubs with boto3-stubs-lite:

pip uninstall boto3-stubs
pip install boto3-stubs-lite

Install boto3-stubs[essential] in your environment:

python -m pip install 'boto3-stubs[essential]'

Both type checking and code completion should now work.

Emacs

Install boto3-stubs with services you use in your environment:

python -m pip install 'boto3-stubs[essential]'

Install use-package, lsp, company and flycheck packages
Install lsp-pyright package

(use-package lsp-pyright
  :ensure t
  :hook (python-mode . (lambda ()
                          (require 'lsp-pyright)
                          (lsp)))  ; or lsp-deferred
  :init (when (executable-find "python3")
          (setq lsp-pyright-python-executable-cmd "python3"))
  )

Make sure emacs uses the environment where you have installed boto3-stubs

Type checking should now work. No explicit type annotations required, write your boto3 code as usual.

Sublime Text

Install boto3-stubs[essential] with services you use in your environment:

python -m pip install 'boto3-stubs[essential]'

Install LSP-pyright package

Type checking should now work. No explicit type annotations required, write your boto3 code as usual.

Other IDEs

Not tested, but as long as your IDE supports mypy or pyright, everything should work.

mypy

Install mypy: python -m pip install mypy
Install boto3-stubs[essential] in your environment:

python -m pip install 'boto3-stubs[essential]'

Type checking should now work. No explicit type annotations required, write your boto3 code as usual.

pyright

Install pyright: npm i -g pyright
Install boto3-stubs[essential] in your environment:

python -m pip install 'boto3-stubs[essential]'

Optionally, you can install boto3-stubs to typings directory.

Type checking should now work. No explicit type annotations required, write your boto3 code as usual.

Pylint compatibility

It is totally safe to use TYPE_CHECKING flag in order to avoid boto3-stubs dependency in production. However, there is an issue in pylint that it complains about undefined variables. To fix it, set all types to object in non-TYPE_CHECKING mode.

from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from mypy_boto3_ec2 import EC2Client, EC2ServiceResource
    from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
    from mypy_boto3_ec2.paginators import DescribeVolumesPaginator
else:
    EC2Client = object
    EC2ServiceResource = object
    BundleTaskCompleteWaiter = object
    DescribeVolumesPaginator = object

...

Explicit type annotations

To speed up type checking and code completion, you can set types explicitly.

import boto3
from boto3.session import Session

from mypy_boto3_ec2.client import EC2Client
from mypy_boto3_ec2.service_resource import EC2ServiceResource
from mypy_boto3_ec2.waiter import BundleTaskCompleteWaiter
from mypy_boto3_ec2.paginator import DescribeVolumesPaginator

session = Session(region_name="us-west-1")

ec2_client: EC2Client = boto3.client("ec2", region_name="us-west-1")
ec2_resource: EC2ServiceResource = session.resource("ec2")

bundle_task_complete_waiter: BundleTaskCompleteWaiter = ec2_client.get_waiter(
    "bundle_task_complete"
)
describe_volumes_paginator: DescribeVolumesPaginator = ec2_client.get_paginator("describe_volumes")

How it works

Fully automated mypy-boto3-builder carefully generates type annotations for each service, patiently waiting for boto3 updates. It delivers drop-in type annotations for you and makes sure that:

boto3-stubs 1.40.56

Development Status

Intended Audience

Environment

License

Natural Language

Operating System

Programming Language

Typing

boto3-stubs

How to install

Generate locally (recommended)

VSCode extension

From PyPI with pip

From conda-forge

How to uninstall

Usage

VSCode

PyCharm

Emacs

Sublime Text

Other IDEs

mypy

pyright

Pylint compatibility

Explicit type annotations

How it works

What's new

Implemented features

Latest changes

Versioning

Thank you

Documentation

Support and contributing

Submodules

Wheel compatibility matrix

Files in release