mypy-boto3-apigatewayv2 type annotations

Warnings

• breaking Python 3.8 support was removed from `mypy-boto3-builder` starting with version 8.12.0. Consequently, stub packages generated by this builder version (and newer) require Python 3.9 or higher.
  Fix: Ensure your project uses Python 3.9 or newer. For older Python versions, pin an older `mypy-boto3-builder` version or downgrade the specific stub packages if compatible versions exist.
• breaking TypeDef naming conventions changed in `mypy-boto3-builder` 8.9.0, potentially affecting custom TypeDef names. For instance, `CreateDistributionRequestRequestTypeDef` might become `CreateDistributionRequestTypeDef`.
  Fix: Review and update explicit TypeDef imports and usage in your codebase, especially for complex request/response types. Consult the generated stub files for the exact new names.
• gotcha The `mypy-boto3-apigatewayv2` package provides only type stubs, not the actual runtime implementation of the AWS SDK. `boto3` must be installed separately for your application to function.
  Fix: Always include `pip install boto3` alongside `pip install mypy-boto3-apigatewayv2` in your project setup.
• gotcha Type stubs are not meant for direct instantiation. For example, do not attempt to call `mypy_boto3_apigatewayv2.client.ApiGatewayV2Client()` directly. Instead, use `boto3.client('apigatewayv2')` and let MyPy infer or be guided by the imported types.
  Fix: Always create AWS service clients using `boto3.client('service_name')` or `boto3.resource('service_name')`. Use the imported types from `mypy_boto3_apigatewayv2` solely for type annotations.

Install

• pip install boto3 mypy-boto3-apigatewayv2 mypy Install Boto3, stubs, and MyPy

Imports

• ApiGatewayV2Client

  from mypy_boto3_apigatewayv2.client import ApiGatewayV2Client

• CreateApiRequestRequestTypeDef

  from mypy_boto3_apigatewayv2.type_defs import CreateApiRequestRequestTypeDef

• mypy_boto3_apigatewayv2

  import mypy_boto3_apigatewayv2

  Importing the top-level package helps MyPy discover the stubs implicitly.

Quickstart

This quickstart demonstrates how to use `mypy-boto3-apigatewayv2` to add type annotations to a `boto3` client. It shows both explicit type hinting for the client and for a request dictionary, which MyPy uses to provide autocompletion and detect type mismatches. Note that `boto3` must be installed alongside the stub package.

import boto3
import mypy_boto3_apigatewayv2  # Import for MyPy to discover stubs
from mypy_boto3_apigatewayv2.client import ApiGatewayV2Client
from mypy_boto3_apigatewayv2.type_defs import CreateApiRequestRequestTypeDef

# Instantiate a boto3 client at runtime. The stub package provides type annotations.
client: ApiGatewayV2Client = boto3.client("apigatewayv2")

print(f"Client type at runtime: {type(client)}")

# Example of a type-checked input dictionary for a method call
# MyPy will validate that 'create_api_params' conforms to CreateApiRequestRequestTypeDef
create_api_params: CreateApiRequestRequestTypeDef = {
    "Name": "MyExampleApiForTypes",
    "ProtocolType": "WEBSOCKET", # or 'HTTP'
    "Description": "API created for type demonstration",
    "Tags": {"Project": "ChecklistDay"}
    # Add other required parameters as per AWS API Gateway V2 documentation if performing a real call
}

# Although this call will likely fail without valid AWS credentials and full required parameters,
# it is syntactically correct and demonstrates where type-checking benefits apply.
try:
    response = client.create_api(**create_api_params)
    print(f"Attempted to create API with ID: {response.get('ApiId', 'N/A')}")
except Exception as e:
    print(f"Note: API call failed, likely due to missing AWS credentials or incomplete parameters. Error: {e}")

# MyPy would ensure that 'response' is treated as a CreateApiResultTypeDef.