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.
"""Publish message to SNS queue."""

from __future__ import annotations

from typing import TYPE_CHECKING, Sequence

from import SnsHook
from import AwsBaseOperator
from import aws_template_fields

    from airflow.utils.context import Context

[docs]class SnsPublishOperator(AwsBaseOperator[SnsHook]): """ Publish a message to Amazon SNS. .. seealso:: For more information on how to use this operator, take a look at the guide: :ref:`howto/operator:SnsPublishOperator` :param target_arn: either a TopicArn or an EndpointArn :param message: the default message you want to send (templated) :param subject: the message subject you want to send (templated) :param message_attributes: the message attributes you want to send as a flat dict (data type will be determined automatically) :param aws_conn_id: The Airflow connection used for AWS credentials. If this is ``None`` or empty then the default boto3 behaviour is used. If running Airflow in a distributed manner and aws_conn_id is None or empty, then default boto3 configuration would be used (and must be maintained on each worker node). :param region_name: AWS region_name. If not specified then the default boto3 behaviour is used. :param verify: Whether or not to verify SSL certificates. See: :param botocore_config: Configuration dictionary (key-values) for botocore client. See: """
[docs] aws_hook_class = SnsHook
[docs] template_fields: Sequence[str] = aws_template_fields( "target_arn", "message", "subject", "message_attributes", )
[docs] template_fields_renderers = {"message_attributes": "json"}
def __init__( self, *, target_arn: str, message: str, subject: str | None = None, message_attributes: dict | None = None, **kwargs, ): super().__init__(**kwargs) self.target_arn = target_arn self.message = message self.subject = subject self.message_attributes = message_attributes
[docs] def execute(self, context: Context): "Sending SNS notification to %s using %s:\nsubject=%s\nattributes=%s\nmessage=%s", self.target_arn, self.aws_conn_id, self.subject, self.message_attributes, self.message, ) return self.hook.publish_to_target( target_arn=self.target_arn, message=self.message, subject=self.subject, message_attributes=self.message_attributes, )

Was this entry helpful?