{{ message }}
refactor(parser): Improve SQS models with examples and descriptions#7286
Merged
leandrodamascena merged 4 commits intoaws-powertools:developfrom Sep 1, 2025
Merged
Conversation
Enhances the SQS parser models with field descriptions and examples using Pydantic's Field() functionality. This improvement provides better documentation and metadata for SQS event parsing, following the pattern established in PR aws-powertools#7100. All field descriptions are based on official AWS SQS documentation and include realistic examples from actual test events. Closes aws-powertools#7116
pull-request-size
Bot
added
the
size/L
Contributor
leandrodamascena
left a comment
leandrodamascena
left a comment
There was a problem hiding this comment.
Hey @dcabib thanks a lot! Just a small change and we are ready to merge.
Contributor
|
Hey @dcabib please run |
Remove extremely long receiptHandle example as requested by leandrodamascena and apply ruff formatting to fix CI issues.
|
dreamorosi
approved these changes
Sep 1, 2025
leandrodamascena
approved these changes
Sep 1, 2025
Contributor
leandrodamascena
left a comment
leandrodamascena
left a comment
There was a problem hiding this comment.
Thanks @dcabib! Approved!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
closes #7116
Summary
Enhances the SQS parser models with field descriptions and examples using Pydantic's Field() functionality. This improvement provides better documentation and metadata for SQS event parsing, following the pattern established in PR #7100.
Changes
Added Field() descriptions and examples to all SQS parser model classes:
SqsAttributesModel- Core SQS message attributes with AWS-accurate descriptionsSqsMsgAttributeModel- User-defined message attributes with comprehensive documentationSqsRecordModel- Individual SQS record structure with detailed field explanationsSqsModel- Root SQS event model with proper sequence documentationAll field descriptions are based on official AWS SQS documentation
Examples sourced from actual test events (sqsEvent.json, sqsDlqTriggerEvent.json)
Maintains 100% backward compatibility - no breaking changes to type annotations or validation logic
User experience
Customers will be able to see examples and descriptions when using SQS parser models, providing:
Checklist
Is this a breaking change? No
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.
Closes #7116