Skip to content

APIGateway module#

Index > APIGateway

Auto-generated documentation for APIGateway type annotations stubs module types-boto3-apigateway.

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.36.26' mypy-boto3-builder
  2. Select boto3 AWS SDK.
  3. Add APIGateway 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 APIGateway.

From PyPI with pip#

Install types-boto3 for APIGateway service.

# install with boto3 type annotations
python -m pip install 'types-boto3[apigateway]'

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

# standalone installation
python -m pip install types-boto3-apigateway

How to uninstall#

python -m pip uninstall -y types-boto3-apigateway

Usage#

Code samples can be found in Examples.

APIGatewayClient#

Type annotations and code completion for boto3.client("apigateway") as APIGatewayClient boto3 documentation

# APIGatewayClient usage example

from boto3.session import Session

from types_boto3_apigateway.client import APIGatewayClient

def get_client() -> APIGatewayClient:
    return Session().client("apigateway")

Paginators#

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

# GetApiKeysPaginator usage example

from boto3.session import Session

from types_boto3_apigateway.paginator import GetApiKeysPaginator

def get_get_api_keys_paginator() -> GetApiKeysPaginator:
    return Session().client("apigateway").get_paginator("get_api_keys"))

Literals#

Type annotations for literals used in methods and schema.

# AccessAssociationSourceTypeType usage example

from types_boto3_apigateway.literals import AccessAssociationSourceTypeType

def get_value() -> AccessAssociationSourceTypeType:
    return "VPCE"

Type definitions#

Type annotations for type definitions used in methods and schema.