Network.AWS.SWF.DescribeWorkflowExecution

Returns information about the specified workflow execution including its type and some statistics.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

• Use a Resource element with the domain name to limit the action to only specified domains.
• Use an Action element to allow or deny permission to call this action.
• You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide .

Creating a Request

describeWorkflowExecution

Arguments

:: Text

dweDomain

-> WorkflowExecution

dweExecution

-> DescribeWorkflowExecution

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

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

• dweDomain - The name of the domain containing the workflow execution.
• dweExecution - The workflow execution to describe.

data DescribeWorkflowExecution

See: describeWorkflowExecution smart constructor.

Instances

Eq DescribeWorkflowExecution

Methods

(==) :: DescribeWorkflowExecution -> DescribeWorkflowExecution -> Bool

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

Data DescribeWorkflowExecution

Methods

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

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

toConstr :: DescribeWorkflowExecution -> Constr

dataTypeOf :: DescribeWorkflowExecution -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeWorkflowExecution)

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

gmapT :: (forall b. Data b => b -> b) -> DescribeWorkflowExecution -> DescribeWorkflowExecution

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

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

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

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

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

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

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

Read DescribeWorkflowExecution

Methods

readsPrec :: Int -> ReadS DescribeWorkflowExecution

readList :: ReadS [DescribeWorkflowExecution]

readPrec :: ReadPrec DescribeWorkflowExecution

readListPrec :: ReadPrec [DescribeWorkflowExecution]

Show DescribeWorkflowExecution

Methods

showsPrec :: Int -> DescribeWorkflowExecution -> ShowS

show :: DescribeWorkflowExecution -> String

showList :: [DescribeWorkflowExecution] -> ShowS

Generic DescribeWorkflowExecution

Associated Types

type Rep DescribeWorkflowExecution :: * -> *

Methods

from :: DescribeWorkflowExecution -> Rep DescribeWorkflowExecution x

to :: Rep DescribeWorkflowExecution x -> DescribeWorkflowExecution

Hashable DescribeWorkflowExecution

Methods

hashWithSalt :: Int -> DescribeWorkflowExecution -> Int

hash :: DescribeWorkflowExecution -> Int

ToJSON DescribeWorkflowExecution

Methods

toJSON :: DescribeWorkflowExecution -> Value

toEncoding :: DescribeWorkflowExecution -> Encoding

toJSONList :: [DescribeWorkflowExecution] -> Value

toEncodingList :: [DescribeWorkflowExecution] -> Encoding

NFData DescribeWorkflowExecution

Methods

rnf :: DescribeWorkflowExecution -> ()

AWSRequest DescribeWorkflowExecution

Associated Types

type Rs DescribeWorkflowExecution :: *

Methods

request :: DescribeWorkflowExecution -> Request DescribeWorkflowExecution

response :: MonadResource m => Logger -> Service -> Proxy * DescribeWorkflowExecution -> ClientResponse -> m (Response DescribeWorkflowExecution)

ToQuery DescribeWorkflowExecution

Methods

toQuery :: DescribeWorkflowExecution -> QueryString

ToPath DescribeWorkflowExecution

Methods

toPath :: DescribeWorkflowExecution -> ByteString

ToHeaders DescribeWorkflowExecution

Methods

toHeaders :: DescribeWorkflowExecution -> [Header]

type Rep DescribeWorkflowExecution

type Rep DescribeWorkflowExecution = D1 (MetaData "DescribeWorkflowExecution" "Network.AWS.SWF.DescribeWorkflowExecution" "amazonka-swf-1.5.0-Iq58jBNwXOICscXZ8Q27Im" False) (C1 (MetaCons "DescribeWorkflowExecution'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dweDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_dweExecution") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 WorkflowExecution))))

type Rs DescribeWorkflowExecution

type Rs DescribeWorkflowExecution = DescribeWorkflowExecutionResponse

Request Lenses

dweDomain :: Lens' DescribeWorkflowExecution Text

The name of the domain containing the workflow execution.

dweExecution :: Lens' DescribeWorkflowExecution WorkflowExecution

The workflow execution to describe.

Destructuring the Response

describeWorkflowExecutionResponse

Arguments

:: Int

dwersResponseStatus

-> WorkflowExecutionInfo

dwersExecutionInfo

-> WorkflowExecutionConfiguration

dwersExecutionConfiguration

-> WorkflowExecutionOpenCounts

dwersOpenCounts

-> DescribeWorkflowExecutionResponse

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

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

• dwersLatestActivityTaskTimestamp - The time when the last activity task was scheduled for this workflow execution. You can use this information to determine if the workflow has not made progress for an unusually long period of time and might require a corrective action.
• dwersLatestExecutionContext - The latest executionContext provided by the decider for this workflow execution. A decider can provide an executionContext (a free-form string) when closing a decision task using RespondDecisionTaskCompleted .
• dwersResponseStatus - -- | The response status code.
• dwersExecutionInfo - Information about the workflow execution.
• dwersExecutionConfiguration - The configuration settings for this workflow execution including timeout values, tasklist etc.
• dwersOpenCounts - The number of tasks for this workflow execution. This includes open and closed tasks of all types.

data DescribeWorkflowExecutionResponse

Contains details about a workflow execution.

See: describeWorkflowExecutionResponse smart constructor.

Instances

Eq DescribeWorkflowExecutionResponse

Methods

(==) :: DescribeWorkflowExecutionResponse -> DescribeWorkflowExecutionResponse -> Bool

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

Data DescribeWorkflowExecutionResponse

Methods

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

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

toConstr :: DescribeWorkflowExecutionResponse -> Constr

dataTypeOf :: DescribeWorkflowExecutionResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeWorkflowExecutionResponse)

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

gmapT :: (forall b. Data b => b -> b) -> DescribeWorkflowExecutionResponse -> DescribeWorkflowExecutionResponse

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

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

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

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

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

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

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

Read DescribeWorkflowExecutionResponse

Methods

readsPrec :: Int -> ReadS DescribeWorkflowExecutionResponse

readList :: ReadS [DescribeWorkflowExecutionResponse]

readPrec :: ReadPrec DescribeWorkflowExecutionResponse

readListPrec :: ReadPrec [DescribeWorkflowExecutionResponse]

Show DescribeWorkflowExecutionResponse

Methods

showsPrec :: Int -> DescribeWorkflowExecutionResponse -> ShowS

show :: DescribeWorkflowExecutionResponse -> String

showList :: [DescribeWorkflowExecutionResponse] -> ShowS

Generic DescribeWorkflowExecutionResponse

Associated Types

type Rep DescribeWorkflowExecutionResponse :: * -> *

Methods

from :: DescribeWorkflowExecutionResponse -> Rep DescribeWorkflowExecutionResponse x

to :: Rep DescribeWorkflowExecutionResponse x -> DescribeWorkflowExecutionResponse

NFData DescribeWorkflowExecutionResponse

Methods

rnf :: DescribeWorkflowExecutionResponse -> ()

type Rep DescribeWorkflowExecutionResponse

type Rep DescribeWorkflowExecutionResponse = D1 (MetaData "DescribeWorkflowExecutionResponse" "Network.AWS.SWF.DescribeWorkflowExecution" "amazonka-swf-1.5.0-Iq58jBNwXOICscXZ8Q27Im" False) (C1 (MetaCons "DescribeWorkflowExecutionResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dwersLatestActivityTaskTimestamp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) ((:*:) (S1 (MetaSel (Just Symbol "_dwersLatestExecutionContext") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dwersResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))) ((:*:) (S1 (MetaSel (Just Symbol "_dwersExecutionInfo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 WorkflowExecutionInfo)) ((:*:) (S1 (MetaSel (Just Symbol "_dwersExecutionConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 WorkflowExecutionConfiguration)) (S1 (MetaSel (Just Symbol "_dwersOpenCounts") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 WorkflowExecutionOpenCounts))))))

Response Lenses

dwersLatestActivityTaskTimestamp :: Lens' DescribeWorkflowExecutionResponse (Maybe UTCTime)

The time when the last activity task was scheduled for this workflow execution. You can use this information to determine if the workflow has not made progress for an unusually long period of time and might require a corrective action.

dwersLatestExecutionContext :: Lens' DescribeWorkflowExecutionResponse (Maybe Text)

The latest executionContext provided by the decider for this workflow execution. A decider can provide an executionContext (a free-form string) when closing a decision task using RespondDecisionTaskCompleted .

dwersResponseStatus :: Lens' DescribeWorkflowExecutionResponse Int

• - | The response status code.

dwersExecutionInfo :: Lens' DescribeWorkflowExecutionResponse WorkflowExecutionInfo

Information about the workflow execution.

dwersExecutionConfiguration :: Lens' DescribeWorkflowExecutionResponse WorkflowExecutionConfiguration

The configuration settings for this workflow execution including timeout values, tasklist etc.

dwersOpenCounts :: Lens' DescribeWorkflowExecutionResponse WorkflowExecutionOpenCounts

The number of tasks for this workflow execution. This includes open and closed tasks of all types.