Skip to content

WAFV2 module#

Index > WAFV2

Auto-generated documentation for WAFV2 type annotations stubs module mypy-boto3-wafv2.

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 WAFV2.

From PyPI with pip#

Install boto3-stubs for WAFV2 service.

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


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


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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

WAFV2Client#

Type annotations and code completion for boto3.client("wafv2") as WAFV2Client boto3 documentation

# WAFV2Client usage example

from boto3.session import Session

from mypy_boto3_wafv2.client import WAFV2Client

def get_client() -> WAFV2Client:
    return Session().client("wafv2")

Literals#

Type annotations for literals used in methods and schemas.

# ActionValueType usage example

from mypy_boto3_wafv2.literals import ActionValueType

def get_value() -> ActionValueType:
    return "ALLOW"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# APIKeySummaryTypeDef usage example

from mypy_boto3_wafv2.type_defs import APIKeySummaryTypeDef

def get_value() -> APIKeySummaryTypeDef:
    return {
        "TokenDomains": ...,
    }