airflow.providers.amazon.aws.notifications.sqs

Module Contents

Classes

SqsNotifier

Amazon SQS (Simple Queue Service) Notifier.

Attributes

send_sqs_notification

class airflow.providers.amazon.aws.notifications.sqs.SqsNotifier(*, aws_conn_id=SqsHook.default_conn_name, queue_url, message_body, message_attributes=None, message_group_id=None, delay_seconds=0, region_name=None)[source]

Bases: airflow.notifications.basenotifier.BaseNotifier

Amazon SQS (Simple Queue Service) Notifier.

See also

For more information on how to use this notifier, take a look at the guide: How-to Guide for Amazon Simple Queue Service (Amazon SQS) notifications

Parameters

  • aws_conn_id (str | None) – The Amazon Web Services Connection id used for AWS credentials. If this is None or empty then the default boto3 behaviour is used.

  • queue_url (str) – The URL of the Amazon SQS queue to which a message is sent.

  • message_body (str) – The message to send.

  • message_attributes (dict | None) – additional attributes for the message. For details of the attributes parameter see botocore.client.SQS.send_message().

  • message_group_id (str | None) – This parameter applies only to FIFO (first-in-first-out) queues. For details of the attributes parameter see botocore.client.SQS.send_message().

  • delay_seconds (int) – The length of time, in seconds, for which to delay a message.

  • region_name (str | None) – AWS region_name. If not specified then the default boto3 behaviour is used.

template_fields: collections.abc.Sequence[str] = ('queue_url', 'message_body', 'message_attributes', 'message_group_id', 'delay_seconds',...[source]
hook()[source]

Amazon SQS Hook (cached).

notify(context)[source]

Publish the notification message to Amazon SQS queue.

airflow.providers.amazon.aws.notifications.sqs.send_sqs_notification[source]

Was this entry helpful?