Fail

Define a Fail state in the state machine.

Reaching a Fail state terminates the state execution in failure.

Source: aws-stepfunctions/lib/states/fail.ts
Type last changed: v2.178.0 · 6 Feb 2025

Example

const fail = new sfn.Fail(this, 'Fail', {
  errorPath: sfn.JsonPath.format('error: {}.', sfn.JsonPath.stringAt('$.someError')),
  causePath: "States.Format('cause: {}.', $.someCause)",
});

python

fail = sfn.Fail(self, "Fail",
    error_path=sfn.JsonPath.format("error: {}.", sfn.JsonPath.string_at("$.someError")),
    cause_path="States.Format('cause: {}.', $.someCause)"
)

java

Fail fail = Fail.Builder.create(this, "Fail")
        .errorPath(JsonPath.format("error: {}.", JsonPath.stringAt("$.someError")))
        .causePath("States.Format('cause: {}.', $.someCause)")
        .build();

csharp

// Install: dotnet add package Amazon.CDK.Lib
var fail = new Fail(this, "Fail", new FailProps {
    ErrorPath = JsonPath.Format("error: {}.", JsonPath.StringAt("$.someError")),
    CausePath = "States.Format('cause: {}.', $.someCause)"
});

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
fail := sfn.NewFail(this, jsii.String("Fail"), &FailProps{
	ErrorPath: sfn.JsonPath_Format(jsii.String("error: {}."), sfn.JsonPath_StringAt(jsii.String("$.someError"))),
	CausePath: jsii.String("States.Format('cause: {}.', $.someCause)"),
})

Initializer

new Fail(scope: Construct, id: string, props?: FailProps)

python

Fail(scope: Construct, id: str, props: typing.Optional[FailProps] = None)

java

new Fail(Construct scope, String id, FailProps props)

csharp

new Fail(Construct scope, string id, FailProps? props = null)

NewFail(Scope Construct, Id *string, Props FailProps)

Construct Props

causeoptionalstringcauseoptionalstrcauseoptionalStringCauseoptionalstringCauseoptional*string#

A description for the cause of the failure.

Default: No description

causePathoptionalstringcause_pathoptionalstrcausePathoptionalStringCausePathoptionalstringCausePathoptional*string#

JsonPath expression to select part of the state to be the cause to this state.

Default: No cause path

notes

You can also use an intrinsic function that returns a string to specify this property. The allowed functions include States.Format, States.JsonToString, States.ArrayGetItem, States.Base64Encode, States.Base64Decode, States.Hash, and States.UUID.

commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string#

A comment describing this state.

Default: No comment

erroroptionalstringerroroptionalstrerroroptionalStringErroroptionalstringErroroptional*string#

Error code used to represent this failure.

Default: No error code

errorPathoptionalstringerror_pathoptionalstrerrorPathoptionalStringErrorPathoptionalstringErrorPathoptional*string#

JsonPath expression to select part of the state to be the error to this state.

Default: No error path

notes

queryLanguageoptionalQueryLanguagequery_languageoptionalQueryLanguagequeryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguage= JSONPath#

The name of the query language used by the state.

If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

stateNameoptionalstringstate_nameoptionalstrstateNameoptionalStringStateNameoptionalstringStateNameoptional*string#

Optional name for this state.

Default: The construct ID will be used as state name

Properties

endStatesINextable[]end_statestyping.List[INextable]endStatesList<INextable>EndStatesINextable[]EndStates*[]INextablerequired#

Continuable states of this Chainable.

idstringidstridStringIdstringId*stringrequired#

Descriptive identifier for this chainable.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

startStateStatestart_stateStatestartStateStateStartStateStateStartStateStaterequired#

First state of this Chainable.

stateIdstringstate_idstrstateIdStringStateIdstringStateId*stringrequired#

Tokenized string that evaluates to the state's ID.

Methods

addPrefix(x: string): voiddef add_prefix(self, x: str) -> Nonepublic void addPrefix(String x)public void AddPrefix(string x)func AddPrefix(X *string)#

Add a prefix to the stateId of this state.

bindToGraph(graph: StateGraph): voiddef bind_to_graph(self, graph: StateGraph) -> Nonepublic void bindToGraph(StateGraph graph)public void BindToGraph(StateGraph graph)func BindToGraph(Graph StateGraph)#

Don't call this. It will be called automatically when you work with states normally.

filterNextables(states: State[]): INextable[]@staticmethod def filter_nextables(states: typing.List[State]) -> typing.List[INextable]public static List<INextable> filterNextables(List<State> states)public static INextable[] FilterNextables(State[] states)func FilterNextables(States *[]State) *[]INextablestatic#

Return only the states that allow chaining from an array of states.

findReachableEndStates(start: State, options?: FindStateOptions): State[]

@staticmethod def find_reachable_end_states(start: State, options: typing.Optional[FindStateOptions] = None) -> typing.List[State]

public static List<State> findReachableEndStates(State start, FindStateOptions options)public static State[] FindReachableEndStates(State start, FindStateOptions? options = null)func FindReachableEndStates(Start State, Options FindStateOptions) *[]Statestatic#

Find the set of end states states reachable through transitions from the given start state.

findReachableStates(start: State, options?: FindStateOptions): State[]

@staticmethod def find_reachable_states(start: State, options: typing.Optional[FindStateOptions] = None) -> typing.List[State]

public static List<State> findReachableStates(State start, FindStateOptions options)public static State[] FindReachableStates(State start, FindStateOptions? options = null)func FindReachableStates(Start State, Options FindStateOptions) *[]Statestatic#

Find the set of states reachable through transitions from the given start state.

This does not retrieve states from within sub-graphs, such as states within a Parallel state's branch.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

jsonata(scope: Construct, id: string, props?: FailJsonataProps): Fail // chainable@staticmethod def jsonata(scope: Construct, id: str, props: typing.Optional[FailJsonataProps] = None) -> Failpublic static Fail jsonata(Construct scope, String id, FailJsonataProps props)public static Fail Jsonata(Construct scope, string id, FailJsonataProps? props = null)func Jsonata(Scope Construct, Id *string, Props FailJsonataProps) Failstatic#

Define a Fail state using JSONata in the state machine.

Reaching a Fail state terminates the state execution in failure.

jsonPath(scope: Construct, id: string, props?: FailJsonPathProps): Fail // chainable@staticmethod def json_path(scope: Construct, id: str, props: typing.Optional[FailJsonPathProps] = None) -> Failpublic static Fail jsonPath(Construct scope, String id, FailJsonPathProps props)public static Fail JsonPath(Construct scope, string id, FailJsonPathProps? props = null)func JsonPath(Scope Construct, Id *string, Props FailJsonPathProps) Failstatic#

Define a Fail state using JSONPath in the state machine.

Reaching a Fail state terminates the state execution in failure.

prefixStates(root: IConstruct, prefix: string): void@staticmethod def prefix_states(root: IConstruct, prefix: str) -> Nonepublic static void prefixStates(IConstruct root, String prefix)public static void PrefixStates(IConstruct root, string prefix)func PrefixStates(Root IConstruct, Prefix *string)static#

Add a prefix to the stateId of all States found in a construct tree.

toStateJson(queryLanguage?: QueryLanguage): jsondef to_state_json(self, query_language: typing.Optional[QueryLanguage] = None) -> Anypublic Object toStateJson(QueryLanguage queryLanguage)public object ToStateJson(QueryLanguage? queryLanguage = null)func ToStateJson(QueryLanguage QueryLanguage) interface{}#

Return the Amazon States Language object for this state.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

1 parameter · returns

Parameters

mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining

Fail ​

Example ​

Initializer ​

Construct Props ​

Properties ​

Methods ​

Fail

Example

Initializer

Construct Props

Properties

Methods