CatchProps

class aws_cdk.aws_stepfunctions.CatchProps(*, errors=None, result_path=None)

Bases: object

Error handler details.

Parameters:
  • errors (Optional[Sequence[str]]) – 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. Default: All errors

  • result_path (Optional[str]) – 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. Default: $

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_stepfunctions as stepfunctions

catch_props = stepfunctions.CatchProps(
    errors=["errors"],
    result_path="resultPath"
)

Attributes

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.

Default:

All errors

result_path

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.

Default:

$