Safe Haskell | None |
---|---|
Language | Haskell2010 |
Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
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. Constrain the following parameters by using a Condition
element
with the appropriate keys. 'tagFilter.tag': String constraint. The key is 'swf:tagFilter.tag'. 'typeFilter.name': String constraint. The key is 'swf:typeFilter.name'. 'typeFilter.version': String constraint. The key is 'swf:typeFilter.version'. 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 AmazonSWF Workflows.
http://docs.aws.amazon.com/amazonswf/latest/apireference/API_ListClosedWorkflowExecutions.html
- data ListClosedWorkflowExecutions
- listClosedWorkflowExecutions :: Text -> ListClosedWorkflowExecutions
- lcweCloseStatusFilter :: Lens' ListClosedWorkflowExecutions (Maybe CloseStatusFilter)
- lcweCloseTimeFilter :: Lens' ListClosedWorkflowExecutions (Maybe ExecutionTimeFilter)
- lcweDomain :: Lens' ListClosedWorkflowExecutions Text
- lcweExecutionFilter :: Lens' ListClosedWorkflowExecutions (Maybe WorkflowExecutionFilter)
- lcweMaximumPageSize :: Lens' ListClosedWorkflowExecutions (Maybe Natural)
- lcweNextPageToken :: Lens' ListClosedWorkflowExecutions (Maybe Text)
- lcweReverseOrder :: Lens' ListClosedWorkflowExecutions (Maybe Bool)
- lcweStartTimeFilter :: Lens' ListClosedWorkflowExecutions (Maybe ExecutionTimeFilter)
- lcweTagFilter :: Lens' ListClosedWorkflowExecutions (Maybe TagFilter)
- lcweTypeFilter :: Lens' ListClosedWorkflowExecutions (Maybe WorkflowTypeFilter)
- data ListClosedWorkflowExecutionsResponse
- listClosedWorkflowExecutionsResponse :: ListClosedWorkflowExecutionsResponse
- lcwerExecutionInfos :: Lens' ListClosedWorkflowExecutionsResponse [WorkflowExecutionInfo]
- lcwerNextPageToken :: Lens' ListClosedWorkflowExecutionsResponse (Maybe Text)
Request
data ListClosedWorkflowExecutions Source
Request constructor
listClosedWorkflowExecutions Source
ListClosedWorkflowExecutions
constructor.
The fields accessible through corresponding lenses are:
lcweCloseStatusFilter
::
Maybe
CloseStatusFilter
lcweCloseTimeFilter
::
Maybe
ExecutionTimeFilter
lcweDomain
::
Text
lcweExecutionFilter
::
Maybe
WorkflowExecutionFilter
lcweMaximumPageSize
::
Maybe
Natural
lcweNextPageToken
::
Maybe
Text
lcweReverseOrder
::
Maybe
Bool
lcweStartTimeFilter
::
Maybe
ExecutionTimeFilter
lcweTagFilter
::
Maybe
TagFilter
lcweTypeFilter
::
Maybe
WorkflowTypeFilter
Request lenses
lcweCloseStatusFilter :: Lens' ListClosedWorkflowExecutions (Maybe CloseStatusFilter) Source
If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.
closeStatusFilter
, executionFilter
, typeFilter
and tagFilter
are mutually
exclusive. You can specify at most one of these in a request.
lcweCloseTimeFilter :: Lens' ListClosedWorkflowExecutions (Maybe ExecutionTimeFilter) Source
If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.
startTimeFilter
and closeTimeFilter
are mutually exclusive. You must specify
one of these in a request but not both.
lcweDomain :: Lens' ListClosedWorkflowExecutions Text Source
The name of the domain that contains the workflow executions to list.
lcweExecutionFilter :: Lens' ListClosedWorkflowExecutions (Maybe WorkflowExecutionFilter) Source
If specified, only workflow executions matching the workflow id specified in the filter are returned.
closeStatusFilter
, executionFilter
, typeFilter
and tagFilter
are mutually
exclusive. You can specify at most one of these in a request.
lcweMaximumPageSize :: Lens' ListClosedWorkflowExecutions (Maybe Natural) Source
The maximum number of results that will be returned per call. nextPageToken
can be used to obtain futher pages of results. The default is 100, which is
the maximum allowed page size. You can, however, specify a page size smaller
than 100.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
lcweNextPageToken :: Lens' ListClosedWorkflowExecutions (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.
lcweReverseOrder :: Lens' ListClosedWorkflowExecutions (Maybe Bool) Source
When set to true
, returns the results in reverse order. By default the
results are returned in descending order of the start or the close time of
the executions.
lcweStartTimeFilter :: Lens' ListClosedWorkflowExecutions (Maybe ExecutionTimeFilter) Source
If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.
startTimeFilter
and closeTimeFilter
are mutually exclusive. You must specify
one of these in a request but not both.
lcweTagFilter :: Lens' ListClosedWorkflowExecutions (Maybe TagFilter) Source
If specified, only executions that have the matching tag are listed.
closeStatusFilter
, executionFilter
, typeFilter
and tagFilter
are mutually
exclusive. You can specify at most one of these in a request.
lcweTypeFilter :: Lens' ListClosedWorkflowExecutions (Maybe WorkflowTypeFilter) Source
If specified, only executions of the type specified in the filter are returned.
closeStatusFilter
, executionFilter
, typeFilter
and tagFilter
are mutually
exclusive. You can specify at most one of these in a request.
Response
Response constructor
listClosedWorkflowExecutionsResponse :: ListClosedWorkflowExecutionsResponse Source
ListClosedWorkflowExecutionsResponse
constructor.
The fields accessible through corresponding lenses are:
Response lenses
lcwerExecutionInfos :: Lens' ListClosedWorkflowExecutionsResponse [WorkflowExecutionInfo] Source
The list of workflow information structures.
lcwerNextPageToken :: Lens' ListClosedWorkflowExecutionsResponse (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.