blob: 43c9089711f23358c39b81225e7b0a69752b3432 [file] [log] [blame]
:mod:`airflow.contrib.hooks.aws_sqs_hook`
=========================================
.. py:module:: airflow.contrib.hooks.aws_sqs_hook
.. autoapi-nested-parse::
This module contains AWS SQS hook
Module Contents
---------------
.. py:class:: SQSHook
Bases: :class:`airflow.contrib.hooks.aws_hook.AwsHook`
Get the SQS client using boto3 library
:return: SQS client
:rtype: botocore.client.SQS
.. method:: get_conn(self)
.. method:: create_queue(self, queue_name, attributes=None)
Create queue using connection object
:param queue_name: name of the queue.
:type queue_name: str
:param attributes: additional attributes for the queue (default: None)
For details of the attributes parameter see :py:meth:`botocore.client.SQS.create_queue`
:type attributes: dict
:return: dict with the information about the queue
For details of the returned value see :py:meth:`botocore.client.SQS.create_queue`
:rtype: dict
.. method:: send_message(self, queue_url, message_body, delay_seconds=0, message_attributes=None)
Send message to the queue
:param queue_url: queue url
:type queue_url: str
:param message_body: the contents of the message
:type message_body: str
:param delay_seconds: seconds to delay the message
:type delay_seconds: int
: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
:return: dict with the information about the message sent
For details of the returned value see :py:meth:`botocore.client.SQS.send_message`
:rtype: dict