Amazonka.StepFunctions.StopExecution

Stops an execution.

This API action is not supported by EXPRESS state machines.

Creating a Request

data StopExecution

See: newStopExecution smart constructor.

Constructors

StopExecution'

Fields

• cause :: Maybe (Sensitive Text)

  A more detailed explanation of the cause of the failure.

• error :: Maybe (Sensitive Text)

  The error code of the failure.

• executionArn :: Text

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

Instances

ToJSON StopExecution

Defined in Amazonka.StepFunctions.StopExecution

Methods

toJSON :: StopExecution -> Value

toEncoding :: StopExecution -> Encoding

toJSONList :: [StopExecution] -> Value

toEncodingList :: [StopExecution] -> Encoding

ToHeaders StopExecution

Defined in Amazonka.StepFunctions.StopExecution

Methods

toHeaders :: StopExecution -> [Header]

ToPath StopExecution

Defined in Amazonka.StepFunctions.StopExecution

Methods

toPath :: StopExecution -> ByteString

ToQuery StopExecution

Defined in Amazonka.StepFunctions.StopExecution

Methods

toQuery :: StopExecution -> QueryString

AWSRequest StopExecution

Defined in Amazonka.StepFunctions.StopExecution

Associated Types

type AWSResponse StopExecution

Methods

request :: (Service -> Service) -> StopExecution -> Request StopExecution

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StopExecution -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StopExecution)))

Generic StopExecution

Defined in Amazonka.StepFunctions.StopExecution

Associated Types

type Rep StopExecution :: Type -> Type

Methods

from :: StopExecution -> Rep StopExecution x

to :: Rep StopExecution x -> StopExecution

Show StopExecution

Defined in Amazonka.StepFunctions.StopExecution

Methods

showsPrec :: Int -> StopExecution -> ShowS

show :: StopExecution -> String

showList :: [StopExecution] -> ShowS

NFData StopExecution

Defined in Amazonka.StepFunctions.StopExecution

Methods

rnf :: StopExecution -> ()

Eq StopExecution

Defined in Amazonka.StepFunctions.StopExecution

Methods

(==) :: StopExecution -> StopExecution -> Bool

(/=) :: StopExecution -> StopExecution -> Bool

Hashable StopExecution

Defined in Amazonka.StepFunctions.StopExecution

Methods

hashWithSalt :: Int -> StopExecution -> Int

hash :: StopExecution -> Int

type AWSResponse StopExecution

Defined in Amazonka.StepFunctions.StopExecution

type AWSResponse StopExecution = StopExecutionResponse

type Rep StopExecution

Defined in Amazonka.StepFunctions.StopExecution

type Rep StopExecution = D1 ('MetaData "StopExecution" "Amazonka.StepFunctions.StopExecution" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "StopExecution'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cause") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: (S1 ('MetaSel ('Just "error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "executionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newStopExecution

Arguments

:: Text

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:

StopExecution, stopExecution_cause - A more detailed explanation of the cause of the failure.

StopExecution, stopExecution_error - The error code of the failure.

StopExecution, stopExecution_executionArn - The Amazon Resource Name (ARN) of the execution to stop.

Request Lenses

stopExecution_cause :: Lens' StopExecution (Maybe Text)

A more detailed explanation of the cause of the failure.

stopExecution_error :: Lens' StopExecution (Maybe Text)

The error code of the failure.

stopExecution_executionArn :: Lens' StopExecution Text

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

Destructuring the Response

data StopExecutionResponse

See: newStopExecutionResponse smart constructor.

Constructors

StopExecutionResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• stopDate :: POSIX

  The date the execution is stopped.

Instances

Generic StopExecutionResponse

Defined in Amazonka.StepFunctions.StopExecution

Associated Types

type Rep StopExecutionResponse :: Type -> Type

Methods

from :: StopExecutionResponse -> Rep StopExecutionResponse x

to :: Rep StopExecutionResponse x -> StopExecutionResponse

Read StopExecutionResponse

Defined in Amazonka.StepFunctions.StopExecution

Methods

readsPrec :: Int -> ReadS StopExecutionResponse

readList :: ReadS [StopExecutionResponse]

readPrec :: ReadPrec StopExecutionResponse

readListPrec :: ReadPrec [StopExecutionResponse]

Show StopExecutionResponse

Defined in Amazonka.StepFunctions.StopExecution

Methods

showsPrec :: Int -> StopExecutionResponse -> ShowS

show :: StopExecutionResponse -> String

showList :: [StopExecutionResponse] -> ShowS

NFData StopExecutionResponse

Defined in Amazonka.StepFunctions.StopExecution

Methods

rnf :: StopExecutionResponse -> ()

Eq StopExecutionResponse

Defined in Amazonka.StepFunctions.StopExecution

Methods

(==) :: StopExecutionResponse -> StopExecutionResponse -> Bool

(/=) :: StopExecutionResponse -> StopExecutionResponse -> Bool

type Rep StopExecutionResponse

Defined in Amazonka.StepFunctions.StopExecution

type Rep StopExecutionResponse = D1 ('MetaData "StopExecutionResponse" "Amazonka.StepFunctions.StopExecution" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" '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

Arguments

:: Int

$sel:httpStatus:StopExecutionResponse'

-> UTCTime

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.

StopExecutionResponse, stopExecutionResponse_stopDate - The date the execution is stopped.

Response Lenses

stopExecutionResponse_httpStatus :: Lens' StopExecutionResponse Int

The response's http status code.

stopExecutionResponse_stopDate :: Lens' StopExecutionResponse UTCTime

The date the execution is stopped.