Skip to content

Transfer module#

Index > Transfer

Auto-generated documentation for Transfer type annotations stubs module mypy-boto3-transfer.

How to install#

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and Transfer.

From PyPI with pip#

Install boto3-stubs for Transfer service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[transfer]'


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


# standalone installation
python -m pip install mypy-boto3-transfer

How to uninstall#

python -m pip uninstall -y mypy-boto3-transfer

Usage#

Code samples can be found in Examples.

TransferClient#

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

# TransferClient usage example

from boto3.session import Session

from mypy_boto3_transfer.client import TransferClient

def get_client() -> TransferClient:
    return Session().client("transfer")

Paginators#

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

# ListAccessesPaginator usage example

from boto3.session import Session

from mypy_boto3_transfer.paginator import ListAccessesPaginator

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

Waiters#

Type annotations and code completion for waiters from boto3.client("transfer").get_waiter("...").

# ServerOfflineWaiter usage example

from boto3.session import Session

from mypy_boto3_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 schemas.

# AgreementStatusTypeType usage example

from mypy_boto3_transfer.literals import AgreementStatusTypeType

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

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# As2ConnectorConfigTypeDef usage example

from mypy_boto3_transfer.type_defs import As2ConnectorConfigTypeDef

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