Skip to content

Commit f01f0b4

Browse files
author
Michael Brewer
committed
docs(data-classes): Make note about the wrapped dict
1 parent 55cb42b commit f01f0b4

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

docs/utilities/data_classes.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -252,12 +252,15 @@ Verify Auth Challenge | `data_classes.cognito_user_pool_event.VerifyAuthChalleng
252252

253253
#### Define Auth Challenge Example
254254

255+
> **NOTE:** In this example we are modifying the wrapped dict response fields, so we need to return the json serializable
256+
> wrapped `event.data`
257+
255258
=== "app.py"
256259

257260
```python
258261
from aws_lambda_powertools.utilities.data_classes.cognito_user_pool_event import DefineAuthChallengeTriggerEvent
259262

260-
def handler(event, context):
263+
def handler(event: dict, context) -> dict:
261264
event: DefineAuthChallengeTriggerEvent = DefineAuthChallengeTriggerEvent(event)
262265
if (
263266
len(event.request.session) == 1
@@ -409,7 +412,7 @@ Verify Auth Challenge | `data_classes.cognito_user_pool_event.VerifyAuthChalleng
409412
```python
410413
from aws_lambda_powertools.utilities.data_classes.cognito_user_pool_event import CreateAuthChallengeTriggerEvent
411414

412-
def handler(event, context):
415+
def handler(event: dict, context) -> dict:
413416
event: CreateAuthChallengeTriggerEvent = CreateAuthChallengeTriggerEvent(event)
414417
if event.request.challenge_name == "CUSTOM_CHALLENGE":
415418
event.response.public_challenge_parameters = {"captchaUrl": "url/123.jpg"}
@@ -425,7 +428,7 @@ Verify Auth Challenge | `data_classes.cognito_user_pool_event.VerifyAuthChalleng
425428
```python
426429
from aws_lambda_powertools.utilities.data_classes.cognito_user_pool_event import VerifyAuthChallengeResponseTriggerEvent
427430

428-
def handler(event, context):
431+
def handler(event: dict, context) -> dict:
429432
event: VerifyAuthChallengeResponseTriggerEvent = VerifyAuthChallengeResponseTriggerEvent(event)
430433
event.response.answer_correct = (
431434
event.request.private_challenge_parameters.get("answer") == event.request.challenge_answer

0 commit comments

Comments
 (0)