# -*- coding: utf-8 -*-
#
# Licensed to the ApachMee 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.models import BaseOperator
from airflow.utils.decorators import apply_defaults
from airflow.contrib.hooks.aws_sqs_hook import SQSHook
[docs]class SQSPublishOperator(BaseOperator):
"""
Publish message to a SQS queue.
:param sqs_queue: The SQS queue url (templated)
:type sqs_queue: str
:param message_content: The message content (templated)
:type message_content: str
:param message_attributes: additional attributes for the message (default: None)
For details of the attributes parameter see :py:meth:`botocore.client.SQS.send_message`
:type message_attributes: dict
:param delay_seconds: message delay (templated) (default: 1 second)
:type delay_seconds: int
:param aws_conn_id: AWS connection id (default: aws_default)
:type aws_conn_id: str
"""
[docs] template_fields = ('sqs_queue', 'message_content', 'delay_seconds')
@apply_defaults
def __init__(self,
sqs_queue,
message_content,
message_attributes=None,
delay_seconds=0,
aws_conn_id='aws_default',
*args,
**kwargs):
super(SQSPublishOperator, self).__init__(*args, **kwargs)
self.sqs_queue = sqs_queue
self.aws_conn_id = aws_conn_id
self.message_content = message_content
self.delay_seconds = delay_seconds
self.message_attributes = message_attributes or {}
[docs] def execute(self, context):
"""
Publish the message to SQS queue
:param context: the context object
:type context: dict
:return: dict with information about the message sent
For details of the returned dict see :py:meth:`botocore.client.SQS.send_message`
:rtype: dict
"""
hook = SQSHook(aws_conn_id=self.aws_conn_id)
result = hook.send_message(queue_url=self.sqs_queue,
message_body=self.message_content,
delay_seconds=self.delay_seconds,
message_attributes=self.message_attributes)
self.log.info('result is send_message is %s', result)
return result