AWS powertools documentation change
Summary
Updated API documentation for SSM parameter utility, including return type changes (adding None), source code line number adjustments, and type annotation fixes
Security assessment
These changes are documentation updates for the AWS Lambda Powertools library's SSM parameter utility. The modifications include adding None as a possible return type for get_parameter methods, updating source code line numbers, and fixing type annotations. While SSM parameters often store sensitive data, these changes appear to be routine documentation maintenance and type system improvements rather than security fixes. No security vulnerabilities or security feature additions are indicated.
Diff
diff --git a/powertools/python/latest/api_doc/parameters/ssm.md b/powertools/python/latest/api_doc/parameters/ssm.md index a1b8b94f6..2aace8bfc 100644 --- a//powertools/python/latest/api_doc/parameters/ssm.md +++ b//powertools/python/latest/api_doc/parameters/ssm.md @@ -57,0 +58 @@ Metrics + * [ Metadata ](../../../utilities/metadata/) @@ -1183 +1184 @@ Source code in `aws_lambda_powertools/utilities/parameters/ssm.py` - get_parameter(name: str, transform: TransformOptions = None, decrypt: bool | None = None, force_fetch: bool = False, max_age: int | None = None, **sdk_options) -> str | bytes | dict + get_parameter(name: str, transform: TransformOptions = None, decrypt: bool | None = None, force_fetch: bool = False, max_age: int | None = None, **sdk_options) -> str | bytes | dict | None @@ -1338 +1339 @@ Source code in `aws_lambda_powertools/utilities/parameters/ssm.py` - ) -> str | bytes | dict: + ) -> str | bytes | dict | None: @@ -1768,2 +1768,0 @@ Source code in `aws_lambda_powertools/utilities/parameters/ssm.py` - 1115 - 1116 @@ -1845,0 +1845,2 @@ Source code in `aws_lambda_powertools/utilities/parameters/ssm.py` + 1193 + 1194 @@ -2068,0 +2070,2 @@ Source code in `aws_lambda_powertools/utilities/parameters/ssm.py` + 1073 + 1074 @@ -2136 +2139,3 @@ Source code in `aws_lambda_powertools/utilities/parameters/ssm.py` - return DEFAULT_PROVIDERS["ssm"].set( + provider: SSMProvider = DEFAULT_PROVIDERS["ssm"] + + return provider.set( # ty: ignore[no-matching-overload] @@ -2139 +2144 @@ Source code in `aws_lambda_powertools/utilities/parameters/ssm.py` - parameter_type=parameter_type, + parameter_type=parameter_type, # type: ignore[arg-type] @@ -2143 +2148 @@ Source code in `aws_lambda_powertools/utilities/parameters/ssm.py` - kms_key_id=kms_key_id, + kms_key_id=kms_key_id, # type: ignore[arg-type]