Skip to content

Transfer module#

Index > Transfer

Auto-generated documentation for Transfer type annotations stubs module types-aiobotocore-transfer.

How to install#

From PyPI with pip#

Install types-aiobotocore for Transfer service.

# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[transfer]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aiobotocore-lite[transfer]'


# standalone installation
python -m pip install types-aiobotocore-transfer

How to uninstall#

python -m pip uninstall -y types-aiobotocore-transfer

Usage#

Code samples can be found in Examples.

TransferClient#

Type annotations and code completion for session.create_client("transfer") as TransferClient boto3 documentation

# TransferClient usage example

from aiobotocore.session import get_session

from types_aiobotocore_transfer.client import TransferClient


session = get_session()
async with session.create_client("transfer") as client:
    client: TransferClient

Paginators#

Type annotations and code completion for paginators from session.create_client("transfer").get_paginator("...").

# ListAccessesPaginator usage example

from types_aiobotocore_transfer.paginator import ListAccessesPaginator

def get_list_accesses_paginator() -> ListAccessesPaginator:
    return client.get_paginator("list_accesses"))

Waiters#

Type annotations and code completion for waiters from session.create_client("transfer").get_waiter("...").

# ServerOfflineWaiter usage example

from types_aiobotocore_transfer.waiter import ServerOfflineWaiter

def get_server_offline_waiter() -> ServerOfflineWaiter:
    return Session().client("transfer").get_waiter("server_offline")

Literals#

Type annotations for literals used in methods and schema.

# AgreementStatusTypeType usage example

from types_aiobotocore_transfer.literals import AgreementStatusTypeType

def get_value() -> AgreementStatusTypeType:
    return "ACTIVE"

Type definitions#

Type annotations for type definitions used in methods and schema.