AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the UpdateStateMachine operation.
Updates an existing state machine by modifying its definition
, roleArn
,
or loggingConfiguration
. 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 named myStateMachine
.
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:
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:
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
.
Namespace: Amazon.StepFunctions.Model
Assembly: AWSSDK.StepFunctions.dll
Version: 3.x.y.z
public class UpdateStateMachineRequest : AmazonStepFunctionsRequest IAmazonWebServiceRequest
The UpdateStateMachineRequest type exposes the following members
Name | Description | |
---|---|---|
UpdateStateMachineRequest() |
Name | Type | Description | |
---|---|---|---|
Definition | System.String |
Gets and sets the property Definition. The Amazon States Language definition of the state machine. See Amazon States Language. |
|
LoggingConfiguration | Amazon.StepFunctions.Model.LoggingConfiguration |
Gets and sets the property LoggingConfiguration.
Use the |
|
Publish | System.Boolean |
Gets and sets the property Publish.
Specifies whether the state machine version is published. The default is |
|
RoleArn | System.String |
Gets and sets the property RoleArn. The Amazon Resource Name (ARN) of the IAM role of the state machine. |
|
StateMachineArn | System.String |
Gets and sets the property StateMachineArn. The Amazon Resource Name (ARN) of the state machine. |
|
TracingConfiguration | Amazon.StepFunctions.Model.TracingConfiguration |
Gets and sets the property TracingConfiguration. Selects whether X-Ray tracing is enabled. |
|
VersionDescription | System.String |
Gets and sets the property VersionDescription. An optional description of the state machine version to publish.
You can only specify the |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5