step_in_line.stepfunctions.steps.State

class documentation

class State(Block): (source)

Known subclasses: step_in_line.stepfunctions.steps.Parallel, step_in_line.stepfunctions.steps.Task

Constructor: State(state_id, state_type, output_schema, **kwargs)

View In Hierarchy

Base class to abstract states in Amazon States Language.

Method __init__ 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...
Method __repr__ Undocumented
Method accept Undocumented
Method add_catch Add a catcher or a list of catchers to the tail end of the list of catchers for the state. See Error handling in Step Functions for more details.
Method add_retry Add a retrier or a list of retriers to the tail end of the list of retriers for the state. See Error handling in Step Functions for more details.
Method allowed_fields Undocumented
Method next Specify the next state or chain to transition to.
Method output Get the placeholder collection for the State's output.
Method to_dict Undocumented
Method update_parameters Update 'parameters' field in the state, if supported.
Instance Variable catches Undocumented
Instance Variable in_chain Undocumented
Instance Variable next_step Undocumented
Instance Variable output_schema Undocumented
Instance Variable retries Undocumented
Instance Variable state_id Undocumented
Instance Variable state_type Undocumented
Instance Variable step_output Undocumented

Inherited from Block:

Method __getattr__ Undocumented
Method __str__ Undocumented
Method is_field_allowed Undocumented
Method to_json Serialize to a JSON formatted string.
Instance Variable fields Undocumented
Method _replace_placeholders Undocumented
def __init__(self, state_id, state_type, output_schema=None, **kwargs): (source)
overrides step_in_line.stepfunctions.steps.Block.__init__
overridden in step_in_line.stepfunctions.steps.Parallel, step_in_line.stepfunctions.steps.Task

Args:
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 (dict): 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 (dict, 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: '$')

def __repr__(self): (source)
overrides step_in_line.stepfunctions.steps.Block.__repr__

Undocumented

def accept(self, visitor): (source)

Undocumented

def add_catch(self, catch): (source)

Add a catcher or a list of catchers to the tail end of the list of catchers for the state. See Error handling in Step Functions for more details.

Args:
catch (Catch or list(Catch): catcher or list of catchers to add.
def add_retry(self, retry): (source)

Add a retrier or a list of retriers to the tail end of the list of retriers for the state. See Error handling in Step Functions for more details.

Args:
retry (Retry or list(Retry)): A retrier or list of retriers to add.
def allowed_fields(self): (source)
overrides step_in_line.stepfunctions.steps.Block.allowed_fields
overridden in step_in_line.stepfunctions.steps.Parallel, step_in_line.stepfunctions.steps.Task

Undocumented

def next(self, next_step): (source)

Specify the next state or chain to transition to.

Args:
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.
def output(self): (source)

Get the placeholder collection for the State's output.

Returns:
StepInput: Placeholder collection representing the State's output, and consequently the input to the next state in the workflow (if one exists).
def to_dict(self): (source)
overrides step_in_line.stepfunctions.steps.Block.to_dict
overridden in step_in_line.stepfunctions.steps.Parallel

Undocumented

def update_parameters(self, params): (source)

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

Args:
params (dict or list): The value of this field becomes the effective input for the state.
catches: list = (source)

Undocumented

in_chain = (source)

Undocumented

next_step = (source)

Undocumented

output_schema = (source)

Undocumented

retries: list = (source)

Undocumented

state_id = (source)

Undocumented

state_type = (source)

Undocumented

step_output = (source)

Undocumented