Type Annotations for aiobotocore

3.4.0 · active · verified Thu Apr 09

types-aiobotocore provides PEP 561 compliant type annotations for the `aiobotocore` library, enabling static type checking for asynchronous AWS client interactions. It helps catch type-related errors before runtime and improves IDE autocompletion. The current version is 3.4.0, and new versions are released frequently, tied to updates in the `mypy-boto3-builder` and `aiobotocore` itself.

Warnings

breaking Python 3.8 support has been removed as of `mypy-boto3-builder` version 8.12.0 (which generates `types-aiobotocore` 3.4.0). Users on Python 3.8 will need to upgrade to Python 3.9+.
Fix: Upgrade your Python environment to 3.9 or higher.
breaking The builder migrated to PEP 561 compliant packages in version 8.12.0. While this is generally an improvement for type checker discovery, older type checker configurations or specific environments might require re-evaluation of how stub packages are found.
Fix: Ensure your type checker (e.g., MyPy) is up-to-date and correctly configured to discover PEP 561 stubs. Reinstalling the package might resolve issues.
gotcha This `types-aiobotocore` package specifically provides type stubs for the *core* `aiobotocore` library (e.g., `AioSession`, generic `Client`). For service-specific type stubs (e.g., `S3Client`, `EC2Client`, `ListBucketsOutputTypeDef`), you must install the corresponding service package like `types-aiobotocore-s3`.
Fix: Install service-specific type stub packages (`pip install types-aiobotocore-<service_name>`) for type checking related to individual AWS services.
gotcha `types-aiobotocore` only provides type annotations; it does not include the `aiobotocore` runtime library itself. Both must be installed for your code to execute and be type-checked.
Fix: Ensure you have `aiobotocore` installed via `pip install aiobotocore` alongside `types-aiobotocore`.

Install

pip install types-aiobotocore Install core types

Imports

AioSession
```
from types_aiobotocore.session import AioSession
```
Type annotation for the aiobotocore session object. The runtime object comes from `aiobotocore.session.get_session()`.
Client
```
from types_aiobotocore.client import Client
```
Type annotation for the generic aiobotocore client. For service-specific clients (e.g., S3Client), import from `types_aiobotocore_<service_name>.client` (requires installing `types-aiobotocore-<service_name>`).

Quickstart

This quickstart demonstrates how to use `aiobotocore` to list S3 buckets. By installing `types-aiobotocore` (and potentially `types-aiobotocore-s3`), your static type checker (like MyPy) will understand the types of `session` and `client`, providing autocompletion and error checking without altering the runtime code. Note that `aiobotocore` itself must be installed.

import asyncio
from aiobotocore.session import get_session

async def main():
    session = get_session()
    # `types-aiobotocore` provides type stubs for the session and client.
    # For S3 specific types, you would also install `types-aiobotocore-s3`.
    async with session.create_client("s3") as client:
        response = await client.list_buckets()
        print("S3 Buckets:", [b["Name"] for b in response.get("Buckets", [])])

if __name__ == "__main__":
    asyncio.run(main())

view raw JSON →