Skip to content

Commit 9926832

Browse files
committed
chore(docs): Add some of the missing docstrings
For , this refers to the context parameters returned by the lambda authorizer (optional) For , this refers to the IAM authorization details
1 parent 4724886 commit 9926832

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

aws_lambda_powertools/utilities/data_classes/api_gateway_proxy_event.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -270,6 +270,7 @@ def user_agent(self) -> str:
270270
class RequestContextV2AuthorizerIam(DictWrapper):
271271
@property
272272
def access_key(self) -> Optional[str]:
273+
"""The IAM user access key associated with the request."""
273274
return self.get("accessKey")
274275

275276
@property
@@ -284,6 +285,8 @@ def caller_id(self) -> Optional[str]:
284285

285286
@property
286287
def cognito_amr(self) -> Optional[List[str]]:
288+
"""This represents how the user was authenticated.
289+
AMR stands for Authentication Methods References as per the openid spec"""
287290
return self["cognitoIdentity"].get("amr")
288291

289292
@property
@@ -310,6 +313,7 @@ def user_arn(self) -> Optional[str]:
310313

311314
@property
312315
def user_id(self) -> Optional[str]:
316+
"""The IAM user ID of the effective user identified after authentication."""
313317
return self.get("userId")
314318

315319

@@ -324,10 +328,12 @@ def jwt_scopes(self) -> List[str]:
324328

325329
@property
326330
def get_lambda(self) -> Optional[Dict[str, Any]]:
331+
"""Lambda authorization context details"""
327332
return self.get("lambda")
328333

329334
@property
330335
def iam(self) -> Optional[RequestContextV2AuthorizerIam]:
336+
"""IAM authorization details used for making the request."""
331337
iam = self.get("iam")
332338
return None if iam is None else RequestContextV2AuthorizerIam(iam)
333339

0 commit comments

Comments
 (0)