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 the number of open 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.
See: AWS API Reference for CountOpenWorkflowExecutions.
- countOpenWorkflowExecutions :: Text -> ExecutionTimeFilter -> CountOpenWorkflowExecutions
- data CountOpenWorkflowExecutions
- coweExecutionFilter :: Lens' CountOpenWorkflowExecutions (Maybe WorkflowExecutionFilter)
- coweTypeFilter :: Lens' CountOpenWorkflowExecutions (Maybe WorkflowTypeFilter)
- coweTagFilter :: Lens' CountOpenWorkflowExecutions (Maybe TagFilter)
- coweDomain :: Lens' CountOpenWorkflowExecutions Text
- coweStartTimeFilter :: Lens' CountOpenWorkflowExecutions ExecutionTimeFilter
- workflowExecutionCount :: Natural -> WorkflowExecutionCount
- data WorkflowExecutionCount
- wecTruncated :: Lens' WorkflowExecutionCount (Maybe Bool)
- wecCount :: Lens' WorkflowExecutionCount Natural
Creating a Request
countOpenWorkflowExecutions Source
Creates a value of CountOpenWorkflowExecutions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CountOpenWorkflowExecutions Source
See: countOpenWorkflowExecutions
smart constructor.
Request Lenses
coweExecutionFilter :: Lens' CountOpenWorkflowExecutions (Maybe WorkflowExecutionFilter) Source
If specified, only workflow executions matching the WorkflowId
in the
filter are counted.
executionFilter
, typeFilter
and tagFilter
are mutually exclusive.
You can specify at most one of these in a request.
coweTypeFilter :: Lens' CountOpenWorkflowExecutions (Maybe WorkflowTypeFilter) Source
Specifies the type of the workflow executions to be counted.
executionFilter
, typeFilter
and tagFilter
are mutually exclusive.
You can specify at most one of these in a request.
coweTagFilter :: Lens' CountOpenWorkflowExecutions (Maybe TagFilter) Source
If specified, only executions that have a tag that matches the filter are counted.
executionFilter
, typeFilter
and tagFilter
are mutually exclusive.
You can specify at most one of these in a request.
coweDomain :: Lens' CountOpenWorkflowExecutions Text Source
The name of the domain containing the workflow executions to count.
coweStartTimeFilter :: Lens' CountOpenWorkflowExecutions ExecutionTimeFilter Source
Specifies the start time criteria that workflow executions must meet in order to be counted.
Destructuring the Response
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.
wecCount :: Lens' WorkflowExecutionCount Natural Source
The number of workflow executions.