Skip to content

APIGateway module#

Index > APIGateway

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

How to install#

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 boto3-stubs for APIGateway service.

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


# 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[apigateway]'


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

How to uninstall#

python -m pip uninstall -y mypy-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 mypy_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 mypy_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 schemas.

# ApiKeySourceTypeType usage example

from mypy_boto3_apigateway.literals import ApiKeySourceTypeType

def get_value() -> ApiKeySourceTypeType:
    return "AUTHORIZER"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# AccessLogSettingsTypeDef usage example

from mypy_boto3_apigateway.type_defs import AccessLogSettingsTypeDef

def get_value() -> AccessLogSettingsTypeDef:
    return {
        "format": ...,
    }