Skip to content

WAF module#

Index > WAF

Auto-generated documentation for WAF type annotations stubs module mypy-boto3-waf.

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

From PyPI with pip#

Install boto3-stubs for WAF service.

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


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


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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

WAFClient#

Type annotations and code completion for boto3.client("waf") as WAFClient boto3 documentation

# WAFClient usage example

from boto3.session import Session

from mypy_boto3_waf.client import WAFClient

def get_client() -> WAFClient:
    return Session().client("waf")

Paginators#

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

# GetRateBasedRuleManagedKeysPaginator usage example

from boto3.session import Session

from mypy_boto3_waf.paginator import GetRateBasedRuleManagedKeysPaginator

def get_get_rate_based_rule_managed_keys_paginator() -> GetRateBasedRuleManagedKeysPaginator:
    return Session().client("waf").get_paginator("get_rate_based_rule_managed_keys"))

Literals#

Type annotations for literals used in methods and schemas.

# ChangeActionType usage example

from mypy_boto3_waf.literals import ChangeActionType

def get_value() -> ChangeActionType:
    return "DELETE"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# ExcludedRuleTypeDef usage example

from mypy_boto3_waf.type_defs import ExcludedRuleTypeDef

def get_value() -> ExcludedRuleTypeDef:
    return {
        "RuleId": ...,
    }