feat(data-classes): Add ses response builder function

Author: Michael Brewer

aws_lambda_powertools/utilities/data_classes/ses_event.py

@@ -1,4 +1,5 @@
-from typing import Iterator, List, Optional
+from enum import Enum
+from typing import Dict, Iterator, List, Optional
 
 from aws_lambda_powertools.utilities.data_classes.common import DictWrapper
 
@@ -316,3 +317,17 @@ def mail(self) -> SESMail:
     @property
     def receipt(self) -> SESReceipt:
         return self.record.ses.receipt
+
+
+class Disposition(Enum):
+    """No further actions in the current receipt rule will be processed, but further receipt rules can be processed."""
+
+    STOP_RULE = "STOP_RULE"
+    """No further actions or receipt rules will be processed."""
+    STOP_RULE_SET = "STOP_RULE_SET"
+    """This means that further actions and receipt rules can be processed."""
+    CONTINUE = "CONTINUE"
+
+
+def disposition_response(disposition: Disposition) -> Dict[str, str]:
+    return {"disposition": disposition.value}

tests/functional/test_data_classes.py

@@ -76,7 +76,7 @@
 )
 from aws_lambda_powertools.utilities.data_classes.event_source import event_source
 from aws_lambda_powertools.utilities.data_classes.s3_object_event import S3ObjectLambdaEvent
-from aws_lambda_powertools.utilities.data_classes.ses_event import SESReceiptAction
+from aws_lambda_powertools.utilities.data_classes.ses_event import Disposition, SESReceiptAction, disposition_response
 from tests.functional.utils import load_event
 
 
@@ -769,6 +769,11 @@ def test_ses_trigger_event_work_mail():
     assert action.organization_arn == action["organizationArn"]
 
 
+def test_ses_disposition_response():
+    response = disposition_response(Disposition.STOP_RULE_SET)
+    assert response == {"disposition": "STOP_RULE_SET"}
+
+
 def test_sns_trigger_event():
     event = SNSEvent(load_event("snsEvent.json"))
     records = list(event.records)