Skip to content

Waiters#

Index > ElastiCache > Waiters

Auto-generated documentation for ElastiCache type annotations stubs module types-boto3-elasticache.

CacheClusterAvailableWaiter#

Type annotations and code completion for boto3.client("elasticache").get_waiter("cache_cluster_available"). boto3 documentation

# CacheClusterAvailableWaiter usage example

from boto3.session import Session

from types_boto3_elasticache.waiter import CacheClusterAvailableWaiter


session = Session()

client = session.client("elasticache")  # (1)
waiter: CacheClusterAvailableWaiter = client.get_waiter("cache_cluster_available")  # (2)
await waiter.wait(...)
  1. client: ElastiCacheClient
  2. waiter: CacheClusterAvailableWaiter

wait#

Type annotations and code completion for CacheClusterAvailableWaiter.wait method.

# wait method definition

def wait(
    self,
    *,
    CacheClusterId: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
    ShowCacheNodeInfo: bool = ...,
    ShowCacheClustersNotInReplicationGroups: bool = ...,
    WaiterConfig: WaiterConfigTypeDef = ...,  # (1)
) -> None:
    ...
  1. See WaiterConfigTypeDef
# wait method usage example with argument unpacking

kwargs: DescribeCacheClustersMessageWaitTypeDef = {  # (1)
    "CacheClusterId": ...,
}

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

CacheClusterDeletedWaiter#

Type annotations and code completion for boto3.client("elasticache").get_waiter("cache_cluster_deleted"). boto3 documentation

# CacheClusterDeletedWaiter usage example

from boto3.session import Session

from types_boto3_elasticache.waiter import CacheClusterDeletedWaiter


session = Session()

client = session.client("elasticache")  # (1)
waiter: CacheClusterDeletedWaiter = client.get_waiter("cache_cluster_deleted")  # (2)
await waiter.wait(...)
  1. client: ElastiCacheClient
  2. waiter: CacheClusterDeletedWaiter

wait#

Type annotations and code completion for CacheClusterDeletedWaiter.wait method.

# wait method definition

def wait(
    self,
    *,
    CacheClusterId: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
    ShowCacheNodeInfo: bool = ...,
    ShowCacheClustersNotInReplicationGroups: bool = ...,
    WaiterConfig: WaiterConfigTypeDef = ...,  # (1)
) -> None:
    ...
  1. See WaiterConfigTypeDef
# wait method usage example with argument unpacking

kwargs: DescribeCacheClustersMessageWaitExtraTypeDef = {  # (1)
    "CacheClusterId": ...,
}

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

ReplicationGroupAvailableWaiter#

Type annotations and code completion for boto3.client("elasticache").get_waiter("replication_group_available"). boto3 documentation

# ReplicationGroupAvailableWaiter usage example

from boto3.session import Session

from types_boto3_elasticache.waiter import ReplicationGroupAvailableWaiter


session = Session()

client = session.client("elasticache")  # (1)
waiter: ReplicationGroupAvailableWaiter = client.get_waiter("replication_group_available")  # (2)
await waiter.wait(...)
  1. client: ElastiCacheClient
  2. waiter: ReplicationGroupAvailableWaiter

wait#

Type annotations and code completion for ReplicationGroupAvailableWaiter.wait method.

# wait method definition

def wait(
    self,
    *,
    ReplicationGroupId: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
    WaiterConfig: WaiterConfigTypeDef = ...,  # (1)
) -> None:
    ...
  1. See WaiterConfigTypeDef
# wait method usage example with argument unpacking

kwargs: DescribeReplicationGroupsMessageWaitTypeDef = {  # (1)
    "ReplicationGroupId": ...,
}

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

ReplicationGroupDeletedWaiter#

Type annotations and code completion for boto3.client("elasticache").get_waiter("replication_group_deleted"). boto3 documentation

# ReplicationGroupDeletedWaiter usage example

from boto3.session import Session

from types_boto3_elasticache.waiter import ReplicationGroupDeletedWaiter


session = Session()

client = session.client("elasticache")  # (1)
waiter: ReplicationGroupDeletedWaiter = client.get_waiter("replication_group_deleted")  # (2)
await waiter.wait(...)
  1. client: ElastiCacheClient
  2. waiter: ReplicationGroupDeletedWaiter

wait#

Type annotations and code completion for ReplicationGroupDeletedWaiter.wait method.

# wait method definition

def wait(
    self,
    *,
    ReplicationGroupId: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
    WaiterConfig: WaiterConfigTypeDef = ...,  # (1)
) -> None:
    ...
  1. See WaiterConfigTypeDef
# wait method usage example with argument unpacking

kwargs: DescribeReplicationGroupsMessageWaitExtraTypeDef = {  # (1)
    "ReplicationGroupId": ...,
}

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