From 918a683f115cd5da34a9a9ae4264bfd4381e7495 Mon Sep 17 00:00:00 2001
From: Mark Chappell <mchappel@redhat.com>
Date: Wed, 10 Mar 2021 08:37:04 +0100
Subject: [PATCH 1/2] scrub_none_parameters - set default for
 descend_into_lists to True (breaking change)

---
 plugins/module_utils/core.py                               | 2 +-
 tests/unit/module_utils/core/test_scrub_none_parameters.py | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/plugins/module_utils/core.py b/plugins/module_utils/core.py
index b67241b8570..f4ee568d512 100644
--- a/plugins/module_utils/core.py
+++ b/plugins/module_utils/core.py
@@ -359,7 +359,7 @@ def get_boto3_client_method_parameters(client, method_name, required=False):
     return parameters
 
 
-def scrub_none_parameters(parameters, descend_into_lists=False):
+def scrub_none_parameters(parameters, descend_into_lists=True):
     """
     Iterate over a dictionary removing any keys that have a None value
 
diff --git a/tests/unit/module_utils/core/test_scrub_none_parameters.py b/tests/unit/module_utils/core/test_scrub_none_parameters.py
index a1a1b491788..8c1faf42832 100644
--- a/tests/unit/module_utils/core/test_scrub_none_parameters.py
+++ b/tests/unit/module_utils/core/test_scrub_none_parameters.py
@@ -83,6 +83,6 @@
 
 @pytest.mark.parametrize("input_params, output_params_no_descend, output_params_descend", scrub_none_test_data)
 def test_scrub_none_parameters(input_params, output_params_no_descend, output_params_descend):
-    assert scrub_none_parameters(input_params) == output_params_no_descend
+    assert scrub_none_parameters(input_params) == output_params_descend
     assert scrub_none_parameters(input_params, descend_into_lists=False) == output_params_no_descend
     assert scrub_none_parameters(input_params, descend_into_lists=True) == output_params_descend

From 88274779cafe491dd0f9904aaf368720e4573a90 Mon Sep 17 00:00:00 2001
From: Mark Chappell <mchappel@redhat.com>
Date: Wed, 10 Mar 2021 08:42:23 +0100
Subject: [PATCH 2/2] changelog

---
 .../fragments/297-scrub_none_parameters-descend-default.yml     | 2 ++
 1 file changed, 2 insertions(+)
 create mode 100644 changelogs/fragments/297-scrub_none_parameters-descend-default.yml

diff --git a/changelogs/fragments/297-scrub_none_parameters-descend-default.yml b/changelogs/fragments/297-scrub_none_parameters-descend-default.yml
new file mode 100644
index 00000000000..8874e379b04
--- /dev/null
+++ b/changelogs/fragments/297-scrub_none_parameters-descend-default.yml
@@ -0,0 +1,2 @@
+breaking_changes:
+- module_utils/core - updated the ``scrub_none_parameters`` function so that ``descend_into_lists`` is set to ``True`` by default (https://github.com/ansible-collections/amazon.aws/pull/297).