DeleteStateMachineCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SFNClient, DeleteStateMachineCommand } from "@aws-sdk/client-sfn"; // ES Modules import
// const { SFNClient, DeleteStateMachineCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
const client = new SFNClient(config);
const input = { // DeleteStateMachineInput
  stateMachineArn: "STRING_VALUE", // required
};
const command = new DeleteStateMachineCommand(input);
const response = await client.send(command);
// {};

DeleteStateMachineCommand Input

See DeleteStateMachineCommandInput for more details

Parameter
Type
Description
stateMachineArn
Required
string | undefined

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

DeleteStateMachineCommand Output

See DeleteStateMachineCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
InvalidArn
client

The provided Amazon Resource Name (ARN) is not valid.

ValidationException
client

The input does not satisfy the constraints specified by an Amazon Web Services service.

SFNServiceException
Base exception class for all service exceptions from SFN service.