Rename aws_inspector_target module

README.md

@@ -47,7 +47,6 @@ Name | Description
 [community.aws.autoscaling_lifecycle_hook](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.autoscaling_lifecycle_hook_module.rst)|Create, delete or update AWS ASG Lifecycle Hooks
 [community.aws.autoscaling_policy](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.autoscaling_policy_module.rst)|Create or delete AWS scaling policies for Autoscaling groups
 [community.aws.autoscaling_scheduled_action](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.autoscaling_scheduled_action_module.rst)|Create, modify and delete ASG scheduled scaling actions
-[community.aws.aws_inspector_target](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_inspector_target_module.rst)|Create, Update and Delete Amazon Inspector Assessment Targets
 [community.aws.aws_region_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_region_info_module.rst)|Gather information about AWS regions.
 [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.batch_compute_environment](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.batch_compute_environment_module.rst)|Manage AWS Batch Compute Environments
@@ -154,6 +153,7 @@ Name | Description
 [community.aws.iam_server_certificate_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.iam_server_certificate_info_module.rst)|Retrieve the information of a server certificate
 [community.aws.iam_user](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.iam_user_module.rst)|Manage AWS IAM users
 [community.aws.iam_user_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.iam_user_info_module.rst)|Gather IAM user(s) facts in AWS
+[community.aws.inspector_target](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.inspector_target_module.rst)|Create, Update and Delete Amazon Inspector Assessment Targets
 [community.aws.kinesis_stream](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.kinesis_stream_module.rst)|Manage a Kinesis Stream.
 [community.aws.kms_key](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.kms_key_module.rst)|Perform various KMS key management tasks
 [community.aws.kms_key_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.kms_key_info_module.rst)|Gather information about AWS KMS keys

changelogs/fragments/1318-rename-inspector.yml

@@ -0,0 +1,2 @@
+minor_changes:
+- aws_inspector_target - the ``aws_inspector_target`` module has been renamed to ``inspector_target``, ``aws_inspector_target`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1318).

docs/community.aws.aws_inspector_target_module.rst → docs/community.aws.inspector_target_module.rst

@@ -1,9 +1,9 @@
-.. _community.aws.aws_inspector_target_module:
+.. _community.aws.inspector_target_module:
 
 
-**********************************
-community.aws.aws_inspector_target
-**********************************
+******************************
+community.aws.inspector_target
+******************************
 
 **Create, Update and Delete Amazon Inspector Assessment Targets**
 
@@ -18,6 +18,7 @@ Version added: 1.0.0
 Synopsis
 --------
 - Creates, updates, or deletes Amazon Inspector Assessment Targets and manages the required Resource Groups.
+- Prior to release 5.0.0 this module was called ``community.aws.aws_inspector_target``. The usage did not change.
 
 
 
@@ -155,7 +156,8 @@ Parameters
                 <td>
                 </td>
                 <td>
-                        <div>The user-defined name that identifies the assessment target.  The name must be unique within the AWS account.</div>
+                        <div>The user-defined name that identifies the assessment target.</div>
+                        <div>The name must be unique within the AWS account.</div>
                 </td>
             </tr>
             <tr>
@@ -240,7 +242,7 @@ Parameters
                 </td>
                 <td>
                         <div>Tags of the EC2 instances to be added to the assessment target.</div>
-                        <div>Required if <code>state=present</code>.</div>
+                        <div>Required if <em>state=present</em>.</div>
                 </td>
             </tr>
             <tr>
@@ -282,20 +284,20 @@ Examples
 .. code-block:: yaml
 
     - name: Create my_target Assessment Target
-      community.aws.aws_inspector_target:
+      community.aws.inspector_target:
         name: my_target
         tags:
           role: scan_target
 
     - name: Update Existing my_target Assessment Target with Additional Tags
-      community.aws.aws_inspector_target:
+      community.aws.inspector_target:
         name: my_target
         tags:
           env: dev
           role: scan_target
 
     - name: Delete my_target Assessment Target
-      community.aws.aws_inspector_target:
+      community.aws.inspector_target:
         name: my_target
         state: absent
 

meta/runtime.yml

@@ -180,6 +180,7 @@ action_groups:
   - iam_server_certificate_info
   - iam_user
   - iam_user_info
+  - inspector_target
   - kinesis_stream
   - kms_key
   - kms_key_info
@@ -333,6 +334,9 @@ plugin_routing:
     aws_glue_job:
       # Deprecation for this alias should not *start* prior to 2024-09-01
       redirect: community.aws.glue_job
+    aws_inspector_target:
+      # Deprecation for this alias should not *start* prior to 2024-09-01
+      redirect: community.aws.inspector_target
     aws_kms:
       # Deprecation for this alias should not *start* prior to 2024-09-01
       redirect: community.aws.kms_key

plugins/modules/aws_inspector_target.py → plugins/modules/inspector_target.py

@@ -8,18 +8,21 @@
 
 DOCUMENTATION = '''
 ---
-module: aws_inspector_target
+module: inspector_target
 version_added: 1.0.0
-short_description: Create, Update and Delete Amazon Inspector Assessment
-                   Targets
-description: Creates, updates, or deletes Amazon Inspector Assessment Targets
-             and manages the required Resource Groups.
-author: "Dennis Conrad (@dennisconrad)"
+short_description: Create, Update and Delete Amazon Inspector Assessment Targets
+description:
+  - Creates, updates, or deletes Amazon Inspector Assessment Targets and manages
+    the required Resource Groups.
+  - Prior to release 5.0.0 this module was called C(community.aws.aws_inspector_target).
+    The usage did not change.
+author:
+  - "Dennis Conrad (@dennisconrad)"
 options:
   name:
     description:
-      - The user-defined name that identifies the assessment target.  The name
-        must be unique within the AWS account.
+      - The user-defined name that identifies the assessment target.
+      - The name must be unique within the AWS account.
     required: true
     type: str
   state:
@@ -33,29 +36,29 @@
   tags:
     description:
       - Tags of the EC2 instances to be added to the assessment target.
-      - Required if C(state=present).
+      - Required if I(state=present).
     type: dict
 extends_documentation_fragment:
-- amazon.aws.aws
-- amazon.aws.ec2
+  - amazon.aws.aws
+  - amazon.aws.ec2
 '''
 
 EXAMPLES = '''
 - name: Create my_target Assessment Target
-  community.aws.aws_inspector_target:
+  community.aws.inspector_target:
     name: my_target
     tags:
       role: scan_target
 
 - name: Update Existing my_target Assessment Target with Additional Tags
-  community.aws.aws_inspector_target:
+  community.aws.inspector_target:
     name: my_target
     tags:
       env: dev
       role: scan_target
 
 - name: Delete my_target Assessment Target
-  community.aws.aws_inspector_target:
+  community.aws.inspector_target:
     name: my_target
     state: absent
 '''