Waiters

Index > Redshift > Waiters

Auto-generated documentation for Redshift type annotations stubs module mypy-boto3-redshift.

ClusterAvailableWaiter

Type annotations and code completion for boto3.client("redshift").get_waiter("cluster_available"). boto3 documentation

Usage example

from boto3.session import Session

from mypy_boto3_redshift.waiter import ClusterAvailableWaiter


session = Session()

client = session.client("redshift")  # (1)
waiter: ClusterAvailableWaiter = client.get_waiter("cluster_available")  # (2)
await waiter.wait()

1. client: RedshiftClient
2. waiter: ClusterAvailableWaiter

wait

Type annotations and code completion for ClusterAvailableWaiter.wait method.

Method definition

def wait(
    self,
    *,
    ClusterIdentifier: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
    TagKeys: Sequence[str] = ...,
    TagValues: Sequence[str] = ...,
    WaiterConfig: WaiterConfigTypeDef = ...,  # (1)
) -> None:
    ...

1. See WaiterConfigTypeDef

Usage example with kwargs

kwargs: DescribeClustersMessageClusterAvailableWaitTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.wait(**kwargs)

1. See DescribeClustersMessageClusterAvailableWaitTypeDef

ClusterDeletedWaiter

Type annotations and code completion for boto3.client("redshift").get_waiter("cluster_deleted"). boto3 documentation

Usage example

from boto3.session import Session

from mypy_boto3_redshift.waiter import ClusterDeletedWaiter


session = Session()

client = session.client("redshift")  # (1)
waiter: ClusterDeletedWaiter = client.get_waiter("cluster_deleted")  # (2)
await waiter.wait()

1. client: RedshiftClient
2. waiter: ClusterDeletedWaiter

wait

Type annotations and code completion for ClusterDeletedWaiter.wait method.

Method definition

def wait(
    self,
    *,
    ClusterIdentifier: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
    TagKeys: Sequence[str] = ...,
    TagValues: Sequence[str] = ...,
    WaiterConfig: WaiterConfigTypeDef = ...,  # (1)
) -> None:
    ...

1. See WaiterConfigTypeDef

Usage example with kwargs

kwargs: DescribeClustersMessageClusterDeletedWaitTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.wait(**kwargs)

1. See DescribeClustersMessageClusterDeletedWaitTypeDef

ClusterRestoredWaiter

Type annotations and code completion for boto3.client("redshift").get_waiter("cluster_restored"). boto3 documentation

Usage example

from boto3.session import Session

from mypy_boto3_redshift.waiter import ClusterRestoredWaiter


session = Session()

client = session.client("redshift")  # (1)
waiter: ClusterRestoredWaiter = client.get_waiter("cluster_restored")  # (2)
await waiter.wait()

1. client: RedshiftClient
2. waiter: ClusterRestoredWaiter

wait

Type annotations and code completion for ClusterRestoredWaiter.wait method.

Method definition

def wait(
    self,
    *,
    ClusterIdentifier: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
    TagKeys: Sequence[str] = ...,
    TagValues: Sequence[str] = ...,
    WaiterConfig: WaiterConfigTypeDef = ...,  # (1)
) -> None:
    ...

1. See WaiterConfigTypeDef

Usage example with kwargs

kwargs: DescribeClustersMessageClusterRestoredWaitTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.wait(**kwargs)

1. See DescribeClustersMessageClusterRestoredWaitTypeDef

SnapshotAvailableWaiter

Type annotations and code completion for boto3.client("redshift").get_waiter("snapshot_available"). boto3 documentation

Usage example

from boto3.session import Session

from mypy_boto3_redshift.waiter import SnapshotAvailableWaiter


session = Session()

client = session.client("redshift")  # (1)
waiter: SnapshotAvailableWaiter = client.get_waiter("snapshot_available")  # (2)
await waiter.wait()

1. client: RedshiftClient
2. waiter: SnapshotAvailableWaiter

wait

Type annotations and code completion for SnapshotAvailableWaiter.wait method.

Method definition

def wait(
    self,
    *,
    ClusterIdentifier: str = ...,
    SnapshotIdentifier: str = ...,
    SnapshotArn: str = ...,
    SnapshotType: str = ...,
    StartTime: Union[datetime, str] = ...,
    EndTime: Union[datetime, str] = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
    OwnerAccount: str = ...,
    TagKeys: Sequence[str] = ...,
    TagValues: Sequence[str] = ...,
    ClusterExists: bool = ...,
    SortingEntities: Sequence[SnapshotSortingEntityTypeDef] = ...,  # (1)
    WaiterConfig: WaiterConfigTypeDef = ...,  # (2)
) -> None:
    ...

1. See SnapshotSortingEntityTypeDef
2. See WaiterConfigTypeDef

Usage example with kwargs

kwargs: DescribeClusterSnapshotsMessageSnapshotAvailableWaitTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.wait(**kwargs)

1. See DescribeClusterSnapshotsMessageSnapshotAvailableWaitTypeDef