Module Smaws_Client_SFN.UpdateStateMachineAlias

val request : Smaws_Lib.Context.t -> update_state_machine_alias_input -> (update_state_machine_alias_output, [> Smaws_Lib.Protocols.AwsJson.error | `ConflictException of conflict_exception | `InvalidArn of invalid_arn | `ResourceNotFound of resource_not_found | `StateMachineDeleting of state_machine_deleting | `ValidationException of validation_exception ]) Stdlib.result

Updates the configuration of an existing state machine alias by modifying its description or routingConfiguration.

You must specify at least one of the description or routingConfiguration parameters to update a state machine alias.

UpdateStateMachineAlias is an idempotent API. Step Functions bases the idempotency check on the stateMachineAliasArn, description, and routingConfiguration parameters. Requests with the same parameters return an idempotent response.

This operation is eventually consistent. All StartExecution requests made within a few seconds use the latest alias configuration. Executions started immediately after calling UpdateStateMachineAlias may use the previous routing configuration.

Related operations:

  • CreateStateMachineAlias
  • DescribeStateMachineAlias
  • ListStateMachineAliases
  • DeleteStateMachineAlias