Create State Machine Alias
sfn_create_state_machine_alias | R Documentation |
Creates an alias for a state machine that points to one or two versions of the same state machine¶
Description¶
Creates an
alias
for a state machine that points to one or two
versions
of the same state machine. You can set your application to call
start_execution
with an alias and update the version the alias uses
without changing the client's code.
You can also map an alias to split start_execution
requests between
two versions of a state machine. To do this, add a second
RoutingConfig
object in the routingConfiguration
parameter. You must
also specify the percentage of execution run requests each version
should receive in both RoutingConfig
objects. Step Functions randomly
chooses which version runs a given execution based on the percentage you
specify.
To create an alias that points to a single version, specify a single
RoutingConfig
object with a weight
set to 100.
You can create up to 100 aliases for each state machine. You must delete
unused aliases using the delete_state_machine_alias
API action.
create_state_machine_alias
is an idempotent API. Step Functions bases
the idempotency check on the stateMachineArn
, description
, name
,
and routingConfiguration
parameters. Requests that contain the same
values for these parameters return a successful idempotent response
without creating a duplicate resource.
Related operations:
-
describe_state_machine_alias
-
list_state_machine_aliases
-
update_state_machine_alias
-
delete_state_machine_alias
Usage¶
Arguments¶
description
A description for the state machine alias.
name
[required] The name of the state machine alias.
To avoid conflict with version ARNs, don't use an integer in the name of the alias.
routingConfiguration
[required] The routing configuration of a state machine alias. The routing configuration shifts execution traffic between two state machine versions.
routingConfiguration
contains an array ofRoutingConfig
objects that specify up to two state machine versions. Step Functions then randomly choses which version to run an execution with based on the weight assigned to eachRoutingConfig
.
Value¶
A list with the following syntax: