You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SWF::Types::ListClosedWorkflowExecutionsInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb

Overview

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,
}

Instance Attribute Summary collapse

Instance Attribute Details

#close_status_filterTypes::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.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.



3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3294

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)
  include Aws::Structure
end

#close_time_filterTypes::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.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.



3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3294

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)
  include Aws::Structure
end

#domainString

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

Returns:

  • (String)


3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3294

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)
  include Aws::Structure
end

#execution_filterTypes::WorkflowExecutionFilter

If specified, only workflow executions matching the workflow ID specified in the filter are returned.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.



3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3294

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)
  include Aws::Structure
end

#maximum_page_sizeInteger

The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

Returns:

  • (Integer)


3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3294

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)
  include Aws::Structure
end

#next_page_tokenString

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

Returns:

  • (String)


3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3294

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)
  include Aws::Structure
end

#reverse_orderBoolean

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.

Returns:

  • (Boolean)


3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3294

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)
  include Aws::Structure
end

#start_time_filterTypes::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.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.



3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3294

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)
  include Aws::Structure
end

#tag_filterTypes::TagFilter

If specified, only executions that have the matching tag are listed.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Returns:



3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3294

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)
  include Aws::Structure
end

#type_filterTypes::WorkflowTypeFilter

If specified, only executions of the type specified in the filter are returned.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.



3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3294

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)
  include Aws::Structure
end