Update State Machine Alias

sfn_update_state_machine_alias

R Documentation

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

Description¶

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.

update_state_machine_alias 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 start_execution requests made within a few seconds use the latest alias configuration. Executions started immediately after calling update_state_machine_alias may use the previous routing configuration.

Related operations:

create_state_machine_alias
describe_state_machine_alias
list_state_machine_aliases
delete_state_machine_alias

Usage¶

sfn_update_state_machine_alias(stateMachineAliasArn, description,
  routingConfiguration)

Arguments¶

stateMachineAliasArn

[required] The Amazon Resource Name (ARN) of the state machine alias.

description

A description of the state machine alias.

routingConfiguration

The routing configuration of the state machine alias.

An array of RoutingConfig objects that specifies up to two state machine versions that the alias starts executions for.

Value¶

A list with the following syntax:

list(
  updateDate = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax¶

svc$update_state_machine_alias(
  stateMachineAliasArn = "string",
  description = "string",
  routingConfiguration = list(
    list(
      stateMachineVersionArn = "string",
      weight = 123
    )
  )
)