add function to get multi-value query string params by name

Author: TonySherman

aws_lambda_powertools/utilities/data_classes/common.py

@@ -7,6 +7,7 @@
 from aws_lambda_powertools.shared.headers_serializer import BaseHeadersSerializer
 from aws_lambda_powertools.utilities.data_classes.shared_functions import (
     get_header_value,
+    get_multi_value_query_string_values,
     get_query_string_value,
 )
 
@@ -103,6 +104,10 @@ def headers(self) -> Dict[str, str]:
     def query_string_parameters(self) -> Optional[Dict[str, str]]:
         return self.get("queryStringParameters")
 
+    @property
+    def multi_value_query_string_parameters(self) -> Optional[Dict[str, List[str]]]:
+        return self.get("multiValueQueryStringParameters")
+
     @property
     def resolved_query_string_parameters(self) -> Dict[str, List[str]]:
         """
@@ -184,6 +189,31 @@ def get_query_string_value(self, name: str, default_value: Optional[str] = None)
             default_value=default_value,
         )
 
+    def get_multi_value_query_string_values(
+        self,
+        name: str,
+        default_values: Optional[List[str]] = None,
+    ) -> Optional[List[str]]:
+        """Get multi-value query string parameter values by name
+
+        Parameters
+        ----------
+        name: str
+            Multi-Value query string parameter name
+        default_values: List[str], optional
+            Default values is no values are found by name
+        Returns
+        -------
+        List[str], optional
+            List of query string values
+
+        """
+        return get_multi_value_query_string_values(
+            multi_value_query_string_parameters=self.multi_value_query_string_parameters,
+            name=name,
+            default_values=default_values,
+        )
+
     @overload
     def get_header_value(
         self,

aws_lambda_powertools/utilities/data_classes/shared_functions.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 import base64
-from typing import Any
+from typing import Any, Dict
 
 
 def base64_decode(value: str) -> str:
@@ -63,7 +63,7 @@ def get_header_value(
 
 
 def get_query_string_value(
-    query_string_parameters: dict[str, str] | None,
+    query_string_parameters: Dict[str, str] | None,
     name: str,
     default_value: str | None = None,
 ) -> str | None:
@@ -84,3 +84,28 @@ def get_query_string_value(
     """
     params = query_string_parameters
     return default_value if params is None else params.get(name, default_value)
+
+
+def get_multi_value_query_string_values(
+    multi_value_query_string_parameters: Dict[str, list[str]] | None,
+    name: str,
+    default_values: list[str] | None = None,
+) -> list[str] | None:
+    """
+    Retrieves the values of a multi-value string parameters specified by the given name.
+
+    Parameters
+    ----------
+    name: str
+        The name of the query string parameter to retrieve.
+    default_value: list[str], optional
+        The default value to return if the parameter is not found. Defaults to None.
+
+    Returns
+    -------
+    List[str]. optional
+        The values of the query string parameter if found, or the default values if not found.
+    """
+
+    params = multi_value_query_string_parameters
+    return default_values if not params else params.get(name, default_values)

tests/unit/test_data_classes.py

@@ -259,6 +259,25 @@ def test_base_proxy_event_get_query_string_value():
     assert value is None
 
 
+def test_base_proxy_event_get_multi_value_query_string_values():
+    default_values = ["default_1", "default_2"]
+    set_values = ["value_1", "value_2"]
+
+    event = BaseProxyEvent({})
+    values = event.get_multi_value_query_string_values("test", default_values)
+    assert values == default_values
+
+    event._data["multiValueQueryStringParameters"] = {"test": set_values}
+    values = event.get_multi_value_query_string_values("test", default_values)
+    assert values == set_values
+
+    values = event.get_multi_value_query_string_values("unknown", default_values)
+    assert values == default_values
+
+    values = event.get_multi_value_query_string_values("unknown")
+    assert values is None
+
+
 def test_base_proxy_event_get_header_value():
     default_value = "default"
     set_value = "value"