Source code for airflow.contrib.operators.sns_publish_operator
# -*- coding: utf-8 -*-
#
# 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
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
from airflow.contrib.hooks.aws_sns_hook import AwsSnsHook
from airflow.models import BaseOperator
from airflow.utils.decorators import apply_defaults
[docs]class SnsPublishOperator(BaseOperator):
"""
Publish a message to Amazon SNS.
:param aws_conn_id: aws connection to use
:type aws_conn_id: str
:param target_arn: either a TopicArn or an EndpointArn
:type target_arn: str
:param message: the default message you want to send (templated)
:type message: str
:param subject: the message subject you want to send (templated)
:type subject: str
:param message_attributes: the message attributes you want to send as a flat dict (data type will be
determined automatically)
:type message_attributes: dict
"""
[docs] template_fields = ['message', 'subject', 'message_attributes']
@apply_defaults
def __init__(
self,
target_arn,
message,
aws_conn_id='aws_default',
subject=None,
message_attributes=None,
*args, **kwargs):
super(SnsPublishOperator, self).__init__(*args, **kwargs)
self.target_arn = target_arn
self.message = message
self.subject = subject
self.message_attributes = message_attributes
self.aws_conn_id = aws_conn_id
[docs] def execute(self, context):
sns = AwsSnsHook(aws_conn_id=self.aws_conn_id)
self.log.info(
'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 sns.publish_to_target(
target_arn=self.target_arn,
message=self.message,
subject=self.subject,
message_attributes=self.message_attributes,
)