Returns a list of open 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.
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 ListOpenWorkflowExecutionsRequest : AmazonWebServiceRequest
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description | ||
|---|---|---|---|---|
 | ListOpenWorkflowExecutionsRequest()()()() | Initializes a new instance of the ListOpenWorkflowExecutionsRequest class | ||
 | Domain |
The name of the domain that contains the workflow executions to list.
Constraints: | ||
| Equals(Object) | (Inherited from Object.) | ||
| ExecutionFilter |
If specified, only workflow executions matching the workflow id specified in the filter are returned.
| ||
| GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.) | ||
| GetType()()()() | Gets the type of the current instance. (Inherited from Object.) | ||
| MaximumPageSize |
The maximum number of results returned in each page. The default is 100, but the caller can override this value to a page size
smaller than the default. You cannot specify a page size greater than 100. Note that the number of executions may be less than the
maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.
Constraints: | ||
| NextPageToken |
If on a previous call to this method a NextPageToken was returned, the results are being paginated. To get the next page of results,
repeat the call with the returned token and all other arguments unchanged.
Constraints: | ||
| ReverseOrder |
When set to true, returns the results in reverse order. By default the results are returned in descending order of the start time of
the executions.
| ||
| StartTimeFilter |
Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.
| ||
| TagFilter |
If specified, only executions that have the matching tag are listed.
| ||
| ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) | ||
| TypeFilter |
If specified, only executions of the type specified in the filter are returned.
| ||
| WithDomain(String) | Obsolete.
Sets the Domain property
| ||
| WithExecutionFilter(WorkflowExecutionFilter) | Obsolete.
Sets the ExecutionFilter property
| ||
| WithMaximumPageSize(Int32) | Obsolete.
Sets the MaximumPageSize property
| ||
| WithNextPageToken(String) | Obsolete.
Sets the NextPageToken property
| ||
| WithReverseOrder(Boolean) | Obsolete.
Sets the ReverseOrder 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 | |
| ListOpenWorkflowExecutionsRequest | |