Class: Aws::SWF::Types::ListOpenWorkflowExecutionsInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::SWF::Types::ListOpenWorkflowExecutionsInput
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-swf/types.rb
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#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
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
#domain ⇒ String
The name of the domain that contains the workflow executions to list.
3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 |
# File 'lib/aws-sdk-swf/types.rb', line 3194 class ListOpenWorkflowExecutionsInput < Struct.new( :domain, :start_time_filter, :type_filter, :tag_filter, :next_page_token, :maximum_page_size, :reverse_order, :execution_filter) 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”> ‘executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.
</note>
3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 |
# File 'lib/aws-sdk-swf/types.rb', line 3194 class ListOpenWorkflowExecutionsInput < Struct.new( :domain, :start_time_filter, :type_filter, :tag_filter, :next_page_token, :maximum_page_size, :reverse_order, :execution_filter) 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.
3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 |
# File 'lib/aws-sdk-swf/types.rb', line 3194 class ListOpenWorkflowExecutionsInput < Struct.new( :domain, :start_time_filter, :type_filter, :tag_filter, :next_page_token, :maximum_page_size, :reverse_order, :execution_filter) 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.
3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 |
# File 'lib/aws-sdk-swf/types.rb', line 3194 class ListOpenWorkflowExecutionsInput < Struct.new( :domain, :start_time_filter, :type_filter, :tag_filter, :next_page_token, :maximum_page_size, :reverse_order, :execution_filter) 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 time of the executions.
3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 |
# File 'lib/aws-sdk-swf/types.rb', line 3194 class ListOpenWorkflowExecutionsInput < Struct.new( :domain, :start_time_filter, :type_filter, :tag_filter, :next_page_token, :maximum_page_size, :reverse_order, :execution_filter) SENSITIVE = [] include Aws::Structure end |
#start_time_filter ⇒ Types::ExecutionTimeFilter
Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.
3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 |
# File 'lib/aws-sdk-swf/types.rb', line 3194 class ListOpenWorkflowExecutionsInput < Struct.new( :domain, :start_time_filter, :type_filter, :tag_filter, :next_page_token, :maximum_page_size, :reverse_order, :execution_filter) SENSITIVE = [] include Aws::Structure end |
#tag_filter ⇒ Types::TagFilter
If specified, only executions that have the matching tag are listed.
<note markdown=“1”> ‘executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.
</note>
3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 |
# File 'lib/aws-sdk-swf/types.rb', line 3194 class ListOpenWorkflowExecutionsInput < Struct.new( :domain, :start_time_filter, :type_filter, :tag_filter, :next_page_token, :maximum_page_size, :reverse_order, :execution_filter) 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”> ‘executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.
</note>
3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 |
# File 'lib/aws-sdk-swf/types.rb', line 3194 class ListOpenWorkflowExecutionsInput < Struct.new( :domain, :start_time_filter, :type_filter, :tag_filter, :next_page_token, :maximum_page_size, :reverse_order, :execution_filter) SENSITIVE = [] include Aws::Structure end |