Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.StepFunctions.StopExecution

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Stops an execution.

This API action is not supported by EXPRESS state machines.

Synopsis

Creating a Request

data StopExecution Source #

See: newStopExecution smart constructor.

Constructors

StopExecution'
Fields error :: Maybe (Sensitive Text) The error code of the failure. cause :: Maybe (Sensitive Text) A more detailed explanation of the cause of the failure. executionArn :: Text The Amazon Resource Name (ARN) of the execution to stop.

Instances

Instances details

Eq StopExecution Source #
Instance details Defined in Amazonka.StepFunctions.StopExecution Methods (==) :: StopExecution -> StopExecution -> Bool # (/=) :: StopExecution -> StopExecution -> Bool #
Show StopExecution Source #
Instance details Defined in Amazonka.StepFunctions.StopExecution Methods showsPrec :: Int -> StopExecution -> ShowS # show :: StopExecution -> String # showList :: [StopExecution] -> ShowS #
Generic StopExecution Source #
Instance details Defined in Amazonka.StepFunctions.StopExecution Associated Types type Rep StopExecution :: Type -> Type # Methods from :: StopExecution -> Rep StopExecution x # to :: Rep StopExecution x -> StopExecution #
NFData StopExecution Source #
Instance details Defined in Amazonka.StepFunctions.StopExecution Methods rnf :: StopExecution -> () #
Hashable StopExecution Source #
Instance details Defined in Amazonka.StepFunctions.StopExecution Methods hashWithSalt :: Int -> StopExecution -> Int # hash :: StopExecution -> Int #
ToJSON StopExecution Source #
Instance details Defined in Amazonka.StepFunctions.StopExecution Methods toJSON :: StopExecution -> Value # toEncoding :: StopExecution -> Encoding # toJSONList :: [StopExecution] -> Value # toEncodingList :: [StopExecution] -> Encoding #
AWSRequest StopExecution Source #
Instance details Defined in Amazonka.StepFunctions.StopExecution Associated Types type AWSResponse StopExecution # Methods request :: StopExecution -> Request StopExecution # response :: MonadResource m => Logger -> Service -> Proxy StopExecution -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StopExecution))) #
ToHeaders StopExecution Source #
Instance details Defined in Amazonka.StepFunctions.StopExecution Methods toHeaders :: StopExecution -> [Header] #
ToPath StopExecution Source #
Instance details Defined in Amazonka.StepFunctions.StopExecution Methods toPath :: StopExecution -> ByteString #
ToQuery StopExecution Source #
Instance details Defined in Amazonka.StepFunctions.StopExecution Methods toQuery :: StopExecution -> QueryString #
type Rep StopExecution Source #
Instance details Defined in Amazonka.StepFunctions.StopExecution type Rep StopExecution = D1 ('MetaData "StopExecution" "Amazonka.StepFunctions.StopExecution" "libZSservicesZSamazonka-stepfunctionsZSamazonka-stepfunctions" 'False) (C1 ('MetaCons "StopExecution'" 'PrefixI 'True) (S1 ('MetaSel ('Just "error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "cause") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "executionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse StopExecution Source #
Instance details Defined in Amazonka.StepFunctions.StopExecution type AWSResponse StopExecution = StopExecutionResponse

newStopExecution Source #

Arguments

:: Text	`$sel:executionArn:StopExecution'`
-> StopExecution

Create a value of StopExecution 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:error:StopExecution', stopExecution_error - The error code of the failure.

$sel:cause:StopExecution', stopExecution_cause - A more detailed explanation of the cause of the failure.

$sel:executionArn:StopExecution', stopExecution_executionArn - The Amazon Resource Name (ARN) of the execution to stop.

Request Lenses

stopExecution_error :: Lens' StopExecution (Maybe Text) Source #

The error code of the failure.

stopExecution_cause :: Lens' StopExecution (Maybe Text) Source #

A more detailed explanation of the cause of the failure.

stopExecution_executionArn :: Lens' StopExecution Text Source #

The Amazon Resource Name (ARN) of the execution to stop.

Destructuring the Response

data StopExecutionResponse Source #

See: newStopExecutionResponse smart constructor.

Constructors

StopExecutionResponse'
Fields httpStatus :: Int The response's http status code. stopDate :: POSIX The date the execution is stopped.

Instances

Instances details

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

newStopExecutionResponse Source #

Arguments

:: Int	`$sel:httpStatus:StopExecutionResponse'`
-> UTCTime	`$sel:stopDate:StopExecutionResponse'`
-> StopExecutionResponse

Create a value of StopExecutionResponse 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:StopExecutionResponse', stopExecutionResponse_httpStatus - The response's http status code.

$sel:stopDate:StopExecutionResponse', stopExecutionResponse_stopDate - The date the execution is stopped.

Response Lenses

stopExecutionResponse_httpStatus :: Lens' StopExecutionResponse Int Source #

The response's http status code.

stopExecutionResponse_stopDate :: Lens' StopExecutionResponse UTCTime Source #

The date the execution is stopped.