Skip to content

Shield module#

Index > Shield

Auto-generated documentation for Shield type annotations stubs module mypy-boto3-shield.

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.36.2' mypy_boto3_builder
  2. Select boto3-stubs AWS SDK.
  3. Add Shield 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 Shield.

From PyPI with pip#

Install boto3-stubs for Shield service.

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

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

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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

ShieldClient#

Type annotations and code completion for boto3.client("shield") as ShieldClient boto3 documentation

# ShieldClient usage example

from boto3.session import Session

from mypy_boto3_shield.client import ShieldClient

def get_client() -> ShieldClient:
    return Session().client("shield")

Paginators#

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

# ListAttacksPaginator usage example

from boto3.session import Session

from mypy_boto3_shield.paginator import ListAttacksPaginator

def get_list_attacks_paginator() -> ListAttacksPaginator:
    return Session().client("shield").get_paginator("list_attacks"))

Literals#

Type annotations for literals used in methods and schema.

# ApplicationLayerAutomaticResponseStatusType usage example

from mypy_boto3_shield.literals import ApplicationLayerAutomaticResponseStatusType

def get_value() -> ApplicationLayerAutomaticResponseStatusType:
    return "DISABLED"