Skip to content

Waiters#

Index > RDS > Waiters

Auto-generated documentation for RDS type annotations stubs module mypy-boto3-rds.

DBClusterAvailableWaiter#

Type annotations and code completion for boto3.client("rds").get_waiter("db_cluster_available"). boto3 documentation

# DBClusterAvailableWaiter usage example

from boto3.session import Session

from mypy_boto3_rds.waiter import DBClusterAvailableWaiter


session = Session()

client = session.client("rds")  # (1)
waiter: DBClusterAvailableWaiter = client.get_waiter("db_cluster_available")  # (2)
await waiter.wait()
  1. client: RDSClient
  2. waiter: DBClusterAvailableWaiter

wait#

Type annotations and code completion for DBClusterAvailableWaiter.wait method.

# wait method definition

def wait(
    self,
    *,
    DBClusterIdentifier: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
    IncludeShared: bool = ...,
    WaiterConfig: WaiterConfigTypeDef = ...,  # (2)
) -> None:
    ...
  1. See FilterTypeDef
  2. See WaiterConfigTypeDef 
# wait method usage example with argument unpacking

kwargs: DescribeDBClustersMessageDBClusterAvailableWaitTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
}

parent.wait(**kwargs)
  1. See DescribeDBClustersMessageDBClusterAvailableWaitTypeDef

DBClusterDeletedWaiter#

Type annotations and code completion for boto3.client("rds").get_waiter("db_cluster_deleted"). boto3 documentation

# DBClusterDeletedWaiter usage example

from boto3.session import Session

from mypy_boto3_rds.waiter import DBClusterDeletedWaiter


session = Session()

client = session.client("rds")  # (1)
waiter: DBClusterDeletedWaiter = client.get_waiter("db_cluster_deleted")  # (2)
await waiter.wait()
  1. client: RDSClient
  2. waiter: DBClusterDeletedWaiter

wait#

Type annotations and code completion for DBClusterDeletedWaiter.wait method.

# wait method definition

def wait(
    self,
    *,
    DBClusterIdentifier: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
    IncludeShared: bool = ...,
    WaiterConfig: WaiterConfigTypeDef = ...,  # (2)
) -> None:
    ...
  1. See FilterTypeDef
  2. See WaiterConfigTypeDef 
# wait method usage example with argument unpacking

kwargs: DescribeDBClustersMessageDBClusterDeletedWaitTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
}

parent.wait(**kwargs)
  1. See DescribeDBClustersMessageDBClusterDeletedWaitTypeDef

DBClusterSnapshotAvailableWaiter#

Type annotations and code completion for boto3.client("rds").get_waiter("db_cluster_snapshot_available"). boto3 documentation

# DBClusterSnapshotAvailableWaiter usage example

from boto3.session import Session

from mypy_boto3_rds.waiter import DBClusterSnapshotAvailableWaiter


session = Session()

client = session.client("rds")  # (1)
waiter: DBClusterSnapshotAvailableWaiter = client.get_waiter("db_cluster_snapshot_available")  # (2)
await waiter.wait()
  1. client: RDSClient
  2. waiter: DBClusterSnapshotAvailableWaiter

wait#

Type annotations and code completion for DBClusterSnapshotAvailableWaiter.wait method.

# wait method definition

def wait(
    self,
    *,
    DBClusterIdentifier: str = ...,
    DBClusterSnapshotIdentifier: str = ...,
    SnapshotType: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
    IncludeShared: bool = ...,
    IncludePublic: bool = ...,
    DbClusterResourceId: str = ...,
    WaiterConfig: WaiterConfigTypeDef = ...,  # (2)
) -> None:
    ...
  1. See FilterTypeDef
  2. See WaiterConfigTypeDef 
# wait method usage example with argument unpacking

kwargs: DescribeDBClusterSnapshotsMessageDBClusterSnapshotAvailableWaitTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
}

parent.wait(**kwargs)
  1. See DescribeDBClusterSnapshotsMessageDBClusterSnapshotAvailableWaitTypeDef

DBClusterSnapshotDeletedWaiter#

Type annotations and code completion for boto3.client("rds").get_waiter("db_cluster_snapshot_deleted"). boto3 documentation

# DBClusterSnapshotDeletedWaiter usage example

from boto3.session import Session

from mypy_boto3_rds.waiter import DBClusterSnapshotDeletedWaiter


session = Session()

client = session.client("rds")  # (1)
waiter: DBClusterSnapshotDeletedWaiter = client.get_waiter("db_cluster_snapshot_deleted")  # (2)
await waiter.wait()
  1. client: RDSClient
  2. waiter: DBClusterSnapshotDeletedWaiter

wait#

Type annotations and code completion for DBClusterSnapshotDeletedWaiter.wait method.

# wait method definition

def wait(
    self,
    *,
    DBClusterIdentifier: str = ...,
    DBClusterSnapshotIdentifier: str = ...,
    SnapshotType: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
    IncludeShared: bool = ...,
    IncludePublic: bool = ...,
    DbClusterResourceId: str = ...,
    WaiterConfig: WaiterConfigTypeDef = ...,  # (2)
) -> None:
    ...
  1. See FilterTypeDef
  2. See WaiterConfigTypeDef 
# wait method usage example with argument unpacking

kwargs: DescribeDBClusterSnapshotsMessageDBClusterSnapshotDeletedWaitTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
}

parent.wait(**kwargs)
  1. See DescribeDBClusterSnapshotsMessageDBClusterSnapshotDeletedWaitTypeDef

DBInstanceAvailableWaiter#

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

# DBInstanceAvailableWaiter usage example

from boto3.session import Session

from mypy_boto3_rds.waiter import DBInstanceAvailableWaiter


session = Session()

client = session.client("rds")  # (1)
waiter: DBInstanceAvailableWaiter = client.get_waiter("db_instance_available")  # (2)
await waiter.wait()
  1. client: RDSClient
  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 FilterTypeDef
  2. See WaiterConfigTypeDef 
# wait method usage example with argument unpacking

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

parent.wait(**kwargs)
  1. See DescribeDBInstancesMessageDBInstanceAvailableWaitTypeDef

DBInstanceDeletedWaiter#

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

# DBInstanceDeletedWaiter usage example

from boto3.session import Session

from mypy_boto3_rds.waiter import DBInstanceDeletedWaiter


session = Session()

client = session.client("rds")  # (1)
waiter: DBInstanceDeletedWaiter = client.get_waiter("db_instance_deleted")  # (2)
await waiter.wait()
  1. client: RDSClient
  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 FilterTypeDef
  2. See WaiterConfigTypeDef 
# wait method usage example with argument unpacking

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

parent.wait(**kwargs)
  1. See DescribeDBInstancesMessageDBInstanceDeletedWaitTypeDef

DBSnapshotAvailableWaiter#

Type annotations and code completion for boto3.client("rds").get_waiter("db_snapshot_available"). boto3 documentation

# DBSnapshotAvailableWaiter usage example

from boto3.session import Session

from mypy_boto3_rds.waiter import DBSnapshotAvailableWaiter


session = Session()

client = session.client("rds")  # (1)
waiter: DBSnapshotAvailableWaiter = client.get_waiter("db_snapshot_available")  # (2)
await waiter.wait()
  1. client: RDSClient
  2. waiter: DBSnapshotAvailableWaiter

wait#

Type annotations and code completion for DBSnapshotAvailableWaiter.wait method.

# wait method definition

def wait(
    self,
    *,
    DBInstanceIdentifier: str = ...,
    DBSnapshotIdentifier: str = ...,
    SnapshotType: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
    IncludeShared: bool = ...,
    IncludePublic: bool = ...,
    DbiResourceId: str = ...,
    WaiterConfig: WaiterConfigTypeDef = ...,  # (2)
) -> None:
    ...
  1. See FilterTypeDef
  2. See WaiterConfigTypeDef 
# wait method usage example with argument unpacking

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

parent.wait(**kwargs)
  1. See DescribeDBSnapshotsMessageDBSnapshotAvailableWaitTypeDef

DBSnapshotCompletedWaiter#

Type annotations and code completion for boto3.client("rds").get_waiter("db_snapshot_completed"). boto3 documentation

# DBSnapshotCompletedWaiter usage example

from boto3.session import Session

from mypy_boto3_rds.waiter import DBSnapshotCompletedWaiter


session = Session()

client = session.client("rds")  # (1)
waiter: DBSnapshotCompletedWaiter = client.get_waiter("db_snapshot_completed")  # (2)
await waiter.wait()
  1. client: RDSClient
  2. waiter: DBSnapshotCompletedWaiter

wait#

Type annotations and code completion for DBSnapshotCompletedWaiter.wait method.

# wait method definition

def wait(
    self,
    *,
    DBInstanceIdentifier: str = ...,
    DBSnapshotIdentifier: str = ...,
    SnapshotType: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
    IncludeShared: bool = ...,
    IncludePublic: bool = ...,
    DbiResourceId: str = ...,
    WaiterConfig: WaiterConfigTypeDef = ...,  # (2)
) -> None:
    ...
  1. See FilterTypeDef
  2. See WaiterConfigTypeDef 
# wait method usage example with argument unpacking

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

parent.wait(**kwargs)
  1. See DescribeDBSnapshotsMessageDBSnapshotCompletedWaitTypeDef

DBSnapshotDeletedWaiter#

Type annotations and code completion for boto3.client("rds").get_waiter("db_snapshot_deleted"). boto3 documentation

# DBSnapshotDeletedWaiter usage example

from boto3.session import Session

from mypy_boto3_rds.waiter import DBSnapshotDeletedWaiter


session = Session()

client = session.client("rds")  # (1)
waiter: DBSnapshotDeletedWaiter = client.get_waiter("db_snapshot_deleted")  # (2)
await waiter.wait()
  1. client: RDSClient
  2. waiter: DBSnapshotDeletedWaiter

wait#

Type annotations and code completion for DBSnapshotDeletedWaiter.wait method.

# wait method definition

def wait(
    self,
    *,
    DBInstanceIdentifier: str = ...,
    DBSnapshotIdentifier: str = ...,
    SnapshotType: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
    IncludeShared: bool = ...,
    IncludePublic: bool = ...,
    DbiResourceId: str = ...,
    WaiterConfig: WaiterConfigTypeDef = ...,  # (2)
) -> None:
    ...
  1. See FilterTypeDef
  2. See WaiterConfigTypeDef 
# wait method usage example with argument unpacking

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

parent.wait(**kwargs)
  1. See DescribeDBSnapshotsMessageDBSnapshotDeletedWaitTypeDef

TenantDatabaseAvailableWaiter#

Type annotations and code completion for boto3.client("rds").get_waiter("tenant_database_available"). boto3 documentation

# TenantDatabaseAvailableWaiter usage example

from boto3.session import Session

from mypy_boto3_rds.waiter import TenantDatabaseAvailableWaiter


session = Session()

client = session.client("rds")  # (1)
waiter: TenantDatabaseAvailableWaiter = client.get_waiter("tenant_database_available")  # (2)
await waiter.wait()
  1. client: RDSClient
  2. waiter: TenantDatabaseAvailableWaiter

wait#

Type annotations and code completion for TenantDatabaseAvailableWaiter.wait method.

# wait method definition

def wait(
    self,
    *,
    DBInstanceIdentifier: str = ...,
    TenantDBName: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    Marker: str = ...,
    MaxRecords: int = ...,
    WaiterConfig: WaiterConfigTypeDef = ...,  # (2)
) -> None:
    ...
  1. See FilterTypeDef
  2. See WaiterConfigTypeDef 
# wait method usage example with argument unpacking

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

parent.wait(**kwargs)
  1. See DescribeTenantDatabasesMessageTenantDatabaseAvailableWaitTypeDef

TenantDatabaseDeletedWaiter#

Type annotations and code completion for boto3.client("rds").get_waiter("tenant_database_deleted"). boto3 documentation

# TenantDatabaseDeletedWaiter usage example

from boto3.session import Session

from mypy_boto3_rds.waiter import TenantDatabaseDeletedWaiter


session = Session()

client = session.client("rds")  # (1)
waiter: TenantDatabaseDeletedWaiter = client.get_waiter("tenant_database_deleted")  # (2)
await waiter.wait()
  1. client: RDSClient
  2. waiter: TenantDatabaseDeletedWaiter

wait#

Type annotations and code completion for TenantDatabaseDeletedWaiter.wait method.

# wait method definition

def wait(
    self,
    *,
    DBInstanceIdentifier: str = ...,
    TenantDBName: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    Marker: str = ...,
    MaxRecords: int = ...,
    WaiterConfig: WaiterConfigTypeDef = ...,  # (2)
) -> None:
    ...
  1. See FilterTypeDef
  2. See WaiterConfigTypeDef 
# wait method usage example with argument unpacking

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

parent.wait(**kwargs)
  1. See DescribeTenantDatabasesMessageTenantDatabaseDeletedWaitTypeDef