mypy-boto3-shield Type Annotations

Warnings

• breaking As of mypy-boto3-builder version 8.12.0, support for Python 3.8 has been removed across all generated `mypy-boto3` packages, including `mypy-boto3-shield`. Users on Python 3.8 will need to upgrade to Python 3.9 or newer.
  Fix: Upgrade your Python environment to 3.9 or higher.
• breaking mypy-boto3-builder version 8.9.0 introduced breaking changes to `TypeDef` naming conventions, such as shortening `CreateDistributionRequestRequestTypeDef` to `CreateDistributionRequestTypeDef` and adjusting postfixes for conflicting names. This may require updating type annotation references in your codebase if you're upgrading from older versions.
  Fix: Review and update `TypeDef` names in your type annotations according to the new conventions.
• deprecated The original `mypy-boto3` package is considered legacy. It is recommended to use `boto3-stubs` (the umbrella package) or install individual service stubs like `mypy-boto3-shield` directly for better compatibility and maintenance.
  Fix: Prefer `boto3-stubs[service_name]` or direct `mypy-boto3-service_name` installations over the legacy `mypy-boto3` package.
• gotcha PyCharm may experience slow performance with `Literal` overloads from `mypy-boto3` stubs (issue PY-40997). If this occurs, it's recommended to use `boto3-stubs-lite` (if available for the service) or to disable PyCharm's internal type checker and rely on external tools like `mypy` or `pyright`.
  Fix: Consider `pip uninstall boto3-stubs && pip install boto3-stubs-lite` or configure PyCharm to use an external type checker.
• gotcha While `mypy-boto3` generally provides auto-discovery of types for `boto3.client` calls, explicit type annotations for the client object (e.g., `client: ShieldClient = boto3.client('shield')`) are often necessary for the best autocompletion and type-checking experience in IDEs like VSCode and PyCharm, especially for methods like `get_paginator` or `get_waiter`.
  Fix: Add explicit type annotations when instantiating clients, paginators, and waiters for optimal IDE support.

Install

• pip install mypy-boto3-shield Install service-specific stubs
• pip install boto3-stubs[shield] Install via boto3-stubs (recommended)

Imports

• ShieldClient

  from mypy_boto3_shield import ShieldClient

• ListAttacksPaginator

  from mypy_boto3_shield.paginator import ListAttacksPaginator

• ResponseActionOutputTypeDef

  from mypy_boto3_shield.type_defs import ResponseActionOutputTypeDef

Quickstart

This quickstart demonstrates how to obtain a type-hinted `ShieldClient` and use its methods, benefiting from autocompletion and static type checking. It also shows an example of using a generated `TypedDict` for clearer data structure definitions. The `TYPE_CHECKING` block ensures type imports are only active during type-checking.

import boto3
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from mypy_boto3_shield import ShieldClient
    from mypy_boto3_shield.type_defs import ListAttacksResponseTypeDef

# Instantiate a Shield client with type hints
client: "ShieldClient" = boto3.client("shield")

# Example of using a client method with type checking
try:
    response: "ListAttacksResponseTypeDef" = client.list_attacks()
    print(f"Found {len(response.get('Attacks', []))} Shield attacks.")
except Exception as e:
    print(f"Error listing attacks: {e}")

# Example of a TypedDict for input (if applicable, or output)
def process_response_action(action: "ResponseActionOutputTypeDef") -> None:
    if 'Block' in action:
        print(f"Action is a block: {action['Block']}")
    elif 'Count' in action:
        print(f"Action is a count: {action['Count']}")

# For demonstration, typically this comes from an API call
example_action: "ResponseActionOutputTypeDef" = {"Block": {}}
process_response_action(example_action)