Rename ses modules (#1264)

Rename SES modules SUMMARY In line with what I understood to be the consensus on ansible-collections/amazon.aws#881 and ansible-collections/amazon.aws#610 Rename ses modules to remove the aws_ prefix. ISSUE TYPE Feature Pull Request COMPONENT NAME plugins/modules/aws_ses_identity.py plugins/modules/aws_ses_identity_policy.py plugins/modules/aws_ses_rule_set.py plugins/modules/ses_identity.py plugins/modules/ses_identity_policy.py plugins/modules/ses_rule_set.py ADDITIONAL INFORMATION Reviewed-by: Alina Buzachis <None>
ansible-collections · Jun 28, 2022 · 2183ffa · 2183ffa
1 parent 058ecff
commit 2183ffa
Show file tree

Hide file tree

Showing 28 changed files with 87 additions and 63 deletions.
diff --git a/README.md b/README.md
@@ -66,9 +66,6 @@ Name | Description
 [community.aws.aws_s3_bucket_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_s3_bucket_info_module.rst)|lists S3 buckets in AWS
 [community.aws.aws_s3_cors](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_s3_cors_module.rst)|Manage CORS for S3 buckets in AWS
 [community.aws.aws_secret](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_secret_module.rst)|Manage secrets stored in AWS Secrets Manager
-[community.aws.aws_ses_identity](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_ses_identity_module.rst)|Manages SES email and domain identity
-[community.aws.aws_ses_identity_policy](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_ses_identity_policy_module.rst)|Manages SES sending authorization policies
-[community.aws.aws_ses_rule_set](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_ses_rule_set_module.rst)|Manages SES inbound receipt rule sets
 [community.aws.aws_sgw_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_sgw_info_module.rst)|Fetch AWS Storage Gateway information
 [community.aws.aws_ssm_parameter_store](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_ssm_parameter_store_module.rst)|Manage key-value pairs in AWS SSM parameter store
 [community.aws.aws_step_functions_state_machine](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_step_functions_state_machine_module.rst)|Manage AWS Step Functions state machines
@@ -211,6 +208,9 @@ Name | Description
 [community.aws.s3_metrics_configuration](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.s3_metrics_configuration_module.rst)|Manage s3 bucket metrics configuration in AWS
 [community.aws.s3_sync](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.s3_sync_module.rst)|Efficiently upload multiple files to S3
 [community.aws.s3_website](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.s3_website_module.rst)|Configure an s3 bucket as a website
+[community.aws.ses_identity](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ses_identity_module.rst)|Manages SES email and domain identity
+[community.aws.ses_identity_policy](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ses_identity_policy_module.rst)|Manages SES sending authorization policies
+[community.aws.ses_rule_set](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ses_rule_set_module.rst)|Manages SES inbound receipt rule sets
 [community.aws.sns](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.sns_module.rst)|Send Amazon Simple Notification Service messages
 [community.aws.sns_topic](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.sns_topic_module.rst)|Manages AWS SNS topics and subscriptions
 [community.aws.sns_topic_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.sns_topic_info_module.rst)|sns_topic_info module

diff --git a/changelogs/fragments/1264-rename_ses.yml b/changelogs/fragments/1264-rename_ses.yml
@@ -0,0 +1,4 @@
+minor_changes:
+- aws_ses_identity - the ``aws_ses_identity`` module has been renamed to ``ses_identity``, ``aws_ses_identity`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1264).
+- aws_ses_identity_policy - the ``aws_ses_identity_policy`` module has been renamed to ``ses_identity_policy``, ``aws_ses_identity_policy`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1264).
+- aws_ses_rule_set - the ``aws_ses_rule_set`` module has been renamed to ``ses_rule_set``, ``aws_ses_rule_set`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1264).
diff --git a/...community.aws.aws_ses_identity_module.rst → docs/community.aws.ses_identity_module.rst b/...community.aws.aws_ses_identity_module.rst → docs/community.aws.ses_identity_module.rst
@@ -1,9 +1,9 @@
-.. _community.aws.aws_ses_identity_module:
+.. _community.aws.ses_identity_module:
 
 
-******************************
-community.aws.aws_ses_identity
-******************************
+**************************
+community.aws.ses_identity
+**************************
 
 **Manages SES email and domain identity**
 
@@ -19,6 +19,7 @@ Synopsis
 --------
 - This module allows the user to manage verified email and domain identity for SES.
 - This covers verifying and removing identities as well as setting up complaint, bounce and delivery notification settings.
+- Prior to release 5.0.0 this module was called ``community.aws.aws_ses_identity``. The usage did not change.
 
 
 
@@ -457,17 +458,17 @@ Examples
     # Note: These examples do not set authentication details, see the AWS Guide for details.
 
     - name: Ensure [email protected] email identity exists
-      community.aws.aws_ses_identity:
+      community.aws.ses_identity:
         identity: [email protected]
         state: present
 
     - name: Delete [email protected] email identity
-      community.aws.aws_ses_identity:
+      community.aws.ses_identity:
         email: [email protected]
         state: absent
 
     - name: Ensure example.com domain identity exists
-      community.aws.aws_ses_identity:
+      community.aws.ses_identity:
         identity: example.com
         state: present
 
@@ -481,7 +482,7 @@ Examples
       register: topic_info
 
     - name: Deliver feedback to topic instead of owner email
-      community.aws.aws_ses_identity:
+      community.aws.ses_identity:
         identity: [email protected]
         state: present
         complaint_notifications:
@@ -502,7 +503,7 @@ Examples
       register: topic_info
 
     - name: Delivery notifications to topic
-      community.aws.aws_ses_identity:
+      community.aws.ses_identity:
         identity: [email protected]
         state: present
         delivery_notifications:
@@ -752,4 +753,4 @@ Status
 Authors
 ~~~~~~~
 
-- Ed Costello    (@orthanc)
+- Ed Costello (@orthanc)
diff --git a/...ty.aws.aws_ses_identity_policy_module.rst → ...munity.aws.ses_identity_policy_module.rst b/...ty.aws.aws_ses_identity_policy_module.rst → ...munity.aws.ses_identity_policy_module.rst
@@ -1,9 +1,9 @@
-.. _community.aws.aws_ses_identity_policy_module:
+.. _community.aws.ses_identity_policy_module:
 
 
-*************************************
-community.aws.aws_ses_identity_policy
-*************************************
+*********************************
+community.aws.ses_identity_policy
+*********************************
 
 **Manages SES sending authorization policies**
 
@@ -19,6 +19,7 @@ Synopsis
 --------
 - This module allows the user to manage sending authorization policies associated with an SES identity (email or domain).
 - SES authorization sending policies can be used to control what actors are able to send email on behalf of the validated identity and what conditions must be met by the sent emails.
+- Prior to release 5.0.0 this module was called ``community.aws.aws_ses_identity_policy``. The usage did not change.
 
 
 
@@ -301,28 +302,28 @@ Examples
     # Note: These examples do not set authentication details, see the AWS Guide for details.
 
     - name: add sending authorization policy to domain identity
-      community.aws.aws_ses_identity_policy:
+      community.aws.ses_identity_policy:
         identity: example.com
         policy_name: ExamplePolicy
         policy: "{{ lookup('template', 'policy.json.j2') }}"
         state: present
 
     - name: add sending authorization policy to email identity
-      community.aws.aws_ses_identity_policy:
+      community.aws.ses_identity_policy:
         identity: [email protected]
         policy_name: ExamplePolicy
         policy: "{{ lookup('template', 'policy.json.j2') }}"
         state: present
 
     - name: add sending authorization policy to identity using ARN
-      community.aws.aws_ses_identity_policy:
+      community.aws.ses_identity_policy:
         identity: "arn:aws:ses:us-east-1:12345678:identity/example.com"
         policy_name: ExamplePolicy
         policy: "{{ lookup('template', 'policy.json.j2') }}"
         state: present
 
     - name: remove sending authorization policy
-      community.aws.aws_ses_identity_policy:
+      community.aws.ses_identity_policy:
         identity: example.com
         policy_name: ExamplePolicy
         state: absent
@@ -369,4 +370,4 @@ Status
 Authors
 ~~~~~~~
 
-- Ed Costello    (@orthanc)
+- Ed Costello (@orthanc)
diff --git a/...community.aws.aws_ses_rule_set_module.rst → docs/community.aws.ses_rule_set_module.rst b/...community.aws.aws_ses_rule_set_module.rst → docs/community.aws.ses_rule_set_module.rst
@@ -1,9 +1,9 @@
-.. _community.aws.aws_ses_rule_set_module:
+.. _community.aws.ses_rule_set_module:
 
 
-******************************
-community.aws.aws_ses_rule_set
-******************************
+**************************
+community.aws.ses_rule_set
+**************************
 
 **Manages SES inbound receipt rule sets**
 
@@ -17,7 +17,8 @@ Version added: 1.0.0
 
 Synopsis
 --------
-- The :ref:`community.aws.aws_ses_rule_set <community.aws.aws_ses_rule_set_module>` module allows you to create, delete, and manage SES receipt rule sets
+- This module allows you to create, delete, and manage SES receipt rule sets
+- Prior to release 5.0.0 this module was called ``community.aws.aws_ses_rule_set``. The usage did not change.
 
 
 
@@ -310,29 +311,29 @@ Examples
     # It is assumed that their matching environment variables are set.
     ---
     - name: Create default rule set and activate it if not already
-      community.aws.aws_ses_rule_set:
+      community.aws.ses_rule_set:
         name: default-rule-set
         state: present
         active: yes
 
     - name: Create some arbitrary rule set but do not activate it
-      community.aws.aws_ses_rule_set:
+      community.aws.ses_rule_set:
         name: arbitrary-rule-set
         state: present
 
     - name: Explicitly deactivate the default rule set leaving no active rule set
-      community.aws.aws_ses_rule_set:
+      community.aws.ses_rule_set:
         name: default-rule-set
         state: present
         active: no
 
     - name: Remove an arbitrary inactive rule set
-      community.aws.aws_ses_rule_set:
+      community.aws.ses_rule_set:
         name: arbitrary-rule-set
         state: absent
 
     - name: Remove an ruleset even if we have to first deactivate it to remove it
-      community.aws.aws_ses_rule_set:
+      community.aws.ses_rule_set:
         name: default-rule-set
         state: absent
         force: yes

diff --git a/meta/runtime.yml b/meta/runtime.yml
@@ -186,6 +186,9 @@ action_groups:
   - s3_metrics_configuration
   - s3_sync
   - s3_website
+  - ses_identity
+  - ses_identity_policy
+  - ses_rule_set
   - sns
   - sns_topic
   - sns_topic_info
@@ -208,6 +211,15 @@ plugin_routing:
     aws_acm_info:
       # Deprecation for this alias should not *start* prior to 2024-09-01
       redirect: community.aws.acm_certificate_info
+    aws_ses_identity:
+      # Deprecation for this alias should not *start* prior to 2024-09-01
+      redirect: community.aws.ses_identity
+    aws_ses_identity_policy:
+      # Deprecation for this alias should not *start* prior to 2024-09-01
+      redirect: community.aws.ses_identity_policy
+    aws_ses_rule_set:
+      # Deprecation for this alias should not *start* prior to 2024-09-01
+      redirect: community.aws.ses_rule_set
     ec2_elb:
       redirect: community.aws.elb_instance
     ec2_instance:

diff --git a/plugins/modules/aws_ses_identity.py → plugins/modules/ses_identity.py b/plugins/modules/aws_ses_identity.py → plugins/modules/ses_identity.py
@@ -8,15 +8,17 @@
 
 DOCUMENTATION = '''
 ---
-module: aws_ses_identity
+module: ses_identity
 version_added: 1.0.0
 short_description: Manages SES email and domain identity
 description:
     - This module allows the user to manage verified email and domain identity for SES.
     - This covers verifying and removing identities as well as setting up complaint, bounce
       and delivery notification settings.
-author: Ed Costello    (@orthanc)
-
+    - Prior to release 5.0.0 this module was called C(community.aws.aws_ses_identity).
+      The usage did not change.
+author:
+    - Ed Costello (@orthanc)
 options:
     identity:
         description:
@@ -86,26 +88,25 @@
         type: 'bool'
         default: True
 extends_documentation_fragment:
-- amazon.aws.aws
-- amazon.aws.ec2
-
+    - amazon.aws.aws
+    - amazon.aws.ec2
 '''
 
 EXAMPLES = '''
 # Note: These examples do not set authentication details, see the AWS Guide for details.
 
 - name: Ensure [email protected] email identity exists
-  community.aws.aws_ses_identity:
+  community.aws.ses_identity:
     identity: [email protected]
     state: present
 
 - name: Delete [email protected] email identity
-  community.aws.aws_ses_identity:
+  community.aws.ses_identity:
     email: [email protected]
     state: absent
 
 - name: Ensure example.com domain identity exists
-  community.aws.aws_ses_identity:
+  community.aws.ses_identity:
     identity: example.com
     state: present
 
@@ -119,7 +120,7 @@
   register: topic_info
 
 - name: Deliver feedback to topic instead of owner email
-  community.aws.aws_ses_identity:
+  community.aws.ses_identity:
     identity: [email protected]
     state: present
     complaint_notifications:
@@ -140,7 +141,7 @@
   register: topic_info
 
 - name: Delivery notifications to topic
-  community.aws.aws_ses_identity:
+  community.aws.ses_identity:
     identity: [email protected]
     state: present
     delivery_notifications:

diff --git a/plugins/modules/aws_ses_identity_policy.py → plugins/modules/ses_identity_policy.py b/plugins/modules/aws_ses_identity_policy.py → plugins/modules/ses_identity_policy.py
@@ -8,14 +8,18 @@
 
 DOCUMENTATION = '''
 ---
-module: aws_ses_identity_policy
+module: ses_identity_policy
 version_added: 1.0.0
 short_description: Manages SES sending authorization policies
 description:
-    - This module allows the user to manage sending authorization policies associated with an SES identity (email or domain).
+    - This module allows the user to manage sending authorization policies associated with an SES
+      identity (email or domain).
     - SES authorization sending policies can be used to control what actors are able to send email
       on behalf of the validated identity and what conditions must be met by the sent emails.
-author: Ed Costello    (@orthanc)
+    - Prior to release 5.0.0 this module was called C(community.aws.aws_ses_identity_policy).
+      The usage did not change.
+author:
+    - Ed Costello (@orthanc)
 
 options:
     identity:
@@ -37,37 +41,36 @@
         choices: [ 'present', 'absent' ]
         type: str
 extends_documentation_fragment:
-- amazon.aws.aws
-- amazon.aws.ec2
-
+    - amazon.aws.aws
+    - amazon.aws.ec2
 '''
 
 EXAMPLES = '''
 # Note: These examples do not set authentication details, see the AWS Guide for details.
 
 - name: add sending authorization policy to domain identity
-  community.aws.aws_ses_identity_policy:
+  community.aws.ses_identity_policy:
     identity: example.com
     policy_name: ExamplePolicy
     policy: "{{ lookup('template', 'policy.json.j2') }}"
     state: present
 
 - name: add sending authorization policy to email identity
-  community.aws.aws_ses_identity_policy:
+  community.aws.ses_identity_policy:
     identity: [email protected]
     policy_name: ExamplePolicy
     policy: "{{ lookup('template', 'policy.json.j2') }}"
     state: present
 
 - name: add sending authorization policy to identity using ARN
-  community.aws.aws_ses_identity_policy:
+  community.aws.ses_identity_policy:
     identity: "arn:aws:ses:us-east-1:12345678:identity/example.com"
     policy_name: ExamplePolicy
     policy: "{{ lookup('template', 'policy.json.j2') }}"
     state: present
 
 - name: remove sending authorization policy
-  community.aws.aws_ses_identity_policy:
+  community.aws.ses_identity_policy:
     identity: example.com
     policy_name: ExamplePolicy
     state: absent