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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Creating a Request

data DeleteStateMachine Source #

See: newDeleteStateMachine smart constructor.

Constructors

DeleteStateMachine'
Fields stateMachineArn :: Text The Amazon Resource Name (ARN) of the state machine to delete.

Instances

Instances details

ToJSON DeleteStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.DeleteStateMachine Methods toJSON :: DeleteStateMachine -> Value # toEncoding :: DeleteStateMachine -> Encoding # toJSONList :: [DeleteStateMachine] -> Value # toEncodingList :: [DeleteStateMachine] -> Encoding #
ToHeaders DeleteStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.DeleteStateMachine Methods toHeaders :: DeleteStateMachine -> [Header] #
ToPath DeleteStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.DeleteStateMachine Methods toPath :: DeleteStateMachine -> ByteString #
ToQuery DeleteStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.DeleteStateMachine Methods toQuery :: DeleteStateMachine -> QueryString #
AWSRequest DeleteStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.DeleteStateMachine Associated Types type AWSResponse DeleteStateMachine # Methods request :: (Service -> Service) -> DeleteStateMachine -> Request DeleteStateMachine # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteStateMachine -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteStateMachine))) #
Generic DeleteStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.DeleteStateMachine Associated Types type Rep DeleteStateMachine :: Type -> Type # Methods from :: DeleteStateMachine -> Rep DeleteStateMachine x # to :: Rep DeleteStateMachine x -> DeleteStateMachine #
Read DeleteStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.DeleteStateMachine Methods readsPrec :: Int -> ReadS DeleteStateMachine # readList :: ReadS [DeleteStateMachine] # readPrec :: ReadPrec DeleteStateMachine # readListPrec :: ReadPrec [DeleteStateMachine] #
Show DeleteStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.DeleteStateMachine Methods showsPrec :: Int -> DeleteStateMachine -> ShowS # show :: DeleteStateMachine -> String # showList :: [DeleteStateMachine] -> ShowS #
NFData DeleteStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.DeleteStateMachine Methods rnf :: DeleteStateMachine -> () #
Eq DeleteStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.DeleteStateMachine Methods (==) :: DeleteStateMachine -> DeleteStateMachine -> Bool # (/=) :: DeleteStateMachine -> DeleteStateMachine -> Bool #
Hashable DeleteStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.DeleteStateMachine Methods hashWithSalt :: Int -> DeleteStateMachine -> Int # hash :: DeleteStateMachine -> Int #
type AWSResponse DeleteStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.DeleteStateMachine type AWSResponse DeleteStateMachine = DeleteStateMachineResponse
type Rep DeleteStateMachine Source #
Instance details Defined in Amazonka.StepFunctions.DeleteStateMachine type Rep DeleteStateMachine = D1 ('MetaData "DeleteStateMachine" "Amazonka.StepFunctions.DeleteStateMachine" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "DeleteStateMachine'" 'PrefixI 'True) (S1 ('MetaSel ('Just "stateMachineArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteStateMachine Source #

Arguments

:: Text	`DeleteStateMachine`
-> 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 httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DeleteStateMachineResponse Source #
Instance details Defined in Amazonka.StepFunctions.DeleteStateMachine Associated Types type Rep DeleteStateMachineResponse :: Type -> Type # Methods from :: DeleteStateMachineResponse -> Rep DeleteStateMachineResponse x # to :: Rep DeleteStateMachineResponse x -> DeleteStateMachineResponse #
Read DeleteStateMachineResponse Source #
Instance details Defined in Amazonka.StepFunctions.DeleteStateMachine Methods readsPrec :: Int -> ReadS DeleteStateMachineResponse # readList :: ReadS [DeleteStateMachineResponse] # readPrec :: ReadPrec DeleteStateMachineResponse # readListPrec :: ReadPrec [DeleteStateMachineResponse] #
Show DeleteStateMachineResponse Source #
Instance details Defined in Amazonka.StepFunctions.DeleteStateMachine Methods showsPrec :: Int -> DeleteStateMachineResponse -> ShowS # show :: DeleteStateMachineResponse -> String # showList :: [DeleteStateMachineResponse] -> ShowS #
NFData DeleteStateMachineResponse Source #
Instance details Defined in Amazonka.StepFunctions.DeleteStateMachine Methods rnf :: DeleteStateMachineResponse -> () #
Eq DeleteStateMachineResponse Source #
Instance details Defined in Amazonka.StepFunctions.DeleteStateMachine Methods (==) :: DeleteStateMachineResponse -> DeleteStateMachineResponse -> Bool # (/=) :: DeleteStateMachineResponse -> DeleteStateMachineResponse -> Bool #
type Rep DeleteStateMachineResponse Source #
Instance details Defined in Amazonka.StepFunctions.DeleteStateMachine type Rep DeleteStateMachineResponse = D1 ('MetaData "DeleteStateMachineResponse" "Amazonka.StepFunctions.DeleteStateMachine" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "DeleteStateMachineResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteStateMachineResponse Source #

Arguments

:: Int	`$sel:httpStatus:DeleteStateMachineResponse'`
-> DeleteStateMachineResponse

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.