State base class

A class for creating a State block.

Super class

stepfunctions::Block -> State

Methods

Public methods

Inherited methods

Method new()

Initialize State base class

Usage

State$new(
  state_id,
  state_type,
  output_schema = NULL,
  comment = NULL,
  input_path = NULL,
  parameters = NULL,
  result_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.

state_type

(str): Type of the state. (Allowed values: `'Pass'`, `'Succeed'`, `'Fail'`, `'Wait'`, `'Task'`, `'Choice'`, `'Parallel'`, `'Map'`).

output_schema

(list): Expected output schema for the State. This is used to validate placeholder inputs used by the next state in the state machine. (default: None)

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: '$')

parameters

(list, optional): The value of this field becomes the effective input for the state.

result_path

(str, optional): Path specifying the raw input’s combination with or replacement by the state’s result. (default: '$')

output_path

(str, optional): Path applied to the state’s output after the application of `result_path`, 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

State$allowed_fields()

Method update_parameters()

Update `parameters` field in the state, if supported.

Usage

State$update_parameters(params)

Arguments

params

(list): The value of this field becomes the effective input for the state.

Method .next()

Specify the next state or chain to transition to.

Usage

State$.next(next_step)

Arguments

next_step

(State or Chain): Next state or chain to transition to.

Returns

State or Chain: Next state or chain that will be transitioned to.

Method output()

Get the placeholder collection for the State's output.

Usage

State$output()

Returns

StepInput: Placeholder collection representing the State's output, and consequently the input to the next state in the workflow (if one exists).

Method accept()

placeholder

Usage

State$accept(visitor)

Arguments

visitor

placeholder

Method add_retry()

Add a Retry block to the tail end of the list of retriers for the state.

Usage

State$add_retry(retry)

Arguments

retry

(Retry): Retry block to add.

Method add_catch()

Add a Catch block to the tail end of the list of catchers for the state.

Usage

State$add_catch(catch)

Arguments

catch

(Catch): Catch block to add.

Method to_list()

Convert class to list ready to be translated for Amazon States Language https://states-language.net/spec.html.

Usage

State$to_list()

Method format()

class formatting

Usage

State$format()

Method clone()

The objects of this class are cloneable with this method.

Usage

State$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.