Skip to content

iter_describe_alarm_history

iter_describe_alarm_history(
    *,
    config_overrides: Optional[CloudWatchClientConfig] = None,
    alarm_name: Optional[AlarmName] = None,
    alarm_contributor_id: Optional[ContributorId] = None,
    alarm_types: Optional[AlarmTypes] = None,
    history_item_type: Optional[HistoryItemType] = None,
    start_date: Optional[Timestamp] = None,
    end_date: Optional[Timestamp] = None,
    max_records: Optional[MaxRecords] = None,
    next_token: Optional[NextToken] = None,
    scan_by: Optional[ScanBy] = None,
) -> Iterator[AlarmHistoryItem]
Source code in docs_src/capo_cloudwatch/_services/cloud_watch.py
def iter_describe_alarm_history(
    self,
    *,
    config_overrides: Optional[CloudWatchClientConfig] = None,
    alarm_name: Optional["capo_cloudwatch.types.alarm_name.AlarmName"] = None,
    alarm_contributor_id: Optional[
        "capo_cloudwatch.types.contributor_id.ContributorId"
    ] = None,
    alarm_types: Optional["capo_cloudwatch.types.alarm_types.AlarmTypes"] = None,
    history_item_type: Optional[
        "capo_cloudwatch.types.history_item_type.HistoryItemType"
    ] = None,
    start_date: Optional["capo_cloudwatch.types.timestamp.Timestamp"] = None,
    end_date: Optional["capo_cloudwatch.types.timestamp.Timestamp"] = None,
    max_records: Optional["capo_cloudwatch.types.max_records.MaxRecords"] = None,
    next_token: Optional["capo_cloudwatch.types.next_token.NextToken"] = None,
    scan_by: Optional["capo_cloudwatch.types.scan_by.ScanBy"] = None,
) -> "Iterator[capo_cloudwatch.types.alarm_history_item.AlarmHistoryItem]":
    _token = next_token
    while True:
        _response = self.describe_alarm_history(
            config_overrides=config_overrides,
            alarm_name=alarm_name,
            alarm_contributor_id=alarm_contributor_id,
            alarm_types=alarm_types,
            history_item_type=history_item_type,
            start_date=start_date,
            end_date=end_date,
            max_records=max_records,
            next_token=_token,
            scan_by=scan_by,
        )
        _page = _resolve_path(_response, ("alarm_history_items",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("next_token",))
        if not _token:
            break