aws-cdk-lib.aws_stepfunctions.CatchProps

interface CatchProps

LanguageType name
.NETAmazon.CDK.AWS.StepFunctions.CatchProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#CatchProps
Javasoftware.amazon.awscdk.services.stepfunctions.CatchProps
Pythonaws_cdk.aws_stepfunctions.CatchProps
TypeScript (source)aws-cdk-lib » aws_stepfunctions » CatchProps

Error handler details.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
const catchProps: stepfunctions.CatchProps = {
  errors: ['errors'],
  resultPath: 'resultPath',
};

Properties

NameTypeDescription
errors?string[]Errors to recover from by going to the given state.
resultPath?stringJSONPath expression to indicate where to inject the error data.

errors?

Type: string[] (optional, default: All errors)

Errors to recover from by going to the given state.

A list of error strings to retry, which can be either predefined errors (for example Errors.NoChoiceMatched) or a self-defined error.


resultPath?

Type: string (optional, default: $)

JSONPath expression to indicate where to inject the error data.

May also be the special value DISCARD, which will cause the error data to be discarded.