Class: Aws::SWF::Types::ListClosedWorkflowExecutionsInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::SWF::Types::ListClosedWorkflowExecutionsInput
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-swf/types.rb
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#close_status_filter ⇒ Types::CloseStatusFilter
If specified, only workflow executions that match this *close status* are listed.
-
#close_time_filter ⇒ Types::ExecutionTimeFilter
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.
-
#domain ⇒ String
The name of the domain that contains the workflow executions to list.
-
#execution_filter ⇒ Types::WorkflowExecutionFilter
If specified, only workflow executions matching the workflow ID specified in the filter are returned.
-
#maximum_page_size ⇒ Integer
The maximum number of results that are returned per call.
-
#next_page_token ⇒ String
If ‘NextPageToken` is returned there are more results available.
-
#reverse_order ⇒ Boolean
When set to ‘true`, returns the results in reverse order.
-
#start_time_filter ⇒ Types::ExecutionTimeFilter
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.
-
#tag_filter ⇒ Types::TagFilter
If specified, only executions that have the matching tag are listed.
-
#type_filter ⇒ Types::WorkflowTypeFilter
If specified, only executions of the type specified in the filter are returned.
Instance Attribute Details
#close_status_filter ⇒ Types::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 markdown=“1”> ‘closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.
</note>
3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 |
# File 'lib/aws-sdk-swf/types.rb', line 3108 class ListClosedWorkflowExecutionsInput < Struct.new( :domain, :start_time_filter, :close_time_filter, :execution_filter, :close_status_filter, :type_filter, :tag_filter, :next_page_token, :maximum_page_size, :reverse_order) SENSITIVE = [] include Aws::Structure end |
#close_time_filter ⇒ Types::ExecutionTimeFilter
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>
3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 |
# File 'lib/aws-sdk-swf/types.rb', line 3108 class ListClosedWorkflowExecutionsInput < Struct.new( :domain, :start_time_filter, :close_time_filter, :execution_filter, :close_status_filter, :type_filter, :tag_filter, :next_page_token, :maximum_page_size, :reverse_order) SENSITIVE = [] include Aws::Structure end |
#domain ⇒ String
The name of the domain that contains the workflow executions to list.
3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 |
# File 'lib/aws-sdk-swf/types.rb', line 3108 class ListClosedWorkflowExecutionsInput < Struct.new( :domain, :start_time_filter, :close_time_filter, :execution_filter, :close_status_filter, :type_filter, :tag_filter, :next_page_token, :maximum_page_size, :reverse_order) SENSITIVE = [] include Aws::Structure end |
#execution_filter ⇒ Types::WorkflowExecutionFilter
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>
3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 |
# File 'lib/aws-sdk-swf/types.rb', line 3108 class ListClosedWorkflowExecutionsInput < Struct.new( :domain, :start_time_filter, :close_time_filter, :execution_filter, :close_status_filter, :type_filter, :tag_filter, :next_page_token, :maximum_page_size, :reverse_order) SENSITIVE = [] include Aws::Structure end |
#maximum_page_size ⇒ Integer
The maximum number of results that are returned per call. Use ‘nextPageToken` to obtain further pages of results.
3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 |
# File 'lib/aws-sdk-swf/types.rb', line 3108 class ListClosedWorkflowExecutionsInput < Struct.new( :domain, :start_time_filter, :close_time_filter, :execution_filter, :close_status_filter, :type_filter, :tag_filter, :next_page_token, :maximum_page_size, :reverse_order) SENSITIVE = [] include Aws::Structure end |
#next_page_token ⇒ String
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.
3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 |
# File 'lib/aws-sdk-swf/types.rb', line 3108 class ListClosedWorkflowExecutionsInput < Struct.new( :domain, :start_time_filter, :close_time_filter, :execution_filter, :close_status_filter, :type_filter, :tag_filter, :next_page_token, :maximum_page_size, :reverse_order) SENSITIVE = [] include Aws::Structure end |
#reverse_order ⇒ Boolean
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.
3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 |
# File 'lib/aws-sdk-swf/types.rb', line 3108 class ListClosedWorkflowExecutionsInput < Struct.new( :domain, :start_time_filter, :close_time_filter, :execution_filter, :close_status_filter, :type_filter, :tag_filter, :next_page_token, :maximum_page_size, :reverse_order) SENSITIVE = [] include Aws::Structure end |
#start_time_filter ⇒ Types::ExecutionTimeFilter
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>
3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 |
# File 'lib/aws-sdk-swf/types.rb', line 3108 class ListClosedWorkflowExecutionsInput < Struct.new( :domain, :start_time_filter, :close_time_filter, :execution_filter, :close_status_filter, :type_filter, :tag_filter, :next_page_token, :maximum_page_size, :reverse_order) SENSITIVE = [] include Aws::Structure end |
#tag_filter ⇒ Types::TagFilter
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>
3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 |
# File 'lib/aws-sdk-swf/types.rb', line 3108 class ListClosedWorkflowExecutionsInput < Struct.new( :domain, :start_time_filter, :close_time_filter, :execution_filter, :close_status_filter, :type_filter, :tag_filter, :next_page_token, :maximum_page_size, :reverse_order) SENSITIVE = [] include Aws::Structure end |
#type_filter ⇒ Types::WorkflowTypeFilter
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>
3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 |
# File 'lib/aws-sdk-swf/types.rb', line 3108 class ListClosedWorkflowExecutionsInput < Struct.new( :domain, :start_time_filter, :close_time_filter, :execution_filter, :close_status_filter, :type_filter, :tag_filter, :next_page_token, :maximum_page_size, :reverse_order) SENSITIVE = [] include Aws::Structure end |