Fail

class aws_cdk.aws_stepfunctions.Fail(scope, id, *, cause=None, comment=None, error=None)

Bases: aws_cdk.aws_stepfunctions.State

Define a Fail state in the state machine.

Reaching a Fail state terminates the state execution in failure.

stability :stability: experimental

__init__(scope, id, *, cause=None, comment=None, error=None)
Parameters
  • scope (Construct) –

  • id (str) –

  • props

  • cause (Optional[str]) – A description for the cause of the failure. Default: No description

  • comment (Optional[str]) – An optional description for this state. Default: No comment

  • error (Optional[str]) – Error code used to represent this failure. Default: No error code

stability :stability: experimental

Return type

None

Methods

add_prefix(x)

Add a prefix to the stateId of this state.

Parameters

x (str) –

stability :stability: experimental

Return type

None

bind_to_graph(graph)

Register this state as part of the given graph.

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

Parameters

graph (StateGraph) –

stability :stability: experimental

Return type

None

to_state_json()

Return the Amazon States Language object for this state.

stability :stability: experimental

Return type

Mapping[Any, Any]

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

end_states

Continuable states of this Chainable.

stability :stability: experimental

Return type

List[INextable]

id

Descriptive identifier for this chainable.

stability :stability: experimental

Return type

str

node

Construct tree node which offers APIs for interacting with the construct tree.

Return type

ConstructNode

start_state

First state of this Chainable.

stability :stability: experimental

Return type

State

state_id

Tokenized string that evaluates to the state’s ID.

stability :stability: experimental

Return type

str

Static Methods

classmethod filter_nextables(states)

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

Parameters

states (List[State]) –

stability :stability: experimental

Return type

List[INextable]

classmethod find_reachable_end_states(start, *, include_error_handlers=None)

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

Parameters
  • start (State) –

  • options

  • include_error_handlers (Optional[bool]) – Whether or not to follow error-handling transitions. Default: false

stability :stability: experimental

Return type

List[State]

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

classmethod prefix_states(root, prefix)

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

Parameters

stability :stability: experimental

Return type

None