Skip to content

ApiGatewayV2 module#

Index > ApiGatewayV2

Auto-generated documentation for ApiGatewayV2 type annotations stubs module mypy-boto3-apigatewayv2.

How to install#

You can generate type annotations for boto3 package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.38.19' mypy-boto3-builder
  2. Select boto3-stubs AWS SDK.
  3. Add ApiGatewayV2 service.
  4. Use provided commands to install generated packages.

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and ApiGatewayV2.

From PyPI with pip#

Install boto3-stubs for ApiGatewayV2 service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[apigatewayv2]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[apigatewayv2]'

# standalone installation
python -m pip install mypy-boto3-apigatewayv2

How to uninstall#

python -m pip uninstall -y mypy-boto3-apigatewayv2

Usage#

Code samples can be found in Examples.

ApiGatewayV2Client#

Type annotations and code completion for boto3.client("apigatewayv2") as ApiGatewayV2Client boto3 documentation

# ApiGatewayV2Client usage example

from boto3.session import Session

from mypy_boto3_apigatewayv2.client import ApiGatewayV2Client

def get_client() -> ApiGatewayV2Client:
    return Session().client("apigatewayv2")

Paginators#

Type annotations and code completion for paginators from boto3.client("apigatewayv2").get_paginator("...").

# GetApisPaginator usage example

from boto3.session import Session

from mypy_boto3_apigatewayv2.paginator import GetApisPaginator

def get_get_apis_paginator() -> GetApisPaginator:
    return Session().client("apigatewayv2").get_paginator("get_apis"))

Literals#

Type annotations for literals used in methods and schema.

# AuthorizationTypeType usage example

from mypy_boto3_apigatewayv2.literals import AuthorizationTypeType

def get_value() -> AuthorizationTypeType:
    return "AWS_IAM"

Type definitions#

Type annotations for type definitions used in methods and schema.