Examples#
Auto-generated documentation for Shield type annotations stubs module types-aiobotocore-shield.
Client#
Implicit type annotations#
Can be used with types-aioboto3[shield]
package installed.
Write your Shield
code as usual,
type checking and code completion should work out of the box.
# ShieldClient usage example
from aioboto3.session import Session
session = Session()
async with session.client("shield") as client: # (1)
result = await client.create_protection() # (2)
- client: ShieldClient
- result: CreateProtectionResponseTypeDef
# ListAttacksPaginator usage example
from aioboto3.session import Session
session = Session()
async with session.client("shield") as client: # (1)
paginator = client.get_paginator("list_attacks") # (2)
async for item in paginator.paginate(...):
print(item) # (3)
- client: ShieldClient
- paginator: ListAttacksPaginator
- item: ListAttacksResponseTypeDef
Explicit type annotations#
With types-aioboto3-lite[shield]
or a standalone types_aiobotocore_shield
package, you have to explicitly specify
client: ShieldClient
type annotation.
All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.
# ShieldClient usage example with type annotations
from aioboto3.session import Session
from types_aiobotocore_shield.client import ShieldClient
from types_aiobotocore_shield.type_defs import CreateProtectionResponseTypeDef
from types_aiobotocore_shield.type_defs import CreateProtectionRequestRequestTypeDef
session = Session()
client: ShieldClient
async with session.client("shield") as client: # (1)
kwargs: CreateProtectionRequestRequestTypeDef = {...} # (2)
result: CreateProtectionResponseTypeDef = await client.create_protection(**kwargs) # (3)
- client: ShieldClient
- kwargs: CreateProtectionRequestRequestTypeDef
- result: CreateProtectionResponseTypeDef
# ListAttacksPaginator usage example with type annotations
from aioboto3.session import Session
from types_aiobotocore_shield.client import ShieldClient
from types_aiobotocore_shield.paginator import ListAttacksPaginator
from types_aiobotocore_shield.type_defs import ListAttacksResponseTypeDef
session = Session()
client: ShieldClient
async with session.client("shield") as client: # (1)
paginator: ListAttacksPaginator = client.get_paginator("list_attacks") # (2)
async for item in paginator.paginate(...):
item: ListAttacksResponseTypeDef
print(item) # (3)
- client: ShieldClient
- paginator: ListAttacksPaginator
- item: ListAttacksResponseTypeDef