Skip to content

Waiters#

Index > CloudWatch > Waiters

Auto-generated documentation for CloudWatch type annotations stubs module types-boto3-cloudwatch.

AlarmExistsWaiter#

Type annotations and code completion for boto3.client("cloudwatch").get_waiter("alarm_exists"). boto3 documentation

# AlarmExistsWaiter usage example

from boto3.session import Session

from types_boto3_cloudwatch.waiter import AlarmExistsWaiter


session = Session()

client = session.client("cloudwatch")  # (1)
waiter: AlarmExistsWaiter = client.get_waiter("alarm_exists")  # (2)
await waiter.wait(...)
  1. client: CloudWatchClient
  2. waiter: AlarmExistsWaiter

wait#

Type annotations and code completion for AlarmExistsWaiter.wait method.

# wait method definition

def wait(
    self,
    *,
    AlarmNames: Sequence[str] = ...,
    AlarmNamePrefix: str = ...,
    AlarmTypes: Sequence[AlarmTypeType] = ...,  # (1)
    ChildrenOfAlarmName: str = ...,
    ParentsOfAlarmName: str = ...,
    StateValue: StateValueType = ...,  # (2)
    ActionPrefix: str = ...,
    MaxRecords: int = ...,
    NextToken: str = ...,
    WaiterConfig: WaiterConfigTypeDef = ...,  # (3)
) -> None:
    ...
  1. See Sequence[AlarmTypeType]
  2. See StateValueType
  3. See WaiterConfigTypeDef
# wait method usage example with argument unpacking

kwargs: DescribeAlarmsInputWaitTypeDef = {  # (1)
    "AlarmNames": ...,
}

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

CompositeAlarmExistsWaiter#

Type annotations and code completion for boto3.client("cloudwatch").get_waiter("composite_alarm_exists"). boto3 documentation

# CompositeAlarmExistsWaiter usage example

from boto3.session import Session

from types_boto3_cloudwatch.waiter import CompositeAlarmExistsWaiter


session = Session()

client = session.client("cloudwatch")  # (1)
waiter: CompositeAlarmExistsWaiter = client.get_waiter("composite_alarm_exists")  # (2)
await waiter.wait(...)
  1. client: CloudWatchClient
  2. waiter: CompositeAlarmExistsWaiter

wait#

Type annotations and code completion for CompositeAlarmExistsWaiter.wait method.

# wait method definition

def wait(
    self,
    *,
    AlarmNames: Sequence[str] = ...,
    AlarmNamePrefix: str = ...,
    AlarmTypes: Sequence[AlarmTypeType] = ...,  # (1)
    ChildrenOfAlarmName: str = ...,
    ParentsOfAlarmName: str = ...,
    StateValue: StateValueType = ...,  # (2)
    ActionPrefix: str = ...,
    MaxRecords: int = ...,
    NextToken: str = ...,
    WaiterConfig: WaiterConfigTypeDef = ...,  # (3)
) -> None:
    ...
  1. See Sequence[AlarmTypeType]
  2. See StateValueType
  3. See WaiterConfigTypeDef
# wait method usage example with argument unpacking

kwargs: DescribeAlarmsInputWaitExtraTypeDef = {  # (1)
    "AlarmNames": ...,
}

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