Type Annotations for aiobotocore Athena

Common errors

• ModuleNotFoundError: No module named 'aiobotocore'

  cause The `types-aiobotocore-athena` package only provides type hints; the actual `aiobotocore` library is not installed.
  fix Install the `aiobotocore` library: `pip install aiobotocore`.

• error: Library stubs not installed for "aiobotocore.session" [no-any-unimported]

  cause Mypy cannot find type information for `aiobotocore` because the stub package for Athena is installed, but the core `aiobotocore` stubs or the specific service stubs are not being correctly picked up, or the stub package itself is missing.
  fix Ensure `types-aiobotocore-athena` is installed and that MyPy is configured to check your environment. Sometimes explicitly installing `types-aiobotocore` (the umbrella package) can help, or if using `aiobotocore` as a dependency in `pyproject.toml`, ensure it's in a section MyPy checks.

• AttributeError: 'AthenaClient' object has no attribute 'non_existent_method'

  cause The code is attempting to call a method on the Athena client that does not exist in the installed `aiobotocore` version or is a typo. The type stubs reflect the latest `aiobotocore` API, which might differ from an older runtime version.
  fix Check the `aiobotocore` documentation for the correct method name and available APIs for your installed version. Ensure your `aiobotocore` installation is up-to-date: `pip install --upgrade aiobotocore`.

Warnings

• breaking Python 3.8 support was removed from `mypy-boto3-builder` (which generates these stubs) in version 8.12.0. Users on Python 3.8 or older will need to upgrade their Python version to `>=3.9` or use an older stub version.
  Fix: Upgrade your Python environment to 3.9 or newer.
• breaking Type definition (TypeDef) naming conventions changed in `mypy-boto3-builder` 8.9.0. This includes shorter names for packed method arguments (e.g., `CreateDistributionRequestRequestTypeDef` -> `CreateDistributionRequestTypeDef`) and moving the `Extra` postfix. Code explicitly importing and using these `TypeDefs` may break.
  Fix: Update `TypeDef` import names in your code to match the new conventions. Consult the specific service's `type_defs.pyi` for the correct names.
• gotcha This package (`types-aiobotocore-athena`) provides *only* type annotations. You must install `aiobotocore` separately for the actual asynchronous AWS SDK functionality at runtime. For static type checking, `mypy` is also required as a development dependency.
  Fix: Ensure both `aiobotocore` (runtime) and `mypy` (dev) are installed alongside `types-aiobotocore-athena`.
• gotcha The `mypy-boto3` ecosystem migrated to PEP 561-compliant packages in `mypy-boto3-builder` 8.12.0. While this generally improves compatibility, some tools or custom configurations that relied on older stub discovery mechanisms might require adjustments.
  Fix: Ensure your type checker (e.g., MyPy) is up-to-date and correctly configured to find PEP 561-style stub packages. Most common setups should work without manual intervention.
• gotcha Occasionally, specific AWS services may be renamed or deprecated within the `aiobotocore` ecosystem (e.g., `sms-voice` was replaced by `pinpoint-sms-voice` in `mypy-boto3-builder` 8.11.0). While this specific stub is for Athena, keep an eye on upstream `aiobotocore` changes, as they might eventually affect the service name or availability.
  Fix: Refer to official AWS `aiobotocore` documentation for service names and changes. If a service is renamed, update your `session.create_client()` calls and corresponding `types-aiobotocore-*` stub imports.

Install

• pip install types-aiobotocore-athena aiobotocore Install with aiobotocore

Imports

• AthenaClient

  from types_aiobotocore_athena.client import AthenaClient

• BatchGetNamedQueryOutputTypeDef
  wrong:

  from types_aiobotocore_athena.client import BatchGetNamedQueryOutputTypeDef

  correct:

  from types_aiobotocore_athena.type_defs import BatchGetNamedQueryOutputTypeDef

  Type definitions are located in the `type_defs` module, not `client`.
• AuthenticationTypeType
  wrong:

  from types_aiobotocore_athena.type_defs import AuthenticationTypeType

  correct:

  from types_aiobotocore_athena.literals import AuthenticationTypeType

  Literal types (string enums) are typically found in the `literals` module.

Quickstart

This example demonstrates how to use `types-aiobotocore-athena` with `aiobotocore` to list Athena workgroups. It includes explicit type annotations for the client, allowing IDEs and static analyzers like MyPy to provide intelligent autocompletion and type checking for Athena client methods and their return types. Remember to set up actual AWS credentials for real-world usage.

import asyncio
import os
from aiobotocore.session import get_session
from types_aiobotocore_athena.client import AthenaClient
from types_aiobotocore_athena.type_defs import StartQueryExecutionOutputTypeDef


async def list_athena_workgroups() -> None:
    session = get_session()
    # For demonstration, using dummy credentials. Replace with actual config or env vars.
    aws_access_key_id = os.environ.get('AWS_ACCESS_KEY_ID', 'testing')
    aws_secret_access_key = os.environ.get('AWS_SECRET_ACCESS_KEY', 'testing')
    aws_session_token = os.environ.get('AWS_SESSION_TOKEN', 'testing')

    async with session.create_client(
        "athena",
        region_name="us-east-1",
        aws_access_key_id=aws_access_key_id,
        aws_secret_access_key=aws_secret_access_key,
        aws_session_token=aws_session_token
    ) as client:
        client: AthenaClient # Explicit type annotation is optional but recommended
        try:
            response = await client.list_work_groups()
            print("Athena Workgroups:")
            for wg in response.get('WorkGroups', []):
                print(f"  - {wg.get('Name')} (State: {wg.get('State')})")
        except client.exceptions.ClientError as e:
            print(f"Error listing workgroups: {e}")

async def run_example():
    await list_athena_workgroups()

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