Source code for

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

from __future__ import annotations

from functools import cached_property
from typing import TYPE_CHECKING

from airflow.exceptions import AirflowOptionalProviderFeatureException
from import ChimeWebhookHook

    from airflow.utils.context import Context

    from airflow.notifications.basenotifier import BaseNotifier
except ImportError:
    raise AirflowOptionalProviderFeatureException(
        "Failed to import BaseNotifier. This feature is only available in Airflow versions >= 2.6.0"

[docs]class ChimeNotifier(BaseNotifier): """ Chime notifier to send messages to a chime room via callbacks. :param chime_conn_id: The chime connection to use with Endpoint as "" and the webhook token in the form of ```{}?token{webhook.token}``` :param message: The message to send to the chime room associated with the webhook. """
[docs] template_fields = ("message",)
def __init__(self, *, chime_conn_id: str, message: str = "This is the default chime notifier message"): super().__init__() self.chime_conn_id = chime_conn_id self.message = message @cached_property
[docs] def hook(self): """To reduce overhead cache the hook for the notifier.""" return ChimeWebhookHook(chime_conn_id=self.chime_conn_id)
[docs] def notify(self, context: Context) -> None: # type: ignore[override] """Send a message to a Chime Chat Room.""" self.hook.send_message(message=self.message)
[docs]send_chime_notification = ChimeNotifier

Was this entry helpful?