Examples#
Auto-generated documentation for Transfer type annotations stubs module types-aiobotocore-transfer.
Client#
Implicit type annotations#
Can be used with types-aioboto3[transfer]
package installed.
Write your Transfer
code as usual,
type checking and code completion should work out of the box.
# TransferClient usage example
from aioboto3.session import Session
session = Session()
async with session.client("transfer") as client: # (1)
result = await client.create_access() # (2)
- client: TransferClient
- result: CreateAccessResponseTypeDef
# ListAccessesPaginator usage example
from aioboto3.session import Session
session = Session()
async with session.client("transfer") as client: # (1)
paginator = client.get_paginator("list_accesses") # (2)
async for item in paginator.paginate(...):
print(item) # (3)
- client: TransferClient
- paginator: ListAccessesPaginator
- item: ListAccessesResponseTypeDef
# ServerOfflineWaiter usage example
from aioboto3.session import Session
session = Session()
async with session.client("transfer") as client: # (1)
waiter = client.get_waiter("server_offline") # (2)
await waiter.wait()
- client: TransferClient
- waiter: ServerOfflineWaiter
Explicit type annotations#
With types-aioboto3-lite[transfer]
or a standalone types_aiobotocore_transfer
package, you have to explicitly specify
client: TransferClient
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.
# TransferClient usage example with type annotations
from aioboto3.session import Session
from types_aiobotocore_transfer.client import TransferClient
from types_aiobotocore_transfer.type_defs import CreateAccessResponseTypeDef
from types_aiobotocore_transfer.type_defs import CreateAccessRequestRequestTypeDef
session = Session()
client: TransferClient
async with session.client("transfer") as client: # (1)
kwargs: CreateAccessRequestRequestTypeDef = {...} # (2)
result: CreateAccessResponseTypeDef = await client.create_access(**kwargs) # (3)
- client: TransferClient
- kwargs: CreateAccessRequestRequestTypeDef
- result: CreateAccessResponseTypeDef
# ListAccessesPaginator usage example with type annotations
from aioboto3.session import Session
from types_aiobotocore_transfer.client import TransferClient
from types_aiobotocore_transfer.paginator import ListAccessesPaginator
from types_aiobotocore_transfer.type_defs import ListAccessesResponseTypeDef
session = Session()
client: TransferClient
async with session.client("transfer") as client: # (1)
paginator: ListAccessesPaginator = client.get_paginator("list_accesses") # (2)
async for item in paginator.paginate(...):
item: ListAccessesResponseTypeDef
print(item) # (3)
- client: TransferClient
- paginator: ListAccessesPaginator
- item: ListAccessesResponseTypeDef
# ServerOfflineWaiter usage example with type annotations
from aioboto3.session import Session
from types_aiobotocore_transfer.client import TransferClient
from types_aiobotocore_transfer.waiter import ServerOfflineWaiter
session = Session()
async with session.client("transfer") as client: # (1)
waiter = client.get_waiter("server_offline") # (2)
await waiter.wait()
- client: TransferClient
- waiter: ServerOfflineWaiter