Examples#
Auto-generated documentation for WAFV2 type annotations stubs module mypy-boto3-wafv2.
Client#
Implicit type annotations#
Can be used with boto3-stubs[wafv2]
package installed.
Write your WAFV2
code as usual,
type checking and code completion should work out of the box.
Client method usage example#
# WAFV2Client usage example
from boto3.session import Session
session = Session()
client = session.client("wafv2") # (1)
result = client.check_capacity() # (2)
- client: WAFV2Client
- result: CheckCapacityResponseTypeDef
Explicit type annotations#
With boto3-stubs-lite[wafv2]
or a standalone mypy_boto3_wafv2
package, you have to explicitly specify client: WAFV2Client
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#
# WAFV2Client usage example with type annotations
from boto3.session import Session
from mypy_boto3_wafv2.client import WAFV2Client
from mypy_boto3_wafv2.type_defs import CheckCapacityResponseTypeDef
from mypy_boto3_wafv2.type_defs import CheckCapacityRequestTypeDef
session = Session()
client: WAFV2Client = session.client("wafv2")
kwargs: CheckCapacityRequestTypeDef = {...}
result: CheckCapacityResponseTypeDef = client.check_capacity(**kwargs)