Skip to content

iter_describe_alarms

iter_describe_alarms(
    *,
    config_overrides: Optional[CloudWatchClientConfig] = None,
    alarm_names: Optional[AlarmNames] = None,
    alarm_name_prefix: Optional[AlarmNamePrefix] = None,
    alarm_types: Optional[AlarmTypes] = None,
    children_of_alarm_name: Optional[AlarmName] = None,
    parents_of_alarm_name: Optional[AlarmName] = None,
    state_value: Optional[StateValue] = None,
    action_prefix: Optional[ActionPrefix] = None,
    max_records: Optional[MaxRecords] = None,
    next_token: Optional[NextToken] = None,
) -> Iterator[DescribeAlarmsOutput]
Source code in docs_src/capo_cloudwatch/_services/cloud_watch.py
def iter_describe_alarms(
    self,
    *,
    config_overrides: Optional[CloudWatchClientConfig] = None,
    alarm_names: Optional["capo_cloudwatch.types.alarm_names.AlarmNames"] = None,
    alarm_name_prefix: Optional[
        "capo_cloudwatch.types.alarm_name_prefix.AlarmNamePrefix"
    ] = None,
    alarm_types: Optional["capo_cloudwatch.types.alarm_types.AlarmTypes"] = None,
    children_of_alarm_name: Optional[
        "capo_cloudwatch.types.alarm_name.AlarmName"
    ] = None,
    parents_of_alarm_name: Optional[
        "capo_cloudwatch.types.alarm_name.AlarmName"
    ] = None,
    state_value: Optional["capo_cloudwatch.types.state_value.StateValue"] = None,
    action_prefix: Optional[
        "capo_cloudwatch.types.action_prefix.ActionPrefix"
    ] = None,
    max_records: Optional["capo_cloudwatch.types.max_records.MaxRecords"] = None,
    next_token: Optional["capo_cloudwatch.types.next_token.NextToken"] = None,
) -> "Iterator[capo_cloudwatch.types.describe_alarms_output.DescribeAlarmsOutput]":
    _token = next_token
    while True:
        _response = self.describe_alarms(
            config_overrides=config_overrides,
            alarm_names=alarm_names,
            alarm_name_prefix=alarm_name_prefix,
            alarm_types=alarm_types,
            children_of_alarm_name=children_of_alarm_name,
            parents_of_alarm_name=parents_of_alarm_name,
            state_value=state_value,
            action_prefix=action_prefix,
            max_records=max_records,
            next_token=_token,
        )
        yield _response
        _token = _resolve_path(_response, ("next_token",))
        if not _token:
            break