Succeed State Class

Succeed State terminates a state machine successfully. The Succeed State is a useful target for :R:class:`Choice`-state branches that don't do anything but terminate the machine.

Super classes

stepfunctions::Block -> stepfunctions::State -> Succeed

Methods

Public methods

• Succeed$new()

• Succeed$allowed_fields()

• Succeed$clone()

Inherited methods

• stepfunctions::Block$is_field_allowed()

• stepfunctions::Block$to_json()

• stepfunctions::State$.next()

• stepfunctions::State$accept()

• stepfunctions::State$add_catch()

• stepfunctions::State$add_retry()

• stepfunctions::State$format()

• stepfunctions::State$output()

• stepfunctions::State$to_list()

• stepfunctions::State$update_parameters()

---

Method new()

Initialize Succeed State class

Usage

Succeed$new(state_id, comment = NULL, input_path = NULL, output_path = NULL)

Arguments

state_id

(str): State name whose length **must be** less than or equal to 128 unicode characters. State names **must be** unique within the scope of the whole state machine.

comment

(str, optional): Human-readable comment or description. (default: None)

input_path

(str, optional): Path applied to the state’s raw input to select some or all of it; that selection is used by the state. (default: '$')

output_path

(str, optional): Path applied to the state’s output, producing the effective output which serves as the raw input for the next state. (default: '$')

...

: Extra field names to pass to Block class

---

Method allowed_fields()

allowed extra fields

Usage

Succeed$allowed_fields()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Succeed$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.