mypy-boto3-support

Warnings

• breaking Support for Python 3.8 was removed starting with `mypy-boto3-builder` version 8.12.0. All generated `mypy-boto3-*` packages, including `mypy-boto3-support`, now require Python >=3.9.
  Fix: Upgrade your Python environment to 3.9 or newer.
• breaking All `mypy-boto3-*` packages, including `mypy-boto3-support`, migrated to PEP 561 (PyTyped) packages with `mypy-boto3-builder` 8.12.0. This might affect advanced build setups or explicit `MYPYPATH` configurations.
  Fix: Ensure `mypy` is configured to automatically discover installed stub packages. Explicit `MYPYPATH` settings might need adjustment if they previously pointed to non-PEP 561 layouts.
• breaking TypeDef naming conventions changed in `mypy-boto3-builder` 8.9.0. Some TypeDefs for packed method arguments now use shorter names (e.g., `CreateDistributionRequestRequestTypeDef` -> `CreateDistributionRequestTypeDef`). Conflicting `Extra` postfixes also moved.
  Fix: Update your type hints to use the new, shorter TypeDef names as per the latest stub definitions. Refer to the generated `.pyi` files for correct names.
• gotcha The `mypy-boto3-support` package provides *type stubs* for static analysis, not runtime implementations. You should still import and use `boto3` for actual AWS API calls. The stub package enhances type checking for your `boto3` usage.
  Fix: Continue using `import boto3` for runtime code. Only import specific type annotations (e.g., `SupportClient`, `ResponseTypeDefs`) from `mypy_boto3_support` within a `if TYPE_CHECKING:` block.
• deprecated Specific AWS services may be deprecated or renamed by AWS, leading to changes in the corresponding `mypy-boto3-*` stub packages. For example, `sms-voice` was excluded from builds in `mypy-boto3-builder` 8.11.0, replaced by `pinpoint-sms-voice`.
  Fix: If a service stub package you use suddenly disappears or fails, check the `mypy-boto3-builder` release notes for service deprecations or renames. Migrate to the new service stub if applicable.

Install

• pip install mypy-boto3-support Install service stubs
• pip install boto3 mypy-boto3-support Install boto3 with stubs

Imports

• SupportClient

  from mypy_boto3_support.client import SupportClient

  Type stubs are imported from `mypy_boto3_support`, not directly from `boto3`. Use TYPE_CHECKING guard.
• DescribeCasesResponseTypeDef

  from mypy_boto3_support.type_defs import DescribeCasesResponseTypeDef

  TypeDefs for responses/requests are specific to the stub package, not directly from boto3.

Quickstart

This example demonstrates how to use `boto3` with `mypy-boto3-support` for type-hinted AWS Support service calls. The `TYPE_CHECKING` block ensures that type-specific imports are only active during static analysis, avoiding runtime import issues.

import boto3
from typing import TYPE_CHECKING

# The mypy-boto3-support package provides stubs for boto3's 'support' service.
# The actual runtime client comes from boto3.

if TYPE_CHECKING:
    from mypy_boto3_support.client import SupportClient
    from mypy_boto3_support.type_defs import DescribeCasesResponseTypeDef

def get_aws_support_cases() -> None:
    # mypy will use the stubs to type-check this client
    client: SupportClient = boto3.client("support")
    
    # Example: Describe cases. Replace with actual parameters if needed.
    # Using try-except for a more robust example, as actual AWS calls require credentials.
    try:
        response: DescribeCasesResponseTypeDef = client.describe_cases(displayId='case-000000000001')
        print(f"Successfully described cases. Cases found: {len(response.get('cases', []))}")
        if response.get('cases'):
            print(f"First case ID: {response['cases'][0]['caseId']}")
    except Exception as e:
        print(f"Error describing cases: {e}")
        print("Ensure you have AWS credentials configured and the 'support' service is enabled.")

if __name__ == "__main__":
    get_aws_support_cases()