You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2022/02/09 21:07:23 UTC

[GitHub] [airflow] ferruzzi commented on a change in pull request #21475: Added SNS example DAG and rst

ferruzzi commented on a change in pull request #21475:
URL: https://github.com/apache/airflow/pull/21475#discussion_r803088250



##########
File path: docs/apache-airflow-providers-amazon/operators/sns.rst
##########
@@ -0,0 +1,58 @@
+ .. 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.
+
+
+Amazon Simple Notification Service (SNS) Operators
+==================================================
+
+`Amazon Simple Notification Service (Amazon SNS) <https://aws.amazon.com/sns/>`__  is a managed
+service that provides message delivery from publishers to subscribers (also known as producers
+and consumers). Publishers communicate asynchronously with subscribers by sending messages to
+a topic, which is a logical access point and communication channel. Clients can subscribe to the
+SNS topic and receive published messages using a supported endpoint type, such as Amazon Kinesis
+Data Firehose, Amazon SQS, AWS Lambda, HTTP, email, mobile push notifications, and mobile text
+messages (SMS).
+
+Airflow provides an operator to publish messages to an SNS Topic.
+
+Prerequisite Tasks
+^^^^^^^^^^^^^^^^^^
+
+.. include::/operators/_partials/prerequisite_tasks.rst
+
+
+.. _howto/operator:SnsPublishOperator:
+
+Publish A Message To An Existing SNS Topic
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+To publish a message to an Amazon SNS Topic you can use
+:class:`~airflow.providers.amazon.aws.operators.sns.SnsPublishOperator`.
+
+
+.. exampleinclude:: /../../airflow/providers/amazon/aws/example_dags/example_sns.py
+    :language: python

Review comment:
       Oh neat.    This rst formatting is all very much black magic to me.   Every time I think I have a handle on it, I figure out something new.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org