step_in_line.stepfunctions.steps.Task

class documentation

class Task(State): (source)

Known subclasses: step_in_line.stepfunctions.steps.LambdaStep

Constructor: Task(state_id, retry, catch, **kwargs)

View In Hierarchy

Task State causes the interpreter to execute the work identified by the state’s resource field.

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. retry (Retry or list(Retry), optional): A retrier or list of retriers that define the state's retry policy...
Method allowed_fields Undocumented

Inherited from 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 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 (via State):

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, retry=None, catch=None, **kwargs): (source)
overrides step_in_line.stepfunctions.steps.State.__init__
overridden in step_in_line.stepfunctions.steps.LambdaStep

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. retry (Retry or list(Retry), optional): A retrier or list of retriers that define the state's retry policy. See Error handling in Step Functions for more details. catch (Catch or list(Catch), optional): A catcher or list of catchers that define a fallback state. See Error handling in Step Functions for more details. resource (str): A URI that uniquely identifies the specific task to execute. The States language does not constrain the URI scheme nor any other part of the URI. timeout_seconds (int, optional): Positive integer specifying timeout for the state in seconds. If the state runs longer than the specified timeout, then the interpreter fails the state with a 'States.Timeout' Error Name. (default: 60) timeout_seconds_path (str, optional): Path specifying the state's timeout value in seconds from the state input. When resolved, the path must select a field whose value is a positive integer. heartbeat_seconds (int, optional): Positive integer specifying heartbeat timeout for the state in seconds. This value should be lower than the one specified for 'timeout_seconds'. If more time than the specified heartbeat elapses between heartbeats from the task, then the interpreter fails the state with a States.Timeout Error Name. heartbeat_seconds_path (str, optional): Path specifying the state's heartbeat value in seconds from the state input. When resolved, the path must select a field whose value is a positive integer. 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 allowed_fields(self): (source)
overrides step_in_line.stepfunctions.steps.State.allowed_fields

Undocumented