airflow.providers.amazon.aws.hooks.sqs

This module contains AWS SQS hook

Module Contents

Classes

SqsHook

Interact with Amazon Simple Queue Service.
class airflow.providers.amazon.aws.hooks.sqs.SqsHook(*args, **kwargs)[source]

Bases: airflow.providers.amazon.aws.hooks.base_aws.AwsBaseHook

Interact with Amazon Simple Queue Service.

Additional arguments (such as aws_conn_id) may be specified and are passed down to the underlying AwsBaseHook.

See also

AwsBaseHook

create_queue(queue_name, attributes=None)[source]

Create queue using connection object

Parameters

  • queue_name (str) -- name of the queue.

  • attributes (Optional[Dict]) -- additional attributes for the queue (default: None) For details of the attributes parameter see SQS.create_queue()

Returns

dict with the information about the queue For details of the returned value see SQS.create_queue()

Return type

dict

send_message(queue_url, message_body, delay_seconds=0, message_attributes=None, message_group_id=None)[source]

Send message to the queue

Parameters

  • queue_url (str) -- queue url

  • message_body (str) -- the contents of the message

  • delay_seconds (int) -- seconds to delay the message

  • message_attributes (Optional[Dict]) -- additional attributes for the message (default: None) For details of the attributes parameter see botocore.client.SQS.send_message()

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

Returns

dict with the information about the message sent For details of the returned value see botocore.client.SQS.send_message()

Return type

dict

Was this entry helpful?