mypy-boto3-shield 1.14.0.0

Type annotations for boto3.Shield 1.14.0 service, generated by mypy-boto3-buider 2.0.4

mypy-boto3-shield

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

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

Generated by mypy-boto3-buider 2.0.4.

More information can be found on boto3-stubs page.

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]

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")

Dynamic type annotations

mypy_boto3 command generates boto3.client/resource type annotations for mypy_boto3_shield and other installed services.

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

Generated type annotations provide overloads for boto3.client and boto3.resource, 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 if you have many services installed
• VSCode does not currently support function overloads, use explicit type annotations

import boto3

# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("shield")

session_client = boto3.Session().client("shield")