Container for the parameters to the CountOpenWorkflowExecutions operation.
Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.
NOTE: 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 by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
Declaration Syntax| C# |
public class CountOpenWorkflowExecutionsRequest : AmazonWebServiceRequest
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description | ||
|---|---|---|---|---|
 | CountOpenWorkflowExecutionsRequest()()()() | Initializes a new instance of the CountOpenWorkflowExecutionsRequest class | ||
 | Domain |
The name of the domain containing the workflow executions to count.
Constraints: | ||
| Equals(Object) | (Inherited from Object.) | ||
| ExecutionFilter |
If specified, only workflow executions matching the WorkflowId in the filter are counted.
| ||
| GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.) | ||
| GetType()()()() | Gets the type of the current instance. (Inherited from Object.) | ||
| StartTimeFilter |
Specifies the start time criteria that workflow executions must meet in order to be counted.
| ||
| TagFilter |
If specified, only executions that have a tag that matches the filter are counted.
| ||
| ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) | ||
| TypeFilter |
Specifies the type of the workflow executions to be counted.
| ||
| WithDomain(String) | Obsolete.
Sets the Domain property
| ||
| WithExecutionFilter(WorkflowExecutionFilter) | Obsolete.
Sets the ExecutionFilter property
| ||
| WithStartTimeFilter(ExecutionTimeFilter) | Obsolete.
Sets the StartTimeFilter property
| ||
| WithTagFilter(TagFilter) | Obsolete.
Sets the TagFilter property
| ||
| WithTypeFilter(WorkflowTypeFilter) | Obsolete.
Sets the TypeFilter property
|
Note: Inheritance Hierarchy| Object | ||
 | AmazonWebServiceRequest | |
| CountOpenWorkflowExecutionsRequest | |