| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.StepFunctions.DeleteStateMachine
Description
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.
For EXPRESS state machines, the deletion will happen eventually
(usually less than a minute). Running executions may emit logs after
DeleteStateMachine API is called.
Synopsis
- data DeleteStateMachine = DeleteStateMachine' {}
- newDeleteStateMachine :: Text -> DeleteStateMachine
- deleteStateMachine_stateMachineArn :: Lens' DeleteStateMachine Text
- data DeleteStateMachineResponse = DeleteStateMachineResponse' {
- httpStatus :: Int
- newDeleteStateMachineResponse :: Int -> DeleteStateMachineResponse
- deleteStateMachineResponse_httpStatus :: Lens' DeleteStateMachineResponse Int
Creating a Request
data DeleteStateMachine Source #
See: newDeleteStateMachine smart constructor.
Constructors
| DeleteStateMachine' | |
Fields
| |
Instances
newDeleteStateMachine Source #
Arguments
| :: Text | |
| -> DeleteStateMachine |
Create a value of DeleteStateMachine with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteStateMachine, deleteStateMachine_stateMachineArn - The Amazon Resource Name (ARN) of the state machine to delete.
Request Lenses
deleteStateMachine_stateMachineArn :: Lens' DeleteStateMachine Text Source #
The Amazon Resource Name (ARN) of the state machine to delete.
Destructuring the Response
data DeleteStateMachineResponse Source #
See: newDeleteStateMachineResponse smart constructor.
Constructors
| DeleteStateMachineResponse' | |
Fields
| |
Instances
newDeleteStateMachineResponse Source #
Create a value of DeleteStateMachineResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteStateMachineResponse', deleteStateMachineResponse_httpStatus - The response's http status code.
Response Lenses
deleteStateMachineResponse_httpStatus :: Lens' DeleteStateMachineResponse Int Source #
The response's http status code.