From 205163fc0d2cac84d3d746a98c393e137f0e2388 Mon Sep 17 00:00:00 2001 From: Josh Kupershmidt Date: Mon, 13 May 2024 19:16:41 -0400 Subject: [PATCH] fix(stepfunctions-tasks): documentation fix for retryOnServiceExceptions (#30077) ### Issue # (if applicable) N/A ### Reason for this change Doc correction for `retryOnServiceExceptions`. The code here was updated in https://github.com/aws/aws-cdk/pull/26474 , so that the error `Lambda.ClientExecutionTimeoutException` is handled automatically by [`retryOnServiceExceptions`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks.LambdaInvoke.html#retryonserviceexceptions). However, the documentation comment was not updated to reflect this change. ### Description of changes Explain that `Lambda.ClientExecutionTimeoutException` is also handled automatically as part of [retryOnServiceExceptions](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks.LambdaInvoke.html#retryonserviceexceptions) ### Description of how you validated changes N/A ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license* --- .../aws-cdk-lib/aws-stepfunctions-tasks/lib/lambda/invoke.ts | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/lambda/invoke.ts b/packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/lambda/invoke.ts index d1578308b7c8c..2a910381c4aa7 100644 --- a/packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/lambda/invoke.ts +++ b/packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/lambda/invoke.ts @@ -63,8 +63,9 @@ export interface LambdaInvokeProps extends sfn.TaskStateBaseProps { /** * Whether to retry on Lambda service exceptions. * - * This handles `Lambda.ServiceException`, `Lambda.AWSLambdaException` and - * `Lambda.SdkClientException` with an interval of 2 seconds, a back-off rate + * This handles `Lambda.ServiceException`, `Lambda.AWSLambdaException`, + * `Lambda.SdkClientException`, and `Lambda.ClientExecutionTimeoutException` + * with an interval of 2 seconds, a back-off rate * of 2 and 6 maximum attempts. * * @see https://docs.aws.amazon.com/step-functions/latest/dg/bp-lambda-serviceexception.html