DeleteStateMachine
Deletes a state machine. This is an asynchronous operation: It sets the state machine's
status to DELETING and begins the deletion process.
If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.
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.
Note
For EXPRESS state machines, the deletion will happen eventually (usually
less than a minute). Running executions may emit logs after DeleteStateMachine
API is called.
Request Syntax
{
"stateMachineArn": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- stateMachineArn
-
The Amazon Resource Name (ARN) of the state machine to delete.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidArn
-
The provided Amazon Resource Name (ARN) is not valid.
HTTP Status Code: 400
- ValidationException
-
The input does not satisfy the constraints specified by an Amazon service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: