AWS SDK for .NET Documentation
ListClosedWorkflowExecutionsRequest Class
AmazonAmazon.SimpleWorkflow.ModelListClosedWorkflowExecutionsRequest Did this page help you?   Yes   No    Tell us about it...
Container for the parameters to the ListClosedWorkflowExecutions operation.

Returns a list of closed 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:

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 ListClosedWorkflowExecutionsRequest : AmazonWebServiceRequest
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
ListClosedWorkflowExecutionsRequest()()()()
Initializes a new instance of the ListClosedWorkflowExecutionsRequest class

CloseStatusFilter
If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.
Note:
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

CloseTimeFilter
If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.
Note:
startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

Domain
The name of the domain that contains the workflow executions to list.

Constraints:

Length
1 - 256


Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
ExecutionFilter
If specified, only workflow executions matching the workflow id specified in the filter are returned.
Note:
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

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:

Range
0 - 1000


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:

Length
0 - 2048


ReverseOrder
When set to true, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.

StartTimeFilter
If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.
Note:
startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

TagFilter
If specified, only executions that have the matching tag are listed.
Note:
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

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.
Note:
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

WithCloseStatusFilter(CloseStatusFilter) Obsolete.
Sets the CloseStatusFilter property

WithCloseTimeFilter(ExecutionTimeFilter) Obsolete.
Sets the CloseTimeFilter property

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

Inheritance Hierarchy
Object
AmazonWebServiceRequest
 ListClosedWorkflowExecutionsRequest
See Also

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)