class Aws::SWF::Types::ListClosedWorkflowExecutionsInput
@note When making an API call, you may pass ListClosedWorkflowExecutionsInput
data as a hash: { domain: "DomainName", # required start_time_filter: { oldest_date: Time.now, # required latest_date: Time.now, }, close_time_filter: { oldest_date: Time.now, # required latest_date: Time.now, }, execution_filter: { workflow_id: "WorkflowId", # required }, close_status_filter: { status: "COMPLETED", # required, accepts COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, TIMED_OUT }, type_filter: { name: "Name", # required version: "VersionOptional", }, tag_filter: { tag: "Tag", # required }, next_page_token: "PageToken", maximum_page_size: 1, reverse_order: false, }
@!attribute [rw] domain
The name of the domain that contains the workflow executions to list. @return [String]
@!attribute [rw] start_time_filter
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 markdown="1"> `startTimeFilter` and `closeTimeFilter` are mutually exclusive. You must specify one of these in a request but not both. </note> @return [Types::ExecutionTimeFilter]
@!attribute [rw] close_time_filter
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 markdown="1"> `startTimeFilter` and `closeTimeFilter` are mutually exclusive. You must specify one of these in a request but not both. </note> @return [Types::ExecutionTimeFilter]
@!attribute [rw] execution_filter
If specified, only workflow executions matching the workflow ID specified in the filter are returned. <note markdown="1"> `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request. </note> @return [Types::WorkflowExecutionFilter]
@!attribute [rw] close_status_filter
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 markdown="1"> `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request. </note> @return [Types::CloseStatusFilter]
@!attribute [rw] type_filter
If specified, only executions of the type specified in the filter are returned. <note markdown="1"> `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request. </note> @return [Types::WorkflowTypeFilter]
@!attribute [rw] tag_filter
If specified, only executions that have the matching tag are listed. <note markdown="1"> `closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request. </note> @return [Types::TagFilter]
@!attribute [rw] next_page_token
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 60 seconds. 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. @return [String]
@!attribute [rw] maximum_page_size
The maximum number of results that are returned per call. Use `nextPageToken` to obtain further pages of results. @return [Integer]
@!attribute [rw] reverse_order
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. @return [Boolean]
Constants
- SENSITIVE