feat(parser): Add IoT registry events models

[basvandriel]

Issue number: #5891

Summary

This implements the missing model for IoT registry events.

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.27%. Comparing base (053f1f1) to head (5719499).
Report is 1 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #5892      +/-   ##
===========================================
+ Coverage    96.25%   96.27%   +0.02%     
===========================================
  Files          234      235       +1     
  Lines        11140    11204      +64     
  Branches       822      822              
===========================================
+ Hits         10723    10787      +64     
  Misses         327      327              
  Partials        90       90              

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

[leandrodamascena]

Hey @basvandriel, we need to address this comment before reviewing this PR: #5891 (comment).

Thanks

[basvandriel]

Hi @leandrodamascena, I updated my branch to include all registry events, documented on this page. Please let me know if you would like to see additional changes, unit tests or any documentation.

We could also add aliases such as Field(alias='thingId') values to be conform to the Python snake_case convention. However, I saw multiple models just having the names written in camelCase. Let me know! :-)

[leandrodamascena]

Hi @basvandriel! Thank you so much for working on this PR and adding all the events! I have some feedback to make it more consistent and establish a naming standard.

Also, we need to include tests to verify that this is serializing as expected, you can copy this AWS events to test. In the documentation section https://docs.powertools.aws.dev/lambda/python/latest/utilities/parser/#built-in-models we need to add the new Models.

I also have a suggestion for the variable names, but I'd rather you correct the feedback I gave now and then we'll go to round two, okay?

[leandrodamascena]

We could also add aliases such as Field(alias='thingId') values to be conform to the Python snake_case convention. However, I saw multiple models just having the names written in camelCase. Let me know! :-)

Hey, please move on with this!

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[leandrodamascena]

Hi @basvandriel! Please let me know when you need me to review it again, okay?

[basvandriel]

Hi @basvandriel! Please let me know when you need me to review it again, okay?

Hi @leandrodamascena, I made a misclick. I'll let you know!

[basvandriel]

Hi @leandrodamascena, I've added the serialization tests and the documentation. I've tried to use the same format as the previous rows, e.g. Lambda Event Source payload for IoT Core Thing created, updated, or deleted.. Let me know like to see other changes.

[leandrodamascena]

Hi @basvandriel! Thanks for working on this PR and resolving all the comments! This is really great work and contribution!

I just pushed a commit with a few changes:

1 - Added docstrings to all classes
2 - Moved JSON events to the events folder because people often come to our repository to copy these events as a source of truth.
3 - I have a feeling that rootToParentThingGroups is a list with arbitrary fields and not onlyarnid. So I converted it to a list of Dicts to have a guardrail.
4 - I added the even_type field with literal values ​​to the corresponding classes.

I'm approving this PR and we'll merge it next week. We will release it in the next release of Powertools, which is expected on 2/25.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[basvandriel]

Thanks @leandrodamascena. Lets stay in touch - I'd love to work on the project some more.

[leandrodamascena]

Thanks @leandrodamascena. Lets stay in touch - I'd love to work on the project some more.

That's great to know! How about you add these events to our Event Source Data Class utility? The main difference is that in this utility we don't use Pydantic to do strict validation, but instead we convert the event to an object to help developers access properties like a python object. Here are some examples: https://github.com/aws-powertools/powertools-lambda-python/tree/develop/aws_lambda_powertools/utilities/data_classes.

Please let me know what you think and if you agree, feel free to open an issue and send a PR.