feat(events): Update and Add Cognito User Pool Events

[knightmre]

Issue number: #3987

Summary

Changes

Please provide a summary of what's being changed

This change updates the UserMigrationTriggerEvent data class, adds the V2 of Pre Token Generation Lambda Triggers and adds two new data classes for Custom Sender Lambda triggers

User experience

Please share what the user experience looks like before and after this change

Events did not exist before. A workaround was to self-implement the data classes by inheriting base classes like so:

Before

from typing import Optional

from aws_lambda_powertools.utilities.data_classes import cognito_user_pool_event
from aws_lambda_powertools.utilities.data_classes import common


class CustomSMSSenderTriggerEventRequest(common.DictWrapper):
    @property
    def code(self) -> str:
        """A string for you to use as the placeholder for the verification code in the custom message."""
        return self["request"]["code"]

    @property
    def user_attributes(self) -> dict[str, str]:
        """One or more name-value pairs representing user attributes. The attribute names are the keys."""
        return self["request"]["userAttributes"]

    @property
    def client_metadata(self) -> Optional[dict[str, str]]:
        """One or more key-value pairs that you can provide as custom input to the Lambda function
        that you specify for the pre sign-up trigger."""
        return self["request"].get("clientMetadata")


class CustomSMSSenderEvent(cognito_user_pool_event.BaseTriggerEvent):

    @property
    def request(self) -> CustomSMSSenderTriggerEventRequest:
        return CustomSMSSenderTriggerEventRequest(self._data)

from . import CustomSMSSenderEvent

@data_classes.event_source(data_class=CustomSMSSenderEvent)
def handler(event: CustomSMSSenderEvent, context):
    return handle_event(event=event)

After

from aws_lambda_powertools.utilities.data_classes.cognito_user_pool_event import CustomSMSSenderTriggerEvent

@data_classes.event_source(data_class=CustomSMSSenderTriggerEvent)
def handler(event: CustomSMSSenderTriggerEvent, context):
    return handle_event(event=event)

Checklist

If your change doesn't seem to apply, please leave them unchecked.

• Meet tenets criteria
• I have performed a self-review of this change
• Changes have been tested
• Changes are documented
• PR title follows conventional commit semantics

Is this a breaking change?

RFC issue number:

Checklist:

• Migration process documented
• Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

[boring-cyborg]

Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need.
In the meantime, check out the #python channel on our Powertools for AWS Lambda Discord: Invite link

[leandrodamascena]

Hi @knightmre this is a super detailed PR with an impressive level of awesome docs/documentation. I'm working on other PRs and will schedule the first review of this PR for early next week.

Thanks

[knightmre]

Hi @knightmre this is a super detailed PR with an impressive level of awesome docs/documentation. I'm working on other PRs and will schedule the first review of this PR for early next week.

Thanks

Hi, thanks for your time, I just found out I missed out on some tests so I'll be reworking this a little before your review.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.43%. Comparing base (e14e768) to head (b24173d).
Report is 561 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #4423      +/-   ##
===========================================
+ Coverage    96.38%   96.43%   +0.05%     
===========================================
  Files          214      219       +5     
  Lines        10030    10623     +593     
  Branches      1846     1976     +130     
===========================================
+ Hits          9667    10244     +577     
- Misses         259      267       +8     
- Partials       104      112       +8     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[leandrodamascena]

Reviewing this now.

[leandrodamascena]

Hey @knightmre! Well done! This was one of the most detailed PRs I've looked at. Creating all those events in Cognito must have taken a lot of hard work and I'm sure you spent some days. I tried making some myself, and it took me over a day.

I just made a few small comments to your great work. 🚀

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
3.9% Duplication on New Code

See analysis details on SonarCloud

[knightmre]

Hey @knightmre! Well done! This was one of the most detailed PRs I've looked at. Creating all those events in Cognito must have taken a lot of hard work and I'm sure you spent some days. I tried making some myself, and it took me over a day.

I just made a few small comments to your great work. 🚀

Hi @leandrodamascena Thanks for the review. I've included your comments and updated the PR.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
3.9% Duplication on New Code

See analysis details on SonarCloud

[leandrodamascena]

I'm going to say this again: amazing work @knightmre!

APPROVED!

[boring-cyborg]

Awesome work, congrats on your first merged pull request and thank you for helping improve everyone's experience!