capo-waf: typed, async Python SDK for AWS WAF¶

capo-waf is a typed Python SDK for AWS WAF. It has an async client, AsyncWAFClient, for asyncio and trio, and a sync client, WAFClient, with the same methods. Requests and responses are typed with TypedDicts, so your editor and type checker know every field.

It is part of capo, a community-driven alternative to boto3 and aioboto3, built on its own HTTP stack instead of botocore and generated from the official AWS Smithy models. Documentation: https://capo-sdk.dev/services/waf/

Installation¶

pip install capo-waf

Usage¶

from capo_waf import AsyncWAFClient


async def main():
    async with AsyncWAFClient() as waf:
        # Example: call the create_byte_match_set operation
        response = await waf.create_byte_match_set()
        print(response["byte_match_set"])

Error Handling¶

The SDK raises exceptions for errors returned by the API. Catch them to handle failures gracefully.

from capo_waf import AsyncWAFClient
from capo_waf.error import WAFDisallowedNameException


async def main():
    async with AsyncWAFClient() as waf:
        try:
            await waf.create_byte_match_set()
        except WAFDisallowedNameException as e:
            print(f"Error: {e}")
            print(e.data)  # additional error data

Retrying¶

The SDK retries failed operations automatically. Retry behaviour follows the Smithy specification: errors are retried based on their is_retryable and is_throttling_error attributes. Throttling errors use a longer base delay. Network-level failures (connection errors and timeouts) are also retried. Non-retryable errors, such as client errors without the @retryable trait, are raised immediately without further attempts.

The number of attempts defaults to 3 and can be changed at the client level via retry_max_attempts, or per call via config_overrides.

from capo_waf import AsyncWAFClient


async def main():
    async with AsyncWAFClient() as waf:
        # Default: 3 attempts for every operation
        response = await waf.create_byte_match_set()

        # Override per operation
        response = await waf.create_byte_match_set(config_overrides={"retry_max_attempts": 5})

        # Disable retries for this call
        response = await waf.create_byte_match_set(config_overrides={"retry_max_attempts": 1})