Waiters

Index > Transfer > Waiters

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

ServerOfflineWaiter

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

# ServerOfflineWaiter usage example

from boto3.session import Session

from mypy_boto3_transfer.waiter import ServerOfflineWaiter


session = Session()

client = session.client("transfer")  # (1)
waiter: ServerOfflineWaiter = client.get_waiter("server_offline")  # (2)
await waiter.wait()

1. client: TransferClient
2. waiter: ServerOfflineWaiter

wait

Type annotations and code completion for ServerOfflineWaiter.wait method.

# wait method definition

def wait(
    self,
    *,
    ServerId: str,
    WaiterConfig: WaiterConfigTypeDef = ...,  # (1)
) -> None:
    ...

1. See WaiterConfigTypeDef

# wait method usage example with argument unpacking

kwargs: DescribeServerRequestServerOfflineWaitTypeDef = {  # (1)
    "ServerId": ...,
}

parent.wait(**kwargs)

1. See DescribeServerRequestServerOfflineWaitTypeDef

ServerOnlineWaiter

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

# ServerOnlineWaiter usage example

from boto3.session import Session

from mypy_boto3_transfer.waiter import ServerOnlineWaiter


session = Session()

client = session.client("transfer")  # (1)
waiter: ServerOnlineWaiter = client.get_waiter("server_online")  # (2)
await waiter.wait()

1. client: TransferClient
2. waiter: ServerOnlineWaiter

wait

Type annotations and code completion for ServerOnlineWaiter.wait method.

# wait method definition

def wait(
    self,
    *,
    ServerId: str,
    WaiterConfig: WaiterConfigTypeDef = ...,  # (1)
) -> None:
    ...

1. See WaiterConfigTypeDef

# wait method usage example with argument unpacking

kwargs: DescribeServerRequestServerOnlineWaitTypeDef = {  # (1)
    "ServerId": ...,
}

parent.wait(**kwargs)

1. See DescribeServerRequestServerOnlineWaitTypeDef