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-aioboto3 for Transfer service.

# install with aioboto3 type annotations
python -m pip install 'types-aioboto3[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-aioboto3-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.client("transfer") as TransferClient boto3 documentation

Usage example
from aioboto3.session import Session

from types_aiobotocore_transfer.client import TransferClient


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

Paginators

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

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.client("transfer").get_waiter("...").

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.

Usage example
from types_aiobotocore_transfer.literals import AgreementStatusTypeType

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

Typed dictionaries

Type annotations for typed dictionaries used in methods and schema.

Usage example
from types_aiobotocore_transfer.type_defs import As2ConnectorConfigTypeDef

def get_value() -> As2ConnectorConfigTypeDef:
    return {
        "LocalProfileId": ...,
    }