Copyright | (c) 2013-2017 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 |
Language | Haskell2010 |
Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken
returned by the initial call.
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 .
This operation returns paginated results.
- getWorkflowExecutionHistory :: Text -> WorkflowExecution -> GetWorkflowExecutionHistory
- data GetWorkflowExecutionHistory
- gwehNextPageToken :: Lens' GetWorkflowExecutionHistory (Maybe Text)
- gwehReverseOrder :: Lens' GetWorkflowExecutionHistory (Maybe Bool)
- gwehMaximumPageSize :: Lens' GetWorkflowExecutionHistory (Maybe Natural)
- gwehDomain :: Lens' GetWorkflowExecutionHistory Text
- gwehExecution :: Lens' GetWorkflowExecutionHistory WorkflowExecution
- getWorkflowExecutionHistoryResponse :: Int -> GetWorkflowExecutionHistoryResponse
- data GetWorkflowExecutionHistoryResponse
- gwehrsNextPageToken :: Lens' GetWorkflowExecutionHistoryResponse (Maybe Text)
- gwehrsResponseStatus :: Lens' GetWorkflowExecutionHistoryResponse Int
- gwehrsEvents :: Lens' GetWorkflowExecutionHistoryResponse [HistoryEvent]
Creating a Request
getWorkflowExecutionHistory Source #
Creates a value of GetWorkflowExecutionHistory
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gwehNextPageToken
- If aNextPageToken
was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token innextPageToken
. Keep all other arguments unchanged. The configuredmaximumPageSize
determines how many results can be returned in a single call.gwehReverseOrder
- When set totrue
, returns the events in reverse order. By default the results are returned in ascending order of theeventTimeStamp
of the events.gwehMaximumPageSize
- The maximum number of results that are returned per call.nextPageToken
can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.gwehDomain
- The name of the domain containing the workflow execution.gwehExecution
- Specifies the workflow execution for which to return the history.
data GetWorkflowExecutionHistory Source #
See: getWorkflowExecutionHistory
smart constructor.
Request Lenses
gwehNextPageToken :: Lens' GetWorkflowExecutionHistory (Maybe Text) Source #
If a NextPageToken
was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken
. Keep all other arguments unchanged. The configured maximumPageSize
determines how many results can be returned in a single call.
gwehReverseOrder :: Lens' GetWorkflowExecutionHistory (Maybe Bool) Source #
When set to true
, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp
of the events.
gwehMaximumPageSize :: Lens' GetWorkflowExecutionHistory (Maybe Natural) Source #
The maximum number of results that are returned per call. nextPageToken
can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
gwehDomain :: Lens' GetWorkflowExecutionHistory Text Source #
The name of the domain containing the workflow execution.
gwehExecution :: Lens' GetWorkflowExecutionHistory WorkflowExecution Source #
Specifies the workflow execution for which to return the history.
Destructuring the Response
getWorkflowExecutionHistoryResponse Source #
Creates a value of GetWorkflowExecutionHistoryResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gwehrsNextPageToken
- If aNextPageToken
was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token innextPageToken
. Keep all other arguments unchanged. The configuredmaximumPageSize
determines how many results can be returned in a single call.gwehrsResponseStatus
- -- | The response status code.gwehrsEvents
- The list of history events.
data GetWorkflowExecutionHistoryResponse Source #
Paginated representation of a workflow history for a workflow execution. This is the up to date, complete and authoritative record of the events related to all tasks and events in the life of the workflow execution.
See: getWorkflowExecutionHistoryResponse
smart constructor.
Response Lenses
gwehrsNextPageToken :: Lens' GetWorkflowExecutionHistoryResponse (Maybe Text) Source #
If a NextPageToken
was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken
. Keep all other arguments unchanged. The configured maximumPageSize
determines how many results can be returned in a single call.
gwehrsResponseStatus :: Lens' GetWorkflowExecutionHistoryResponse Int Source #
- - | The response status code.
gwehrsEvents :: Lens' GetWorkflowExecutionHistoryResponse [HistoryEvent] Source #
The list of history events.