Skip to content

Examples#

Index > ApiGatewayManagementApi > Examples

Auto-generated documentation for ApiGatewayManagementApi type annotations stubs module mypy-boto3-apigatewaymanagementapi.

Client#

Implicit type annotations#

Can be used with boto3-stubs[apigatewaymanagementapi] package installed.

Write your ApiGatewayManagementApi code as usual, type checking and code completion should work out of the box.

Client method usage example#

# ApiGatewayManagementApiClient usage example

from boto3.session import Session


session = Session()

client = session.client("apigatewaymanagementapi")  # (1)
result = client.delete_connection()  # (2)
  1. client: ApiGatewayManagementApiClient
  2. result: EmptyResponseMetadataTypeDef

Explicit type annotations#

With boto3-stubs-lite[apigatewaymanagementapi] or a standalone mypy_boto3_apigatewaymanagementapi package, you have to explicitly specify client: ApiGatewayManagementApiClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

Client method usage example#

# ApiGatewayManagementApiClient usage example with type annotations

from boto3.session import Session

from mypy_boto3_apigatewaymanagementapi.client import ApiGatewayManagementApiClient
from mypy_boto3_apigatewaymanagementapi.type_defs import EmptyResponseMetadataTypeDef
from mypy_boto3_apigatewaymanagementapi.type_defs import DeleteConnectionRequestTypeDef


session = Session()

client: ApiGatewayManagementApiClient = session.client("apigatewaymanagementapi")

kwargs: DeleteConnectionRequestTypeDef = {...}
result: EmptyResponseMetadataTypeDef = client.delete_connection(**kwargs)