Merge branch 'develop' into docs/quick-start

Author: heitorlessa

.github/mergify.yml

@@ -1,28 +1,29 @@
+queue_rules:
+  - name: default
+    conditions:
+      # Conditions to get out of the queue (= merged)
+      - check-success=Semantic Pull Request
+      - "#approved-reviews-by>=1"
+      - -title~=(WIP|wip)
+      - -label~="do-not-merge"
+      - "#changes-requested-reviews-by=0"
+
 pull_request_rules:
   - name: automatic merge for Dependabot pull requests
     conditions:
       - author~=^dependabot(|-preview)\[bot\]$
 #       - check-success=build  # matrix jobs aren't working in mergify
-      - -label~="do-not-merge"
-      - "#approved-reviews-by>=1"  # until we exclude major versions in dependabot
     actions:
-      merge:
-        strict: false
+      queue:
         method: squash
         commit_message: title+body
 
   - name: Automatic merge ⬇️ on approval ✔
     conditions:
       - base!=master
-      - "#approved-reviews-by>=1"
-      - "#changes-requested-reviews-by=0"
-      - -title~=(WIP|wip)
 #       - check-success=build  # matrix jobs aren't working in mergify
-      - check-success=Semantic Pull Request
-      - body~=(?m)^\[X\] Meet tenets criteria
+      - "#approved-reviews-by>=2"
     actions:
-      merge:
-        strict: smart
+      queue:
         method: squash
-        strict_method: merge
         commit_message: title+body

README.md

@@ -4,9 +4,7 @@
 [![codecov.io](https://codecov.io/github/awslabs/aws-lambda-powertools-python/branch/develop/graphs/badge.svg)](https://app.codecov.io/gh/awslabs/aws-lambda-powertools-python)
 ![PythonSupport](https://img.shields.io/static/v1?label=python&message=3.6%20|%203.7|%203.8|%203.9&color=blue?style=flat-square&logo=python) ![PyPI version](https://badge.fury.io/py/aws-lambda-powertools.svg) ![PyPi monthly downloads](https://img.shields.io/pypi/dm/aws-lambda-powertools)
 
-A suite of Python utilities for AWS Lambda functions to ease adopting best practices such as tracing, structured logging, custom metrics, and more. ([AWS Lambda Powertools Java](https://github.com/awslabs/aws-lambda-powertools-java) is also available).
-
-
+A suite of Python utilities for AWS Lambda functions to ease adopting best practices such as tracing, structured logging, custom metrics, and more. (AWS Lambda Powertools [Java](https://github.com/awslabs/aws-lambda-powertools-java) and [Typescript](https://github.com/awslabs/aws-lambda-powertools-typescript) is also available).
 
 **[📜Documentation](https://awslabs.github.io/aws-lambda-powertools-python/)** | **[🐍PyPi](https://pypi.org/project/aws-lambda-powertools/)** | **[Roadmap](https://github.com/awslabs/aws-lambda-powertools-roadmap/projects/1)** | **[Detailed blog post](https://aws.amazon.com/blogs/opensource/simplifying-serverless-best-practices-with-lambda-powertools/)**
 
@@ -48,10 +46,9 @@ With [pip](https://pip.pypa.io/en/latest/index.html) installed, run: ``pip insta
 * Structured logging initial implementation from [aws-lambda-logging](https://gitlab.com/hadrien/aws_lambda_logging)
 * Powertools idea [DAZN Powertools](https://github.com/getndazn/dazn-lambda-powertools/)
 
-
 ## Connect
 
-* **AWS Developers Slack**: `#lambda-powertools`** - **[Invite, if you don't have an account](https://join.slack.com/t/awsdevelopers/shared_invite/zt-gu30gquv-EhwIYq3kHhhysaZ2aIX7ew)**
+* **AWS Developers Slack**: `#lambda-powertools` - **[Invite, if you don't have an account](https://join.slack.com/t/awsdevelopers/shared_invite/zt-yryddays-C9fkWrmguDv0h2EEDzCqvw)**
 * **Email**: aws-lambda-powertools-feedback@amazon.com
 
 ## License

aws_lambda_powertools/event_handler/api_gateway.py

@@ -101,7 +101,7 @@ def __init__(
             only be used during development.
         allow_headers: Optional[List[str]]
             The list of additional allowed headers. This list is added to list of
-            built in allowed headers: `Authorization`, `Content-Type`, `X-Amz-Date`,
+            built-in allowed headers: `Authorization`, `Content-Type`, `X-Amz-Date`,
             `X-Api-Key`, `X-Amz-Security-Token`.
         expose_headers: Optional[List[str]]
             A list of values to return for the Access-Control-Expose-Headers

aws_lambda_powertools/utilities/data_classes/api_gateway_authorizer_event.py

@@ -28,11 +28,12 @@ def __init__(
         self.api_id = api_id
         self.stage = stage
         self.http_method = http_method
-        self.resource = resource
+        # Remove matching "/" from `resource`.
+        self.resource = resource.lstrip("/")
 
     @property
     def arn(self) -> str:
-        """Build an arn from it's parts
+        """Build an arn from its parts
         eg: arn:aws:execute-api:us-east-1:123456789012:abcdef123/test/GET/request"""
         return (
             f"arn:{self.partition}:execute-api:{self.region}:{self.aws_account_id}:{self.api_id}/{self.stage}/"
@@ -168,7 +169,7 @@ def get_header_value(
         default_value: str, optional
             Default value if no value was found by name
         case_sensitive: bool
-            Whether to use a case sensitive look up
+            Whether to use a case-sensitive look up
         Returns
         -------
         str, optional
@@ -270,7 +271,7 @@ def get_header_value(
         default_value: str, optional
             Default value if no value was found by name
         case_sensitive: bool
-            Whether to use a case sensitive look up
+            Whether to use a case-sensitive look up
         Returns
         -------
         str, optional
@@ -440,9 +441,6 @@ def _add_route(self, effect: str, http_method: str, resource: str, conditions: O
         if not self._resource_pattern.match(resource):
             raise ValueError(f"Invalid resource path: {resource}. Path should match {self.path_regex}")
 
-        if resource[:1] == "/":
-            resource = resource[1:]
-
         resource_arn = APIGatewayRouteArn(
             self.region, self.aws_account_id, self.api_id, self.stage, http_method, resource
         ).arn

aws_lambda_powertools/utilities/data_classes/appsync_resolver_event.py

@@ -27,7 +27,7 @@ def source_ip(self) -> List[str]:
 
     @property
     def username(self) -> str:
-        """The user name of the authenticated user. IAM user principal"""
+        """The username of the authenticated user. IAM user principal"""
         return self["username"]
 
     @property
@@ -72,7 +72,7 @@ def source_ip(self) -> List[str]:
 
     @property
     def username(self) -> str:
-        """The user name of the authenticated user."""
+        """The username of the authenticated user."""
         return self["username"]
 
     @property
@@ -172,7 +172,7 @@ def arguments(self) -> Dict[str, Any]:
     def identity(self) -> Union[None, AppSyncIdentityIAM, AppSyncIdentityCognito]:
         """An object that contains information about the caller.
 
-        Depending of the type of identify found:
+        Depending on the type of identify found:
 
         - API_KEY authorization - returns None
         - AWS_IAM authorization - returns AppSyncIdentityIAM
@@ -223,7 +223,7 @@ def get_header_value(
         default_value: str, optional
             Default value if no value was found by name
         case_sensitive: bool
-            Whether to use a case sensitive look up
+            Whether to use a case-sensitive look up
         Returns
         -------
         str, optional

aws_lambda_powertools/utilities/data_classes/cognito_user_pool_event.py

@@ -195,7 +195,7 @@ def final_user_status(self) -> Optional[str]:
     @final_user_status.setter
     def final_user_status(self, value: str):
         """During sign-in, this attribute can be set to CONFIRMED, or not set, to auto-confirm your users and
-        allow them to sign-in with their previous passwords. This is the simplest experience for the user.
+        allow them to sign in with their previous passwords. This is the simplest experience for the user.
 
         If this attribute is set to RESET_REQUIRED, the user is required to change his or her password immediately
         after migration at the time of sign-in, and your client app needs to handle the PasswordResetRequiredException
@@ -333,7 +333,7 @@ class CustomMessageTriggerEvent(BaseTriggerEvent):
        verification code automatically to the user. Cannot be used for other attributes.
     - `CustomMessage_VerifyUserAttribute`  This trigger sends a verification code to the user when they manually
        request it for a new email or phone number.
-    - `CustomMessage_Authentication` To send MFA code during authentication.
+    - `CustomMessage_Authentication` To send MFA codes during authentication.
 
     Documentation:
     --------------
@@ -590,7 +590,7 @@ def user_attributes(self) -> Dict[str, str]:
     @property
     def user_not_found(self) -> Optional[bool]:
         """A Boolean that is populated when PreventUserExistenceErrors is set to ENABLED for your user pool client.
-        A value of true means that the user id (user name, email address, etc.) did not match any existing users."""
+        A value of true means that the user id (username, email address, etc.) did not match any existing users."""
         return self["request"].get("userNotFound")
 
     @property
@@ -601,7 +601,7 @@ def session(self) -> List[ChallengeResult]:
     @property
     def client_metadata(self) -> Optional[Dict[str, str]]:
         """One or more key-value pairs that you can provide as custom input to the Lambda function that you specify
-        for the define auth challenge trigger."""
+        for the defined auth challenge trigger."""
         return self["request"].get("clientMetadata")
 
 
@@ -687,7 +687,7 @@ def session(self) -> List[ChallengeResult]:
     @property
     def client_metadata(self) -> Optional[Dict[str, str]]:
         """One or more key-value pairs that you can provide as custom input to the Lambda function that you
-        specify for the create auth challenge trigger."""
+        specify for the creation auth challenge trigger."""
         return self["request"].get("clientMetadata")
 
 
@@ -699,7 +699,7 @@ def public_challenge_parameters(self) -> Dict[str, str]:
     @public_challenge_parameters.setter
     def public_challenge_parameters(self, value: Dict[str, str]):
         """One or more key-value pairs for the client app to use in the challenge to be presented to the user.
-        This parameter should contain all of the necessary information to accurately present the challenge to
+        This parameter should contain all the necessary information to accurately present the challenge to
         the user."""
         self["response"]["publicChallengeParameters"] = value
 
@@ -709,8 +709,8 @@ def private_challenge_parameters(self) -> Dict[str, str]:
 
     @private_challenge_parameters.setter
     def private_challenge_parameters(self, value: Dict[str, str]):
-        """This parameter is only used by the Verify Auth Challenge Response Lambda trigger.
-        This parameter should contain all of the information that is required to validate the user's
+        """This parameter is only used by the "Verify Auth Challenge" Response Lambda trigger.
+        This parameter should contain all the information that is required to validate the user's
         response to the challenge. In other words, the publicChallengeParameters parameter contains the
         question that is presented to the user and privateChallengeParameters contains the valid answers
         for the question."""
@@ -730,7 +730,7 @@ class CreateAuthChallengeTriggerEvent(BaseTriggerEvent):
     """Create Auth Challenge Lambda Trigger
 
     Amazon Cognito invokes this trigger after Define Auth Challenge if a custom challenge has been
-    specified as part of the Define Auth Challenge trigger.
+    specified as part of the "Define Auth Challenge" trigger.
     It creates a custom authentication flow.
 
     Notes:
@@ -775,7 +775,7 @@ def challenge_answer(self) -> Any:
     @property
     def client_metadata(self) -> Optional[Dict[str, str]]:
         """One or more key-value pairs that you can provide as custom input to the Lambda function that
-        you specify for the verify auth challenge trigger."""
+        you specify for the "Verify Auth Challenge" trigger."""
         return self["request"].get("clientMetadata")
 
     @property

aws_lambda_powertools/utilities/data_classes/dynamo_db_stream_event.py

@@ -231,7 +231,7 @@ def aws_region(self) -> Optional[str]:
 
     @property
     def dynamodb(self) -> Optional[StreamRecord]:
-        """The main body of the stream record, containing all of the DynamoDB-specific fields."""
+        """The main body of the stream record, containing all the DynamoDB-specific fields."""
         stream_record = self.get("dynamodb")
         return None if stream_record is None else StreamRecord(stream_record)
 

aws_lambda_powertools/utilities/data_classes/s3_object_event.py

@@ -82,7 +82,7 @@ def get_header_value(
         default_value: str, optional
             Default value if no value was found by name
         case_sensitive: bool
-            Whether to use a case sensitive look up
+            Whether to use a case-sensitive look up
         Returns
         -------
         str, optional
@@ -128,7 +128,7 @@ def creation_date(self) -> str:
     @property
     def mfa_authenticated(self) -> str:
         """The value is true if the root user or IAM user whose credentials were used for the request also was
-        authenticated with an MFA device; otherwise, false.."""
+        authenticated with an MFA device; otherwise, false."""
         return self["mfaAuthenticated"]
 
 

aws_lambda_powertools/utilities/data_classes/sqs_event.py

@@ -76,7 +76,7 @@ def data_type(self) -> str:
 
 class SQSMessageAttributes(Dict[str, SQSMessageAttribute]):
     def __getitem__(self, key: str) -> Optional[SQSMessageAttribute]:  # type: ignore
-        item = super(SQSMessageAttributes, self).get(key)
+        item = super().get(key)
         return None if item is None else SQSMessageAttribute(item)  # type: ignore
 
 

aws_lambda_powertools/utilities/parameters/appconfig.py

@@ -92,10 +92,8 @@ def _get(self, name: str, **sdk_options) -> str:
         ----------
         name: str
             Name of the configuration
-        environment: str
-            Environment of the configuration
         sdk_options: dict, optional
-            Dictionary of options that will be passed to the Parameter Store get_parameter API call
+            Dictionary of options that will be passed to the client's get_configuration API call
         """
 
         sdk_options["Configuration"] = name
@@ -140,7 +138,7 @@ def get_app_config(
     max_age: int
         Maximum age of the cached value
     sdk_options: dict, optional
-        Dictionary of options that will be passed to the Parameter Store get_parameter API call
+        Dictionary of options that will be passed to the boto client get_configuration API call
 
     Raises
     ------
@@ -163,7 +161,7 @@ def get_app_config(
 
     **Retrieves a configuration value and decodes it using a JSON decoder**
 
-        >>> from aws_lambda_powertools.utilities.parameters import get_parameter
+        >>> from aws_lambda_powertools.utilities.parameters import get_app_config
         >>>
         >>> value = get_app_config("my_config", environment="my_env", application="my_env", transform='json')
         >>>

docs/index.md

@@ -11,7 +11,7 @@ A suite of utilities for AWS Lambda functions to ease adopting best practices su
 
 ## Tenets
 
-This project separates core utilities that will be available in other runtimes vs general utilities that might not be available across all runtimes.
+Core utilities such as Tracing, Logging, Metrics, and Event Handler will be available across all Lambda Powertools runtimes. Additional utilities are subjective to each language ecosystem and customer demand.
 
 * **AWS Lambda only**. We optimise for AWS Lambda function environments and supported runtimes only. Utilities might work with web frameworks and non-Lambda environments, though they are not officially supported.
 * **Eases the adoption of best practices**. The main priority of the utilities is to facilitate best practices adoption, as defined in the AWS Well-Architected Serverless Lens; all other functionality is optional.