Type Annotations for aiobotocore RDS

Warnings

• breaking Support for Python 3.8 was removed from `mypy-boto3-builder` version 8.12.0 and consequently from `types-aiobotocore-rds` version 3.x.x. Users on Python 3.8 should upgrade to Python 3.9 or newer.
  Fix: Upgrade your Python environment to 3.9 or higher.
• breaking Type Definition (TypeDef) naming conventions changed in `mypy-boto3-builder` version 8.9.0. Some TypeDefs for method arguments now use shorter names (e.g., `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`), and conflicting `Extra` postfixes were moved (e.g., `CreateDistributionExtraRequestTypeDef` became `CreateDistributionRequestExtraTypeDef`).
  Fix: Review your imports and usage of TypeDefs, as their names may have changed. Refer to the specific service's documentation for updated TypeDef names if you encounter `ImportError` or `NameError`.
• gotcha This package (`types-aiobotocore-rds`) only provides type annotations. You must also install `aiobotocore` (and its dependencies) for the code to run at runtime. Without `aiobotocore`, your code will fail with `ModuleNotFoundError`.
  Fix: Ensure `aiobotocore` is installed in your environment: `pip install aiobotocore`.
• gotcha PyCharm users might experience slow performance or high CPU usage due to `Literal` overloads (PyCharm issue PY-40997). The project recommends using `types-aiobotocore-lite` as a workaround for this specific IDE issue.
  Fix: Consider installing `types-aiobotocore-lite` instead (e.g., `pip install 'types-aiobotocore-lite[rds]'`) or disable PyCharm's internal type checker and use an external one like `mypy` or `pyright`.

Install

• pip install types-aiobotocore-rds aiobotocore Install standalone types-aiobotocore-rds and aiobotocore

Imports

• RDSClient

  from types_aiobotocore_rds.client import RDSClient

  The actual aiobotocore client does not provide type hints directly, you must import the type from types_aiobotocore_rds.client for type checking.
• DBInstanceTypeDef

  from types_aiobotocore_rds.type_defs import DBInstanceTypeDef

  Use this pattern to import specific TypeDefs for request/response payloads.

Quickstart

This quickstart demonstrates how to use `types-aiobotocore-rds` to add type annotations to an `aiobotocore` RDS client. It fetches and prints details of RDS DB instances using explicit type hints for the client and the response payload, ensuring better type checking and IDE support. Remember to set up AWS credentials for the code to execute successfully.

import asyncio
from typing import TYPE_CHECKING

import aiobotocore.session

if TYPE_CHECKING:
    from types_aiobotocore_rds.client import RDSClient
    from types_aiobotocore_rds.type_defs import DBInstanceMessageTypeDef


async def describe_rds_instances():
    session = aiobotocore.session.get_session()
    async with session.create_client("rds") as client:
        if TYPE_CHECKING:
            client: RDSClient # Explicit type annotation for the client

        print("Describing RDS DB instances...")
        response: DBInstanceMessageTypeDef = await client.describe_db_instances()

        for db_instance in response.get("DBInstances", []):
            print(f"  DB Instance Identifier: {db_instance.get('DBInstanceIdentifier')}")
            print(f"  DB Instance Status: {db_instance.get('DBInstanceStatus')}")
            print(f"  Engine: {db_instance.get('Engine')}")
            print(f"  Endpoint: {db_instance.get('Endpoint', {}).get('Address')}:{db_instance.get('Endpoint', {}).get('Port')}")

        print("Description complete.")

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