mypy-boto3-chime

Warnings

• breaking Support for Python 3.8 was removed in `mypy-boto3-builder` version 8.12.0. This affects all generated `mypy-boto3` stub packages, including `mypy-boto3-chime`.
  Fix: Upgrade your Python environment to version 3.9 or newer. Ensure your `requires_python` matches the library's requirements.
• breaking The legacy `mypy-boto3` project was moved to a separate product in `mypy-boto3-builder` version 8.9.0. Users relying on the older `mypy-boto3` package for broad stub coverage may experience issues.
  Fix: Migrate to `types-boto3` for general Boto3 stubs or install specific service packages like `mypy-boto3-chime` directly.
• breaking Type definition names for method arguments (e.g., `CreateDistributionRequestRequestTypeDef` to `CreateDistributionRequestTypeDef`) and `Extra` postfix positioning were changed in `mypy-boto3-builder` version 8.9.0. This can cause type checking errors for existing code.
  Fix: Review your `type_defs` imports and update usage to reflect the new naming conventions.
• gotcha This package only provides type annotations. You must install the `boto3` library separately for runtime functionality.
  Fix: Ensure `boto3` is installed in your environment: `pip install boto3`.
• gotcha For static type checking to be effective, you need to configure a type checker like MyPy or Pyright in your project. This package provides the stubs, but the type checker performs the analysis.
  Fix: Install and configure `mypy` or `pyright` in your development environment. Refer to their respective documentation for setup instructions.
• deprecated The `sms-voice` service was excluded from `mypy-boto3-builder` version 8.11.0 and is no longer supported. Users should use `pinpoint-sms-voice` instead. While this specific package is for Chime, it indicates a pattern of service name changes in the broader `mypy-boto3` ecosystem.
  Fix: If your project relies on `sms-voice` stubs, migrate to `mypy-boto3-pinpoint-sms-voice` (or `boto3-stubs[pinpoint-sms-voice]`) and adjust your Boto3 client calls accordingly.

Install

• pip install mypy-boto3-chime boto3 Install library and Boto3

Imports

• ChimeClient

  from mypy_boto3_chime.client import ChimeClient

  The `boto3` client is dynamically typed; `mypy_boto3_chime.client` provides the static type definition.
• ListAccountsOutputTypeDef

  from mypy_boto3_chime.type_defs import ListAccountsOutputTypeDef

  For precise type checking of Boto3 operation responses, import the specific `TypedDict`.
• AccountStatusType

  from mypy_boto3_chime.literals import AccountStatusType

  Use literal types for stricter validation of string-based enum values defined by AWS.

Quickstart

This quickstart demonstrates how to initialize a type-hinted Boto3 Chime client and call an operation like `list_accounts`. It shows how to import the `ChimeClient` type and optionally type-hint the response using `TypedDict` from `mypy_boto3_chime.type_defs`. The `TYPE_CHECKING` block ensures that the stub-only imports are not part of the runtime dependency.

from typing import TYPE_CHECKING
import boto3

if TYPE_CHECKING:
    from mypy_boto3_chime.client import ChimeClient
    from mypy_boto3_chime.type_defs import ListAccountsOutputTypeDef

def get_chime_accounts() -> list[dict]:
    # The client variable is type-hinted for MyPy/IDE support
    client: "ChimeClient" = boto3.client("chime")
    
    # The response can also be type-hinted for stricter checking
    response: "ListAccountsOutputTypeDef" = client.list_accounts(
        MaxResults=5, 
        NextToken='' # Simulate optional token, use os.environ.get('NEXT_TOKEN', '') for real-world scenarios
    )
    return response.get("Accounts", [])

if __name__ == "__main__":
    accounts = get_chime_accounts()
    print(f"Found {len(accounts)} Chime accounts.")
    for account in accounts:
        print(f"  Account ID: {account.get('AccountId')}, Name: {account.get('Name')}")