amazonka-stepfunctions-1.6.0: Amazon Step Functions SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.StepFunctions.DescribeExecution

Contents

Description

Describes an execution.

Synopsis

Creating a Request

describeExecution #

Creates a value of DescribeExecution with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • deExecutionARN - The Amazon Resource Name (ARN) of the execution to describe.

data DescribeExecution #

See: describeExecution smart constructor.

Instances
Eq DescribeExecution # 
Instance details

Defined in Network.AWS.StepFunctions.DescribeExecution

Data DescribeExecution # 
Instance details

Defined in Network.AWS.StepFunctions.DescribeExecution

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeExecution -> c DescribeExecution #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeExecution #

toConstr :: DescribeExecution -> Constr #

dataTypeOf :: DescribeExecution -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeExecution) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeExecution) #

gmapT :: (forall b. Data b => b -> b) -> DescribeExecution -> DescribeExecution #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeExecution -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeExecution -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeExecution -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeExecution -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeExecution -> m DescribeExecution #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeExecution -> m DescribeExecution #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeExecution -> m DescribeExecution #

Read DescribeExecution # 
Instance details

Defined in Network.AWS.StepFunctions.DescribeExecution

Show DescribeExecution # 
Instance details

Defined in Network.AWS.StepFunctions.DescribeExecution

Generic DescribeExecution # 
Instance details

Defined in Network.AWS.StepFunctions.DescribeExecution

Associated Types

type Rep DescribeExecution :: * -> * #

Hashable DescribeExecution # 
Instance details

Defined in Network.AWS.StepFunctions.DescribeExecution

ToJSON DescribeExecution # 
Instance details

Defined in Network.AWS.StepFunctions.DescribeExecution

AWSRequest DescribeExecution # 
Instance details

Defined in Network.AWS.StepFunctions.DescribeExecution

Associated Types

type Rs DescribeExecution :: * #

ToHeaders DescribeExecution # 
Instance details

Defined in Network.AWS.StepFunctions.DescribeExecution

ToPath DescribeExecution # 
Instance details

Defined in Network.AWS.StepFunctions.DescribeExecution

ToQuery DescribeExecution # 
Instance details

Defined in Network.AWS.StepFunctions.DescribeExecution

NFData DescribeExecution # 
Instance details

Defined in Network.AWS.StepFunctions.DescribeExecution

Methods

rnf :: DescribeExecution -> () #

type Rep DescribeExecution # 
Instance details

Defined in Network.AWS.StepFunctions.DescribeExecution

type Rep DescribeExecution = D1 (MetaData "DescribeExecution" "Network.AWS.StepFunctions.DescribeExecution" "amazonka-stepfunctions-1.6.0-KxCz3NVPydyBSIOsnqAvPV" True) (C1 (MetaCons "DescribeExecution'" PrefixI True) (S1 (MetaSel (Just "_deExecutionARN") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type Rs DescribeExecution # 
Instance details

Defined in Network.AWS.StepFunctions.DescribeExecution

Request Lenses

deExecutionARN :: Lens' DescribeExecution Text #

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

Destructuring the Response

describeExecutionResponse #

Creates a value of DescribeExecutionResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • dersStopDate - If the execution has already ended, the date the execution stopped.
  • dersName - The name of the execution. A name must not contain: * whitespace * brackets { } [ ] * wildcard characters ? * * special characters " # % ^ | ~ ` $ & , ; : / * control characters (U+0000-001F , U+007F-009F )
  • dersOutput - The JSON output data of the execution.
  • dersResponseStatus - -- | The response status code.
  • dersExecutionARN - The Amazon Resource Name (ARN) that identifies the execution.
  • dersStateMachineARN - The Amazon Resource Name (ARN) of the executed stated machine.
  • dersStatus - The current status of the execution.
  • dersStartDate - The date the execution is started.
  • dersInput - The string that contains the JSON input data of the execution.

data DescribeExecutionResponse #

See: describeExecutionResponse smart constructor.

Instances
Eq DescribeExecutionResponse # 
Instance details

Defined in Network.AWS.StepFunctions.DescribeExecution

Data DescribeExecutionResponse # 
Instance details

Defined in Network.AWS.StepFunctions.DescribeExecution

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeExecutionResponse -> c DescribeExecutionResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeExecutionResponse #

toConstr :: DescribeExecutionResponse -> Constr #

dataTypeOf :: DescribeExecutionResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeExecutionResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeExecutionResponse) #

gmapT :: (forall b. Data b => b -> b) -> DescribeExecutionResponse -> DescribeExecutionResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeExecutionResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeExecutionResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeExecutionResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeExecutionResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeExecutionResponse -> m DescribeExecutionResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeExecutionResponse -> m DescribeExecutionResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeExecutionResponse -> m DescribeExecutionResponse #

Read DescribeExecutionResponse # 
Instance details

Defined in Network.AWS.StepFunctions.DescribeExecution

Show DescribeExecutionResponse # 
Instance details

Defined in Network.AWS.StepFunctions.DescribeExecution

Generic DescribeExecutionResponse # 
Instance details

Defined in Network.AWS.StepFunctions.DescribeExecution

Associated Types

type Rep DescribeExecutionResponse :: * -> * #

NFData DescribeExecutionResponse # 
Instance details

Defined in Network.AWS.StepFunctions.DescribeExecution

type Rep DescribeExecutionResponse # 
Instance details

Defined in Network.AWS.StepFunctions.DescribeExecution

type Rep DescribeExecutionResponse = D1 (MetaData "DescribeExecutionResponse" "Network.AWS.StepFunctions.DescribeExecution" "amazonka-stepfunctions-1.6.0-KxCz3NVPydyBSIOsnqAvPV" False) (C1 (MetaCons "DescribeExecutionResponse'" PrefixI True) (((S1 (MetaSel (Just "_dersStopDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 (MetaSel (Just "_dersName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_dersOutput") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_dersResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))) :*: ((S1 (MetaSel (Just "_dersExecutionARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_dersStateMachineARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :*: (S1 (MetaSel (Just "_dersStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ExecutionStatus) :*: (S1 (MetaSel (Just "_dersStartDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 POSIX) :*: S1 (MetaSel (Just "_dersInput") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

Response Lenses

dersStopDate :: Lens' DescribeExecutionResponse (Maybe UTCTime) #

If the execution has already ended, the date the execution stopped.

dersName :: Lens' DescribeExecutionResponse (Maybe Text) #

The name of the execution. A name must not contain: * whitespace * brackets { } [ ] * wildcard characters ? * * special characters " # % ^ | ~ ` $ & , ; : / * control characters (U+0000-001F , U+007F-009F )

dersOutput :: Lens' DescribeExecutionResponse (Maybe Text) #

The JSON output data of the execution.

dersResponseStatus :: Lens' DescribeExecutionResponse Int #

  • - | The response status code.

dersExecutionARN :: Lens' DescribeExecutionResponse Text #

The Amazon Resource Name (ARN) that identifies the execution.

dersStateMachineARN :: Lens' DescribeExecutionResponse Text #

The Amazon Resource Name (ARN) of the executed stated machine.

dersStatus :: Lens' DescribeExecutionResponse ExecutionStatus #

The current status of the execution.

dersStartDate :: Lens' DescribeExecutionResponse UTCTime #

The date the execution is started.

dersInput :: Lens' DescribeExecutionResponse Text #

The string that contains the JSON input data of the execution.