Package software.amazon.awscdk.services.stepfunctions

Interface CatchProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CatchProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:41:01.403Z")
@Stability(Stable)
public interface CatchProps
extends software.amazon.jsii.JsiiSerializable

Error handler details.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.stepfunctions.*;
 Object assign;
 Object outputs;
 CatchProps catchProps = CatchProps.builder()
         .assign(Map.of(
                 "assignKey", assign))
         .errors(List.of("errors"))
         .outputs(outputs)
         .resultPath("resultPath")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CatchProps.Builder	A builder for CatchProps
static final class	CatchProps.Jsii$Proxy	An implementation for CatchProps

Method Summary

Modifier and Type	Method	Description
static CatchProps.Builder	builder()
default Map<String,Object>	getAssign()	Workflow variables to store in this step.
default List<String>	getErrors()	Errors to recover from by going to the given state.
default Object	getOutputs()	This option for JSONata only.
default String	getResultPath()	JSONPath expression to indicate where to inject the error data.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAssign

@Stability(Stable)
@Nullable
default Map<String,Object> getAssign()

Workflow variables to store in this step.

Using workflow variables, you can store data in a step and retrieve that data in future steps.

Default: - Not assign variables

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html

getErrors

@Stability(Stable)
@Nullable
default List<String> getErrors()

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

getOutputs

@Stability(Stable)
@Nullable
default Object getOutputs()

This option for JSONata only.

When you use JSONPath, then the state ignores this property. Used to specify and transform output from the state. When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

Default: - $states.result or $states.errorOutput

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html

getResultPath

@Stability(Stable)
@Nullable
default String getResultPath()

JSONPath expression to indicate where to inject the error data.

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

Default: $

builder

@Stability(Stable)
static CatchProps.Builder builder()

Returns:

a CatchProps.Builder of CatchProps