delete_state_machine

delete_state_machine(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_state_machine(
    stateMachineArn='string'
)

Parameters

stateMachineArn (string) --

[REQUIRED]

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

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) --

Exceptions

• SFN.Client.exceptions.InvalidArn
• SFN.Client.exceptions.ValidationException