Skip to content

Commit 205163f

Browse files
authored
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 #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*
1 parent 71986ff commit 205163f

File tree

1 file changed

+3
-2
lines changed
  • packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/lambda

1 file changed

+3
-2
lines changed

packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/lambda/invoke.ts

+3-2
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,9 @@ export interface LambdaInvokeProps extends sfn.TaskStateBaseProps {
6363
/**
6464
* Whether to retry on Lambda service exceptions.
6565
*
66-
* This handles `Lambda.ServiceException`, `Lambda.AWSLambdaException` and
67-
* `Lambda.SdkClientException` with an interval of 2 seconds, a back-off rate
66+
* This handles `Lambda.ServiceException`, `Lambda.AWSLambdaException`,
67+
* `Lambda.SdkClientException`, and `Lambda.ClientExecutionTimeoutException`
68+
* with an interval of 2 seconds, a back-off rate
6869
* of 2 and 6 maximum attempts.
6970
*
7071
* @see https://docs.aws.amazon.com/step-functions/latest/dg/bp-lambda-serviceexception.html

0 commit comments

Comments
 (0)