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 SQS queue"""
import warnings
from typing import TYPE_CHECKING, Optional, Sequence

from airflow.models import BaseOperator
from import SqsHook

    from airflow.utils.context import Context

[docs]class SqsPublishOperator(BaseOperator): """ Publish a message to an Amazon SQS queue. .. seealso:: For more information on how to use this operator, take a look at the guide: :ref:`howto/operator:SqsPublishOperator` :param sqs_queue: The SQS queue url (templated) :param message_content: The message content (templated) :param message_attributes: additional attributes for the message (default: None) For details of the attributes parameter see :py:meth:`botocore.client.SQS.send_message` :param delay_seconds: message delay (templated) (default: 1 second) :param aws_conn_id: AWS connection id (default: aws_default) """
[docs] template_fields: Sequence[str] = ('sqs_queue', 'message_content', 'delay_seconds', 'message_attributes')
[docs] template_fields_renderers = {'message_attributes': 'json'}
[docs] ui_color = '#6ad3fa'
def __init__( self, *, sqs_queue: str, message_content: str, message_attributes: Optional[dict] = None, delay_seconds: int = 0, aws_conn_id: str = 'aws_default', **kwargs, ): super().__init__(**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: 'Context'): """ Publish the message to the Amazon SQS queue :param context: the context object :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, )'send_message result: %s', result) return result
[docs]class SQSPublishOperator(SqsPublishOperator): """ This operator is deprecated. Please use :class:``. """ def __init__(self, *args, **kwargs): warnings.warn( "This operator is deprecated. " "Please use ``.", DeprecationWarning, stacklevel=2, ) super().__init__(*args, **kwargs)

Was this entry helpful?