sns_topic: Allow canonical international-format phone numbers in SMS …

…subscriptions (ansible-collections#454) * Update sns_topic.py Adds `+` to the list of acceptable characters in an SMS endpoint. Closes ansible-collections#453. * Add changelog fragment for ansible-collections#454 * sns_topic: comment explaining SMS canonicalization Add comment documenting to what standard SMS endpoint addresses (phone numbers) are canonicalized * sns_topic: fix changelog * Get quoting correct * Simplify message to leave details in PR description Co-authored-by: Mark Chappell <[email protected]> Co-authored-by: Mark Chappell <[email protected]>
danquixote · May 16, 2021 · a2025ea · a2025ea
1 parent dffb9be
commit a2025ea
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/changelogs/fragments/454-sns_topic_fix_sms_endpoint_canonicalization.yaml b/changelogs/fragments/454-sns_topic_fix_sms_endpoint_canonicalization.yaml
@@ -0,0 +1,2 @@
+bugfixes:
+  - sns_topic - Add ``+`` to allowable characters in SMS endpoints (https://github.com/ansible-collections/community.aws/pull/454).
diff --git a/plugins/modules/sns_topic.py b/plugins/modules/sns_topic.py
@@ -349,8 +349,11 @@ def _set_topic_attrs(self):
         return changed
 
     def _canonicalize_endpoint(self, protocol, endpoint):
+        # AWS SNS expects phone numbers in
+        # and canonicalizes to E.164 format
+        # See <https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html>
         if protocol == 'sms':
-            return re.sub('[^0-9]*', '', endpoint)
+            return re.sub('[^0-9+]*', '', endpoint)
         return endpoint
 
     def _set_topic_subs(self):
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		bugfixes:
		- sns_topic - Add ``+`` to allowable characters in SMS endpoints (https://github.com/ansible-collections/community.aws/pull/454).