mypy-boto3-apigateway Type Stubs

Warnings

• breaking Version 8.12.0 of `mypy-boto3-builder` (which generates this package) removed support for Python 3.8. Ensure your project uses Python 3.9 or higher.
  Fix: Upgrade your Python environment to 3.9 or newer.
• breaking Starting with `mypy-boto3-builder` version 8.9.0, some TypeDef naming conventions changed. Specifically, redundant `Request` postfixes were removed (e.g., `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`).
  Fix: Review and update `TypedDict` names in your codebase if you are upgrading from older `mypy-boto3` versions and encounter type errors related to `Request` suffixes.
• gotcha Mismatching `mypy-boto3-apigateway` and `boto3`/`botocore` versions can lead to incorrect type checking or `mypy` errors. The `mypy-boto3-*` packages are generated based on specific `botocore` versions.
  Fix: Always install `mypy-boto3-apigateway` with a version that closely matches your `boto3`/`botocore` installation. The package version (e.g., `1.42.68`) usually indicates the `botocore` version it's compatible with (e.g., `1.34.68`). Using `boto3-stubs[apigateway]` can help manage this by pinning the `botocore-stubs` dependency.
• gotcha The `mypy-boto3` ecosystem migrated to `PEP 561` compliant packages in version 8.12.0. While this change is generally transparent, ensure your `mypy` configuration (e.g., `mypy_path`) is not bypassing standard Python package discovery for type stubs.
  Fix: Ensure `mypy` is configured to find stubs via standard package discovery (e.g., `pip install` places them correctly). Avoid manually manipulating `mypy_path` unless absolutely necessary, and verify paths are correct if doing so.

Install

• pip install mypy-boto3-apigateway boto3 Install specific stubs and boto3
• pip install "boto3-stubs[apigateway]" Install using boto3-stubs extra (recommended)

Imports

• APIGatewayClient

  from mypy_boto3_apigateway.client import APIGatewayClient

• GetRestApisRequestRequestTypeDef

  from mypy_boto3_apigateway.type_defs import GetRestApisRequestRequestTypeDef

• GetRestApisResponseTypeDef

  from mypy_boto3_apigateway.type_defs import GetRestApisResponseTypeDef

• boto3.client

  import boto3; client: APIGatewayClient = boto3.client('apigateway')

  mypy-boto3 stubs enhance the standard `boto3.client` factory method. Direct imports from `boto3.client.*` are not how boto3 clients are typically instantiated or type-hinted with these stubs.

Quickstart

This quickstart demonstrates how to initialize an APIGateway client with `boto3` and apply type hints using `mypy-boto3-apigateway`. It shows how to use generated `TypedDict` for both request parameters and response objects, enabling `mypy` to validate API calls.

import boto3
from mypy_boto3_apigateway.client import APIGatewayClient
from mypy_boto3_apigateway.type_defs import GetRestApisRequestRequestTypeDef, GetRestApisResponseTypeDef

# Configure AWS credentials if not using default profile/env vars
# import os
# os.environ['AWS_ACCESS_KEY_ID'] = os.environ.get('AWS_ACCESS_KEY_ID', '')
# os.environ['AWS_SECRET_ACCESS_KEY'] = os.environ.get('AWS_SECRET_ACCESS_KEY', '')
# os.environ['AWS_REGION'] = os.environ.get('AWS_REGION', 'us-east-1')

def list_apigateway_rest_apis() -> None:
    """Lists up to 10 APIGateway REST APIs and demonstrates type hinting."""
    # Type hint the client for static analysis
    client: APIGatewayClient = boto3.client("apigateway")

    # Use a TypedDict for request parameters, ensuring correct types and keys
    request_params: GetRestApisRequestRequestTypeDef = {
        "position": "0",
        "limit": 10
    }

    # The response is also a TypedDict, allowing safe attribute access
    response: GetRestApisResponseTypeDef = client.get_rest_apis(**request_params)

    print(f"Found {len(response.get('items', []))} REST APIs:")
    for item in response.get('items', []):
        name = item.get('name', 'N/A')
        api_id = item.get('id', 'N/A')
        print(f"- {name} (ID: {api_id})")

    # mypy would flag issues like:
    # print(response['non_existent_key']) # Error: Key 'non_existent_key' not found in GetRestApisResponseTypeDef

if __name__ == "__main__":
    list_apigateway_rest_apis()