route53: add wait_id return value in case of changes (#1683)

route53: add wait_id return value in case of changes

SUMMARY
This allows to wait for changes later on when wait=false is provided to the module.
Will be needed for a new route53_wait module I'll create a PR for soon in community.aws :)
(I'm not sure whether another 5.x.0 feature release is planned; in case it is not I'll update version_added and the backport-5 label needs to be removed.)
ISSUE TYPE

Feature Pull Request

COMPONENT NAME
route53

Reviewed-by: Mark Chappell

changelogs/fragments/1683-route53-wait_id.yml

@@ -0,0 +1,2 @@
+minor_changes:
+  - "route53 - add a ``wait_id`` return value when a change is done (https://github.com/ansible-collections/amazon.aws/pull/1683)."

plugins/modules/route53.py

@@ -244,6 +244,12 @@
       returned: always
       type: str
       sample: foo.bar.com.
+wait_id:
+  description:
+    - The wait ID for the applied change. Can be used to wait for the change to propagate later on when I(wait=false).
+  type: str
+  returned: when changed
+  version_added: 6.3.0
 """
 
 EXAMPLES = r"""
@@ -766,13 +772,15 @@ def main():
         else:
             command = command_in.upper()
 
+    wait_id = None
     if not module.check_mode:
         try:
             change_resource_record_sets = route53.change_resource_record_sets(
                 aws_retry=True,
                 HostedZoneId=zone_id,
                 ChangeBatch=dict(Changes=[dict(Action=command, ResourceRecordSet=resource_record_set)]),
             )
+            wait_id = change_resource_record_sets["ChangeInfo"]["Id"]
 
             if wait_in:
                 waiter = get_waiter(route53, "resource_record_sets_changed")
@@ -801,6 +809,7 @@ def main():
 
     module.exit_json(
         changed=True,
+        wait_id=wait_id,
         diff=dict(
             before=formatted_aws,
             after=formatted_record if command_in != "delete" else {},

tests/integration/targets/route53/tasks/main.yml

@@ -105,6 +105,8 @@
       that:
       - qdn is not failed
       - qdn is changed
+      - "'wait_id' in qdn"
+      - qdn.wait_id is string
 
   - name: Get A record using "get" method of route53 module
     route53:
@@ -191,6 +193,7 @@
       that:
       - non_qdn is not failed
       - non_qdn is not changed
+      - "'wait_id' not in non_qdn"
 
   - name: Create A record using zone ID
     route53:
@@ -705,6 +708,8 @@
       - create_geo_continent_check_mode is changed
       - create_geo_continent_check_mode is not failed
       - '"route53:ChangeResourceRecordSets" not in create_geo_continent_check_mode.resource_actions'
+      - '"wait_id" in create_geo_continent_check_mode'
+      - create_geo_continent_check_mode.wait_id is none
 
   - name: Create a record with geo_location - continent_code
     route53: