ListOpenWorkflowExecutionsRequest Class

Container for the parameters to the ListOpenWorkflowExecutions operation. 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.

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 doesn't 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 is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SimpleWorkflow.AmazonSimpleWorkflowRequest
      Amazon.SimpleWorkflow.Model.ListOpenWorkflowExecutionsRequest

Namespace: Amazon.SimpleWorkflow.Model
Assembly: AWSSDK.SimpleWorkflow.dll
Version: 3.x.y.z

Syntax

public class ListOpenWorkflowExecutionsRequest : AmazonSimpleWorkflowRequest
         IAmazonWebServiceRequest

The ListOpenWorkflowExecutionsRequest type exposes the following members

Constructors

	Name	Description
	ListOpenWorkflowExecutionsRequest()

Properties

Name	Type	Description
Domain	System.String	Gets and sets the property Domain. The name of the domain that contains the workflow executions to list.
ExecutionFilter	Amazon.SimpleWorkflow.Model.WorkflowExecutionFilter	Gets and sets the property ExecutionFilter. If specified, only workflow executions matching the workflow ID specified in the filter are returned. `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.
MaximumPageSize	System.Int32	Gets and sets the property MaximumPageSize. The maximum number of results that are returned per call. Use `nextPageToken` to obtain further pages of results.
NextPageToken	System.String	Gets and sets the property NextPageToken. If `NextPageToken` is returned there are more results available. The value of `NextPageToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a `400` error: "`Specified token has exceeded its maximum lifetime`". The configured `maximumPageSize` determines how many results can be returned in a single call.
ReverseOrder	System.Boolean	Gets and sets the property 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	Amazon.SimpleWorkflow.Model.ExecutionTimeFilter	Gets and sets the property StartTimeFilter. Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.
TagFilter	Amazon.SimpleWorkflow.Model.TagFilter	Gets and sets the property TagFilter. If specified, only executions that have the matching tag are listed. `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.
TypeFilter	Amazon.SimpleWorkflow.Model.WorkflowTypeFilter	Gets and sets the property TypeFilter. If specified, only executions of the type specified in the filter are returned. `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5