Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Returns information about the specified workflow execution including its type and some statistics.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
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 does not 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 will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
See: AWS API Reference for DescribeWorkflowExecution.
- describeWorkflowExecution :: Text -> WorkflowExecution -> DescribeWorkflowExecution
- data DescribeWorkflowExecution
- dweDomain :: Lens' DescribeWorkflowExecution Text
- dweExecution :: Lens' DescribeWorkflowExecution WorkflowExecution
- describeWorkflowExecutionResponse :: Int -> WorkflowExecutionInfo -> WorkflowExecutionConfiguration -> WorkflowExecutionOpenCounts -> DescribeWorkflowExecutionResponse
- data DescribeWorkflowExecutionResponse
- dwersLatestActivityTaskTimestamp :: Lens' DescribeWorkflowExecutionResponse (Maybe UTCTime)
- dwersLatestExecutionContext :: Lens' DescribeWorkflowExecutionResponse (Maybe Text)
- dwersResponseStatus :: Lens' DescribeWorkflowExecutionResponse Int
- dwersExecutionInfo :: Lens' DescribeWorkflowExecutionResponse WorkflowExecutionInfo
- dwersExecutionConfiguration :: Lens' DescribeWorkflowExecutionResponse WorkflowExecutionConfiguration
- dwersOpenCounts :: Lens' DescribeWorkflowExecutionResponse WorkflowExecutionOpenCounts
Creating a Request
describeWorkflowExecution Source
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:
data DescribeWorkflowExecution Source
See: describeWorkflowExecution
smart constructor.
Request Lenses
dweDomain :: Lens' DescribeWorkflowExecution Text Source
The name of the domain containing the workflow execution.
dweExecution :: Lens' DescribeWorkflowExecution WorkflowExecution Source
The workflow execution to describe.
Destructuring the Response
describeWorkflowExecutionResponse Source
:: Int | |
-> WorkflowExecutionInfo | |
-> WorkflowExecutionConfiguration | |
-> WorkflowExecutionOpenCounts | |
-> 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:
data DescribeWorkflowExecutionResponse Source
Contains details about a workflow execution.
See: describeWorkflowExecutionResponse
smart constructor.
Response Lenses
dwersLatestActivityTaskTimestamp :: Lens' DescribeWorkflowExecutionResponse (Maybe UTCTime) Source
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) Source
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 Source
The response status code.
dwersExecutionInfo :: Lens' DescribeWorkflowExecutionResponse WorkflowExecutionInfo Source
Information about the workflow execution.
dwersExecutionConfiguration :: Lens' DescribeWorkflowExecutionResponse WorkflowExecutionConfiguration Source
The configuration settings for this workflow execution including timeout values, tasklist etc.
dwersOpenCounts :: Lens' DescribeWorkflowExecutionResponse WorkflowExecutionOpenCounts Source
The number of tasks for this workflow execution. This includes open and closed tasks of all types.