Copyright | (c) 2013-2016 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 the number of closed workflow executions within the given domain that meet the specified filtering criteria.
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 Amazon SWF Workflows.
- countClosedWorkflowExecutions :: Text -> CountClosedWorkflowExecutions
- data CountClosedWorkflowExecutions
- ccweExecutionFilter :: Lens' CountClosedWorkflowExecutions (Maybe WorkflowExecutionFilter)
- ccweCloseStatusFilter :: Lens' CountClosedWorkflowExecutions (Maybe CloseStatusFilter)
- ccweTypeFilter :: Lens' CountClosedWorkflowExecutions (Maybe WorkflowTypeFilter)
- ccweCloseTimeFilter :: Lens' CountClosedWorkflowExecutions (Maybe ExecutionTimeFilter)
- ccweTagFilter :: Lens' CountClosedWorkflowExecutions (Maybe TagFilter)
- ccweStartTimeFilter :: Lens' CountClosedWorkflowExecutions (Maybe ExecutionTimeFilter)
- ccweDomain :: Lens' CountClosedWorkflowExecutions Text
- workflowExecutionCount :: Natural -> WorkflowExecutionCount
- data WorkflowExecutionCount
- wecTruncated :: Lens' WorkflowExecutionCount (Maybe Bool)
- wecCount :: Lens' WorkflowExecutionCount Natural
Creating a Request
countClosedWorkflowExecutions Source #
Creates a value of CountClosedWorkflowExecutions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CountClosedWorkflowExecutions Source #
See: countClosedWorkflowExecutions
smart constructor.
Request Lenses
ccweExecutionFilter :: Lens' CountClosedWorkflowExecutions (Maybe WorkflowExecutionFilter) Source #
If specified, only workflow executions matching the WorkflowId
in the
filter are counted.
closeStatusFilter
, executionFilter
, typeFilter
and tagFilter
are
mutually exclusive. You can specify at most one of these in a request.
ccweCloseStatusFilter :: Lens' CountClosedWorkflowExecutions (Maybe CloseStatusFilter) Source #
If specified, only workflow executions that match this close status are
counted. This filter has an affect only if executionStatus
is
specified as CLOSED
.
closeStatusFilter
, executionFilter
, typeFilter
and tagFilter
are
mutually exclusive. You can specify at most one of these in a request.
ccweTypeFilter :: Lens' CountClosedWorkflowExecutions (Maybe WorkflowTypeFilter) Source #
If specified, indicates the type of the workflow executions to be counted.
closeStatusFilter
, executionFilter
, typeFilter
and tagFilter
are
mutually exclusive. You can specify at most one of these in a request.
ccweCloseTimeFilter :: Lens' CountClosedWorkflowExecutions (Maybe ExecutionTimeFilter) Source #
If specified, only workflow executions that meet the close time criteria of the filter are counted.
startTimeFilter
and closeTimeFilter
are mutually exclusive. You must
specify one of these in a request but not both.
ccweTagFilter :: Lens' CountClosedWorkflowExecutions (Maybe TagFilter) Source #
If specified, only executions that have a tag that matches the filter are counted.
closeStatusFilter
, executionFilter
, typeFilter
and tagFilter
are
mutually exclusive. You can specify at most one of these in a request.
ccweStartTimeFilter :: Lens' CountClosedWorkflowExecutions (Maybe ExecutionTimeFilter) Source #
If specified, only workflow executions that meet the start time criteria of the filter are counted.
startTimeFilter
and closeTimeFilter
are mutually exclusive. You must
specify one of these in a request but not both.
ccweDomain :: Lens' CountClosedWorkflowExecutions Text Source #
The name of the domain containing the workflow executions to count.
Destructuring the Response
workflowExecutionCount Source #
Creates a value of WorkflowExecutionCount
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data WorkflowExecutionCount Source #
Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions
See: workflowExecutionCount
smart constructor.
Response Lenses
wecTruncated :: Lens' WorkflowExecutionCount (Maybe Bool) Source #
If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.