/AWS1/CL_SFN=>UPDATESTATEMACHINE()
¶
About UpdateStateMachine¶
Updates an existing state machine by modifying its definition
,
roleArn
, loggingConfiguration
, or EncryptionConfiguration
. 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 namedmyStateMachine
.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
.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_STATEMACHINEARN
TYPE /AWS1/SFNARN
/AWS1/SFNARN
¶
The Amazon Resource Name (ARN) of the state machine.
Optional arguments:¶
IV_DEFINITION
TYPE /AWS1/SFNDEFINITION
/AWS1/SFNDEFINITION
¶
The Amazon States Language definition of the state machine. See Amazon States Language.
IV_ROLEARN
TYPE /AWS1/SFNARN
/AWS1/SFNARN
¶
The Amazon Resource Name (ARN) of the IAM role of the state machine.
IO_LOGGINGCONFIGURATION
TYPE REF TO /AWS1/CL_SFNLOGGINGCONF
/AWS1/CL_SFNLOGGINGCONF
¶
Use the
LoggingConfiguration
data type to set CloudWatch Logs options.
IO_TRACINGCONFIGURATION
TYPE REF TO /AWS1/CL_SFNTRACINGCONF
/AWS1/CL_SFNTRACINGCONF
¶
Selects whether X-Ray tracing is enabled.
IV_PUBLISH
TYPE /AWS1/SFNPUBLISH
/AWS1/SFNPUBLISH
¶
Specifies whether the state machine version is published. The default is
false
. To publish a version after updating the state machine, setpublish
totrue
.
IV_VERSIONDESCRIPTION
TYPE /AWS1/SFNVERSIONDESCRIPTION
/AWS1/SFNVERSIONDESCRIPTION
¶
An optional description of the state machine version to publish.
You can only specify the
versionDescription
parameter if you've setpublish
totrue
.
IO_ENCRYPTIONCONFIGURATION
TYPE REF TO /AWS1/CL_SFNENCRYPTIONCONF
/AWS1/CL_SFNENCRYPTIONCONF
¶
Settings to configure server-side encryption.