Skip to content

Commit

Permalink
fix(stepfunctions-tasks): documentation fix for retryOnServiceExcepti…
Browse files Browse the repository at this point in the history
…ons (#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*
  • Loading branch information
schmiddy committed May 13, 2024
1 parent 71986ff commit 205163f
Showing 1 changed file with 3 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 205163f

Please sign in to comment.