feat(user-agent): add custom header User-Agent to AWS SDK requests

[roger-zhangg]

Issue number: #2284

Summary

Implement standard user-agent in Powertools

Changes

• AWS SDK request created by/with Powertools will include standard powertools user-agent string
• Feature specific user-agent added for idempotency and parameters feature

User experience

• UX is not affect by this change

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 -> Document after review finalized
• 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.

[github-actions]

No related issues found. Please ensure there is an open issue related to this change to avoid significant delays or closure.

[codecov-commenter]

Codecov Report

Patch coverage: 75.60% and project coverage change: -0.26 ⚠️

Comparison is base (9e0f15c) 97.47% compared to head (b79bd83) 97.21%.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #2267      +/-   ##
===========================================
- Coverage    97.47%   97.21%   -0.26%     
===========================================
  Files          150      152       +2     
  Lines         6925     6998      +73     
  Branches       509      513       +4     
===========================================
+ Hits          6750     6803      +53     
- Misses         137      155      +18     
- Partials        38       40       +2     

Impacted Files	Coverage Δ
aws_lambda_powertools/shared/user_agent.py	61.22% <61.22%> (ø)
..._powertools/utilities/streaming/_s3_seekable_io.py	89.00% <80.00%> (-0.48%)	⬇️
aws_lambda_powertools/__init__.py	100.00% <100.00%> (ø)
aws_lambda_powertools/shared/version.py	100.00% <100.00%> (ø)
.../utilities/data_classes/code_pipeline_job_event.py	100.00% <100.00%> (ø)
...ools/utilities/idempotency/persistence/dynamodb.py	100.00% <100.00%> (ø)
aws_lambda_powertools/utilities/parameters/base.py	99.15% <100.00%> (+0.04%)	⬆️

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[leandrodamascena]

Hi @heitorlessa! After some hard work and efforts put into research, PoC, and exhaustive tests done by Roger and me, I think we need one last review from you on this PR before the merge.
Thanks for all the effort @roger-zhangg!

[heitorlessa]

looks great! Some initial comments to make reading code and refactoring later easier.

I'll look on doc strings and for ergonomics when I have more time during the flight.

Just missing this additional area for user-agent:

• https://awslabs.github.io/aws-lambda-powertools-python/2.15.0/utilities/data_classes/#codepipeline-job
  • Code: https://github.com/awslabs/aws-lambda-powertools-python/blob/develop/aws_lambda_powertools/utilities/data_classes/code_pipeline_job_event.py#L206

[roger-zhangg]

Hey Heitor,
Thanks for this detailed review. I've updated all files related to your comments. Please check.

Thanks!
Roger

[leandrodamascena]

Just missing this additional area for user-agent:

• awslabs.github.io/aws-lambda-powertools-python/2.15.0/utilities/data_classes/#codepipeline-job

  • Code: develop/aws_lambda_powertools/utilities/data_classes/code_pipeline_job_event.py#L206

Thank you for indicating this area @heitorlessa! I Didn't remember we made life easier to get objects from S3 when using CodePipelineJob :)

[leandrodamascena]

Hello @roger-zhangg! This is a huge amount of great work! Thanks for all efforts and research to make it possible.

APPROVED!

[boring-cyborg]

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