Skip to content

WAF module#

Index > WAF

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

How to install#

You can generate type annotations for boto3 package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.37.3' mypy-boto3-builder
  2. Select boto3 AWS SDK.
  3. Add WAF service.
  4. Use provided commands to install generated packages.

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 types-boto3 for WAF service.

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

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[waf]'

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

How to uninstall#

python -m pip uninstall -y types-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 types_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 types_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 schema.

# ChangeActionType usage example

from types_boto3_waf.literals import ChangeActionType

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

Type definitions#

Type annotations for type definitions used in methods and schema.