Skip to content

/AWS1/IF_SFN=>UPDATESTATEMACHINEALIAS()

About UpdateStateMachineAlias

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:

Method Signature

METHODS /AWS1/IF_SFN~UPDATESTATEMACHINEALIAS
  IMPORTING
    !IV_STATEMACHINEALIASARN TYPE /AWS1/SFNARN OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/SFNALIASDESCRIPTION OPTIONAL
    !IT_ROUTINGCONFIGURATION TYPE /AWS1/CL_SFNROUTINGCONFLSTITEM=>TT_ROUTINGCONFIGURATIONLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sfnupstatemachineal01
  RAISING
    /AWS1/CX_SFNCONFLICTEXCEPTION
    /AWS1/CX_SFNINVALIDARN
    /AWS1/CX_SFNRESOURCENOTFOUND
    /AWS1/CX_SFNSTATEMACHINEDELE00
    /AWS1/CX_SFNVALIDATIONEX
    /AWS1/CX_SFNCLIENTEXC
    /AWS1/CX_SFNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_statemachinealiasarn TYPE /AWS1/SFNARN /AWS1/SFNARN

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

Optional arguments:

iv_description TYPE /AWS1/SFNALIASDESCRIPTION /AWS1/SFNALIASDESCRIPTION

A description of the state machine alias.

it_routingconfiguration TYPE /AWS1/CL_SFNROUTINGCONFLSTITEM=>TT_ROUTINGCONFIGURATIONLIST TT_ROUTINGCONFIGURATIONLIST

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.

RETURNING

oo_output TYPE REF TO /aws1/cl_sfnupstatemachineal01 /AWS1/CL_SFNUPSTATEMACHINEAL01

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->updatestatemachinealias(
  it_routingconfiguration = VALUE /aws1/cl_sfnroutingconflstitem=>tt_routingconfigurationlist(
    (
      new /aws1/cl_sfnroutingconflstitem(
        iv_statemachineversionarn = |string|
        iv_weight = 123
      )
    )
  )
  iv_description = |string|
  iv_statemachinealiasarn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_timestamp = lo_result->get_updatedate( ).
ENDIF.