Chain

class aws_cdk.aws_stepfunctions.Chain

Bases: object

A collection of states to chain onto.

A Chain has a start and zero or more chainable ends. If there are zero ends, calling next() on the Chain will fail.

stability :stability: experimental

Methods

next(next)

Continue normal execution with the given state.

Parameters

next (IChainable) –

stability :stability: experimental

Return type

Chain

to_single_state(id, *, comment=None, input_path=None, output_path=None, result_path=None)

Return a single state that encompasses all states in the chain.

This can be used to add error handling to a sequence of states.

Be aware that this changes the result of the inner state machine to be an array with the result of the state machine in it. Adjust your paths accordingly. For example, change ‘outputPath’ to ‘$[0]’.

Parameters
  • id (str) –

  • props

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

  • input_path (Optional[str]) – JSONPath expression to select part of the state to be the input to this state. May also be the special value DISCARD, which will cause the effective input to be the empty object {}. Default: $

  • output_path (Optional[str]) – JSONPath expression to select part of the state to be the output to this state. May also be the special value DISCARD, which will cause the effective output to be the empty object {}. Default: $

  • result_path (Optional[str]) – JSONPath expression to indicate where to inject the state’s output. May also be the special value DISCARD, which will cause the state’s input to become its output. Default: $

stability :stability: experimental

Return type

Parallel

Attributes

end_states

The chainable end state(s) of this chain.

stability :stability: experimental

Return type

List[INextable]

id

Identify this Chain.

stability :stability: experimental

Return type

str

start_state

The start state of this chain.

stability :stability: experimental

Return type

State

Static Methods

classmethod custom(start_state, end_states, last_added)

Make a Chain with specific start and end states, and a last-added Chainable.

Parameters

stability :stability: experimental

Return type

Chain

classmethod sequence(start, next)

Make a Chain with the start from one chain and the ends from another.

Parameters

stability :stability: experimental

Return type

Chain

classmethod start(state)

Begin a new Chain from one chainable.

Parameters

state (IChainable) –

stability :stability: experimental

Return type

Chain