Module Smaws_Client_SFN.UpdateStateMachine

val request : Smaws_Lib.Context.t -> update_state_machine_input -> (update_state_machine_output, [> Smaws_Lib.Protocols.AwsJson.error | `ConflictException of conflict_exception | `InvalidArn of invalid_arn | `InvalidDefinition of invalid_definition | `InvalidLoggingConfiguration of invalid_logging_configuration | `InvalidTracingConfiguration of invalid_tracing_configuration | `MissingRequiredParameter of missing_required_parameter | `ServiceQuotaExceededException of service_quota_exceeded_exception | `StateMachineDeleting of state_machine_deleting | `StateMachineDoesNotExist of state_machine_does_not_exist | `ValidationException of validation_exception ]) Stdlib.result

Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error.

A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.

A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

The following are some examples of qualified and unqualified state machine ARNs:

  • The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine.

    arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel

    If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException.

  • The following qualified state machine ARN refers to an alias named PROD.

    arn::states:::stateMachine:

    If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.

  • The following unqualified state machine ARN refers to a state machine named myStateMachine.

    arn::states:::stateMachine:

After you update your state machine, you can set the publish parameter to true in the same action to publish a new version. This way, you can opt-in to strict versioning of your state machine.

Step Functions assigns monotonically increasing integers for state machine versions, starting at version number 1.

All StartExecution calls within a few seconds use the updated definition and roleArn. Executions started immediately after you call UpdateStateMachine may use the previous state machine definition and roleArn.