Waiters

Index > DocDB > Waiters

Auto-generated documentation for DocDB type annotations stubs module types-boto3-docdb.

DBInstanceAvailableWaiter

Type annotations and code completion for boto3.client("docdb").get_waiter("db_instance_available"). boto3 documentation

# DBInstanceAvailableWaiter usage example

from boto3.session import Session

from types_boto3_docdb.waiter import DBInstanceAvailableWaiter


session = Session()

client = session.client("docdb")  # (1)
waiter: DBInstanceAvailableWaiter = client.get_waiter("db_instance_available")  # (2)
await waiter.wait(...)

1. client: DocDBClient
2. waiter: DBInstanceAvailableWaiter

wait

Type annotations and code completion for DBInstanceAvailableWaiter.wait method.

# wait method definition

def wait(
    self,
    *,
    DBInstanceIdentifier: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
    WaiterConfig: WaiterConfigTypeDef = ...,  # (2)
) -> None:
    ...

1. See Sequence[FilterTypeDef]
2. See WaiterConfigTypeDef

# wait method usage example with argument unpacking

kwargs: DescribeDBInstancesMessageWaitTypeDef = {  # (1)
    "DBInstanceIdentifier": ...,
}

parent.wait(**kwargs)

1. See DescribeDBInstancesMessageWaitTypeDef

DBInstanceDeletedWaiter

Type annotations and code completion for boto3.client("docdb").get_waiter("db_instance_deleted"). boto3 documentation

# DBInstanceDeletedWaiter usage example

from boto3.session import Session

from types_boto3_docdb.waiter import DBInstanceDeletedWaiter


session = Session()

client = session.client("docdb")  # (1)
waiter: DBInstanceDeletedWaiter = client.get_waiter("db_instance_deleted")  # (2)
await waiter.wait(...)

1. client: DocDBClient
2. waiter: DBInstanceDeletedWaiter

wait

Type annotations and code completion for DBInstanceDeletedWaiter.wait method.

# wait method definition

def wait(
    self,
    *,
    DBInstanceIdentifier: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
    WaiterConfig: WaiterConfigTypeDef = ...,  # (2)
) -> None:
    ...

1. See Sequence[FilterTypeDef]
2. See WaiterConfigTypeDef

# wait method usage example with argument unpacking

kwargs: DescribeDBInstancesMessageWaitExtraTypeDef = {  # (1)
    "DBInstanceIdentifier": ...,
}

parent.wait(**kwargs)

1. See DescribeDBInstancesMessageWaitExtraTypeDef