TransferClient

Index > Transfer > TransferClient

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

TransferClient

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

# TransferClient usage example

from boto3.session import Session
from mypy_boto3_transfer.client import TransferClient

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

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("transfer").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("transfer")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServiceError,
    client.exceptions.InvalidNextTokenException,
    client.exceptions.InvalidRequestException,
    client.exceptions.ResourceExistsException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceUnavailableException,
    client.exceptions.ThrottlingException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_transfer.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("transfer").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("transfer").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_access

Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Transfer Family.

Type annotations and code completion for boto3.client("transfer").create_access method. boto3 documentation

# create_access method definition

def create_access(
    self,
    *,
    Role: str,
    ServerId: str,
    ExternalId: str,
    HomeDirectory: str = ...,
    HomeDirectoryType: HomeDirectoryTypeType = ...,  # (1)
    HomeDirectoryMappings: Sequence[HomeDirectoryMapEntryTypeDef] = ...,  # (2)
    Policy: str = ...,
    PosixProfile: Union[PosixProfileTypeDef, PosixProfileOutputTypeDef] = ...,  # (3)
) -> CreateAccessResponseTypeDef:  # (4)
    ...

1. See HomeDirectoryTypeType
2. See HomeDirectoryMapEntryTypeDef
3. See PosixProfileTypeDef PosixProfileOutputTypeDef
4. See CreateAccessResponseTypeDef

# create_access method usage example with argument unpacking

kwargs: CreateAccessRequestRequestTypeDef = {  # (1)
    "Role": ...,
    "ServerId": ...,
    "ExternalId": ...,
}

parent.create_access(**kwargs)

1. See CreateAccessRequestRequestTypeDef

create_agreement

Creates an agreement.

Type annotations and code completion for boto3.client("transfer").create_agreement method.