Skip to content

WAF module#

Index > WAF

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

How to install#

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

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

From PyPI with pip#

Install types-aioboto3 for WAF service.

# install with aioboto3 type annotations
python -m pip install 'types-aioboto3[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-aioboto3-lite[waf]'

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

How to uninstall#

python -m pip uninstall -y types-aiobotocore-waf

Usage#

Code samples can be found in Examples.

WAFClient#

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

# WAFClient usage example

from aioboto3.session import Session

from types_aiobotocore_waf.client import WAFClient


session = Session()
async with session.client("waf") as client:
    client: WAFClient

Paginators#

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

# GetRateBasedRuleManagedKeysPaginator usage example

from types_aiobotocore_waf.paginator import GetRateBasedRuleManagedKeysPaginator

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

Literals#

Type annotations for literals used in methods and schema.

# ChangeActionType usage example

from types_aiobotocore_waf.literals import ChangeActionType

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

Type definitions#

Type annotations for type definitions used in methods and schema.