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.
- Parameters
scope (
Construct
) –id (
str
) –cause (
Optional
[str
]) – A description for the cause of the failure. Default: No descriptioncomment (
Optional
[str
]) – An optional description for this state. Default: No commenterror (
Optional
[str
]) – Error code used to represent this failure. Default: No error code
Methods
-
add_prefix
(x)¶ Add a prefix to the stateId of this state.
- Parameters
x (
str
) –- 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
) –- Return type
None
-
to_state_json
()¶ Return the Amazon States Language object for this state.
- Return type
Mapping
[Any
,Any
]
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
Attributes
-
id
¶ Descriptive identifier for this chainable.
- Return type
str
-
node
¶ The construct tree node associated with this construct.
- Return type
-
state_id
¶ Tokenized string that evaluates to the state’s ID.
- Return type
str
Static Methods
-
classmethod
filter_nextables
(states)¶ Return only the states that allow chaining from an array of states.
-
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.
-
classmethod
find_reachable_states
(start, *, include_error_handlers=None)¶ 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.
-
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
root (
IConstruct
) –prefix (
str
) –
- Return type
None