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.
Deletes a state machine. This is an asynchronous operation. It sets the state machine's
status to DELETING
and begins the deletion process. A state machine is deleted
only when all its executions are completed. On the next state transition, the state
machine's executions are terminated.
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 unqualified state machine ARN refers to a state machine named myStateMachine
.
arn:partition:states:region:account-id:stateMachine:myStateMachine
This API action also deletes all versions and aliases associated with a state machine.
For EXPRESS
state machines, the deletion happens eventually (usually in less
than a minute). Running executions may emit logs after DeleteStateMachine
API
is called.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDeleteStateMachine and EndDeleteStateMachine.
Namespace: Amazon.StepFunctions
Assembly: AWSSDK.StepFunctions.dll
Version: 3.x.y.z
public abstract Task<DeleteStateMachineResponse> DeleteStateMachineAsync( DeleteStateMachineRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the DeleteStateMachine service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Exception | Condition |
---|---|
InvalidArnException | The provided Amazon Resource Name (ARN) is not valid. |
ValidationException | The input does not satisfy the constraints specified by an Amazon Web Services service. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5