Succeed State

The Succeed class acts as a end state of a state machine branch, with the ability to provide filtered output data.

For more details on Succeed, see the AWS documentation.

class awssl.Succeed(Name='', Comment='', InputPath='$', OutputPath='$')

Succeed is a state that terminates a State Machine successfully.

Succeed are typically used as part of a Condition state, and can receive Input and return Output.

Parameters:
  • Name (str) – [Required] The name of the state within the branch of the state machine
  • Comment (str) – [Optional] A comment describing the intent of this pass state
  • InputPath (str) – [Optional] Filter on the Input information to be passed to the Pass state. Default is “$”, signifying that all the Input information will be provided
  • OutputPath (str) – [Optional] Filter on the Output information to be returned from the Pass state. Default is “$”, signifying that all the result information will be provided
clone(NameFormatString='{}')

Returns a clone of this instance, with the clone named per the NameFormatString, to avoid state name clashes.

If this instance is not an end state, then the next state will also be cloned, to establish a complete clone of the branch form this instance onwards.

Parameters:NameFormatString (str) – [Required] The naming template to be applied to generate the name of the new instance.
Returns:Succeed – A new instance of this instance and any other instances in its branch.
to_json()

Returns the JSON representation of this instance.

Returns:dict – The JSON representation
validate()

Validates this instance is correctly specified.

Raises Exception with details of the error, if the state machine is incorrectly defined.