SNS Manager

View Licence Agreement

sosw - Serverless Orchestrator of Serverless Workers

The MIT License (MIT)
Copyright (C) 2024  sosw core contributors <info@sosw.app>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

class sosw.components.sns.SnsManager(**kwargs)

AWS Simple Notification System Manager helper. Requires the Role to have permissions to access SSM for requested resources, something like.

Must have a recipient specified either during initialization or later using set_recipient method. Messages received by send_message() are batched and will be actually send to SNS only during the call of commit() or during the destruction of the class.

The method doesn’t yet support batching messages for multiple recipients, so in case you try to change the recipient it automatically sends all the currently batched messages to the previous recipient.

commit()

Combines messages from self.queue and pushes them to self.recipient. Cleans the queue after that.

compare_message_attributtes(message_attributes)

Compare MessageAttributes. If new object was received - set new value to the attribute

Parameters:

message_attributes (dict) – Message attributes for SNS subscription filter policies

create_subscription(topic_arn, protocol, endpoint)

Create a subscription to the topic

Parameters:

• topic_arn (str) – ARN of a topic

• protocol (str) – The type of endpoint to subscribe

• endpoint (str) – Endpoint that can receive notifications from Amazon SNS

create_topic(topic_name)

Create a new topic name

Parameters:

topic_name (str) – New topic name to create

Returns:

New topic ARN

Return type:

str

static get_message_attribute(attribute)

Amazon SNS compares policy attributes only to message attributes that have the following data types: - String - String.Array - Number

Returns:

Type and value of an attribute

Return type:

dict

send_message(message, subject=None, forse_commit=False, message_attributes=None)

If the subject is not yet set (for example during __init__() of the class) - then require subject to be set. Otherwize we accept None subject and simply append messages to queue. Once the subject changes - the queue is commite automatically.

Parameters:

• message (str) – Message to be send in body of SNS message. Queued.

• subject (str) – Optional. Custom subject for message.

• forse_commit (bool) – Commit the queue immediately if True, by default False

• message_attributes (dict) – Optional. Message attributes for SNS subscription filter policies

set_client_attr(name, value)

Sets the given _name_ attribute to _value_. Commits the self.queue if there are any messages in it.

set_message_attributes(message_attributes)

Validate attribute value and set new value

set_separator(separator)

Set custom separator for messages from the queue