feat(aws): improve docstrings

[pedrooot]

Description

This pull request introduces comprehensive docstrings to the AwsProvider class and its methods in the prowler/providers/aws/aws_provider.py file. These changes aim to enhance code readability and provide clear documentation for future developers.

Enhancements to Documentation:

• Class-level docstring:

  • Added a detailed description of the AwsProvider class, including its responsibilities and attributes.

• Method-level docstrings:

  • __init__: Expanded the description of session_duration and provided usage examples for different initialization scenarios. [1] [2]
  • set_identity: Added a comprehensive description of the method, including arguments, return type, and possible exceptions.
  • setup_session: Documented the method's purpose, arguments, return type, and potential exceptions.
  • print_credentials: Added a docstring to describe the method's functionality and provide an example output.
  • get_checks_from_input_arn: Included a description, return type, and example usage.
  • get_regions_from_audit_resources: Detailed the arguments, return type, and provided an example.
  • get_default_region: Explained the method's purpose, arguments, return type, and provided an example.
  • get_global_region: Clarified the method's functionality, return type, and provided an example.
  • input_role_mfa_token_and_code: Added a description of the method, its return type, and an example.
  • set_session_config: Included a description of the method's arguments and return type.
  • assume_role: Provided a detailed description of the method, its arguments, and return type. [1] [2]
  • get_aws_enabled_regions: Added a comprehensive docstring detailing the method's arguments and return type.
  • get_checks_to_execute_by_audit_resources: Documented the method's purpose and return type.
  • get_aws_region_for_sts: Included a description of the function, its arguments, return type, and an example.

Checklist

• Are there new checks included in this PR? Yes / No
  • If so, do we need to update permissions for the provider? Please review this carefully.
• Review if the code is being covered by tests.
• Review if code is being documented following this specification https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings
• Review if backport is needed.

License

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.87%. Comparing base (344d541) to head (96e7a00).
Report is 12 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5714      +/-   ##
==========================================
- Coverage   89.94%   89.87%   -0.07%     
==========================================
  Files        1124     1128       +4     
  Lines       34815    35182     +367     
==========================================
+ Hits        31313    31620     +307     
- Misses       3502     3562      +60     

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