mypy-boto3-shield 1.13.26.1

Type annotations for boto3.Shield 1.13.26 service, generated by mypy-boto3-buider 2.0.3

mypy-boto3-shield

• mypy-boto3-shield
  • How to use
  • Automated type discovery

Type annotations for boto3.Shield 1.13.26 service compatible with mypy, VSCode, PyCharm and other tools.

Generated by mypy-boto3-buider 2.0.3.

More information can be found on boto3-stubs page.

• mypy-boto3-shield
  • How to use
    • Type checking
  • How it works

How to use

Make sure you have mypy installed and activated in your IDE.

Install boto3-stubs for Shield service.

python -m pip install boto3-stubs[shield]

# update installed packages index for automated type discovery
python -m mypy_boto3

Use boto3 with mypy_boto3_shield in your project and enjoy type checking and auto-complete.

import boto3

from mypy_boto3_shield import ShieldClient

# Now mypy can check if your code is valid.
client: ShieldClient = boto3.client("shield")

# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: ShieldClient = session.client("shield")



# Annotated paginators are included as well

import mypy_boto3_shield.paginator as shield_paginators

list_attacks_paginator: shield_paginators.ListAttacksPaginator = client.get_paginator("list_attacks")
list_protections_paginator: shield_paginators.ListProtectionsPaginator = client.get_paginator("list_protections")

Automated type discovery

mypy_boto3 package can generate index for mypy_boto3_shield and other installed services.

# Run this command when you add or remove service packages
python -m mypy_boto3

Generated index provides overloads for boto3.client and boto3.service, boto3.Session.client and boto3.Session.resource functions, so explicit type annotations are not needed.

• mypy supports function overloads as expected
• PyCharm also supports function overloads, but consumes a lot of RAM, use carefully
• VSCode does not currently support function overloads

Also, generated index allows you to import types from mypy_boto3:

# you can replace imports
import mypy_boto3_shield as shield
from mypy_boto3_shield import ShieldClient

# with these
from mypy_boto3 import shield
from mypy_boto3.shield import ShieldClient