Skip to content

Waiters#

Index > Transfer > Waiters

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

ServerOfflineWaiter#

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

# ServerOfflineWaiter usage example

from aiobotocore.session import Session

from types_aiobotocore_transfer.waiter import ServerOfflineWaiter

session = get_session()
async with session.create_client("transfer") as client:  # (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

await 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 session.create_client("transfer").get_waiter("server_online"). boto3 documentation

# ServerOnlineWaiter usage example

from aiobotocore.session import Session

from types_aiobotocore_transfer.waiter import ServerOnlineWaiter

session = get_session()
async with session.create_client("transfer") as client:  # (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

await 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