<a id="types-aiobotocore-s3"></a>

types-aiobotocore-s3

Type annotations for aiobotocore S3 3.2.0 compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.

Generated with mypy-boto3-builder 8.12.0.

More information can be found on types-aiobotocore page and in types-aiobotocore-s3 docs.

See how it helps you find and fix potential bugs:

• types-aiobotocore-s3
  • How to install
    • Generate locally (recommended)
    • From PyPI with pip
  • How to uninstall
  • Usage
    • VSCode
    • PyCharm
    • Emacs
    • Sublime Text
    • Other IDEs
    • mypy
    • pyright
    • Pylint compatibility
  • Explicit type annotations
    • Client annotations
    • Paginators annotations
    • Waiters annotations
    • Service Resource annotations
    • Other resources annotations
    • Collections annotations
    • Literals
    • Type definitions
  • How it works
  • What's new
    • Implemented features
    • Latest changes
  • Versioning
  • Thank you
  • Documentation
  • Support and contributing

<a id="how-to-install"></a>

How to install

<a id="generate-locally-(recommended)"></a>

Generate locally (recommended)

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

1. Run mypy-boto3-builder in your package root directory: uvx --with 'aiobotocore==3.2.0' mypy-boto3-builder
2. Select aiobotocore AWS SDK.
3. Add S3 service.
4. Use provided commands to install generated packages.

<a id="from-pypi-with-pip"></a>

From PyPI with pip

Install types-aiobotocore for S3 service.

# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[s3]'

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

# standalone installation
python -m pip install types-aiobotocore-s3

<a id="how-to-uninstall"></a>

How to uninstall

python -m pip uninstall -y types-aiobotocore-s3

<a id="usage"></a>

Usage

<a id="vscode"></a>

VSCode

• Install Python extension
• Install Pylance extension
• Set Pylance as your Python Language Server
• Install types-aiobotocore[s3] in your environment:

python -m pip install 'types-aiobotocore[s3]'

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

<a id="pycharm"></a>

PyCharm

⚠️ Due to slow PyCharm performance on Literal overloads (issue PY-40997), it is recommended to use types-aiobotocore-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 types-aiobotocore with types-aiobotocore-lite:

pip uninstall types-aiobotocore
pip install types-aiobotocore-lite

Install types-aiobotocore[s3] in your environment:

python -m pip install 'types-aiobotocore[s3]'

Both type checking and code completion should now work.

<a id="emacs"></a>

Emacs

• Install types-aiobotocore with services you use in your environment:

python -m pip install 'types-aiobotocore[s3]'

• 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 types-aiobotocore

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

<a id="sublime-text"></a>

Sublime Text

• Install types-aiobotocore[s3] with services you use in your environment:

python -m pip install 'types-aiobotocore[s3]'

• Install LSP-pyright package

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

<a id="other-ides"></a>

Other IDEs

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

<a id="mypy"></a>

mypy

• Install mypy: python -m pip install mypy
• Install types-aiobotocore[s3] in your environment:

python -m pip install 'types-aiobotocore[s3]'

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

<a id="pyright"></a>

pyright

• Install pyright: npm i -g pyright
• Install types-aiobotocore[s3] in your environment:

python -m pip install 'types-aiobotocore[s3]'

Optionally, you can install types-aiobotocore to typings directory.

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

<a id="pylint-compatibility"></a>

Pylint compatibility

It is totally safe to use TYPE_CHECKING flag in order to avoid types-aiobotocore-s3 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 types_aiobotocore_ec2 import EC2Client, EC2ServiceResource
    from types_aiobotocore_ec2.waiters import BundleTaskCompleteWaiter
    from types_aiobotocore_ec2.paginators import DescribeVolumesPaginator
else:
    EC2Client = object
    EC2ServiceResource = object
    BundleTaskCompleteWaiter = object
    DescribeVolumesPaginator = object

...

<a id="explicit-type-annotations"></a>

Explicit type annotations

<a id="client-annotations"></a>

Client annotations

S3Client provides annotations for session.create_client("s3").

from aiobotocore.session import get_session

from types_aiobotocore_s3 import S3Client

session = get_session()
async with session.create_client("s3") as client:
    client: S3Client
    # now client usage is checked by mypy and IDE should provide code completion

<a id="paginators-annotations"></a>

Paginators annotations

types_aiobotocore_s3.paginator module contains type annotations for all paginators.

from aiobotocore.session import get_session

from types_aiobotocore_s3 import S3Client
from types_aiobotocore_s3.paginator import (
    ListBucketsPaginator,
    ListDirectoryBucketsPaginator,
    ListMultipartUploadsPaginator,
    ListObjectVersionsPaginator,
    ListObjectsPaginator,
    ListObjectsV2Paginator,
    ListPartsPaginator,
)

session = get_session()
async with session.create_client("s3") as client:
    client: S3Client

    # Explicit type annotations are optional here
    # Types should be correctly discovered by mypy and IDEs
    list_buckets_paginator: ListBucketsPaginator = client.get_paginator("list_buckets")
    list_directory_buckets_paginator: ListDirectoryBucketsPaginator = client.get_paginator(
        "list_directory_buckets"
    )
    list_multipart_uploads_paginator: ListMultipartUploadsPaginator = client.get_paginator(
        "list_multipart_uploads"
    )
    list_object_versions_paginator: ListObjectVersionsPaginator = client.get_paginator(
        "list_object_versions"
    )
    list_objec