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

Class: Aws::SWF::Types::CountClosedWorkflowExecutionsInput

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 CountClosedWorkflowExecutionsInput 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
  },
  type_filter: {
    name: "Name", # required
    version: "VersionOptional",
  },
  tag_filter: {
    tag: "Tag", # required
  },
  close_status_filter: {
    status: "COMPLETED", # required, accepts COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, TIMED_OUT
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#close_status_filterTypes::CloseStatusFilter

If specified, only workflow executions that match this close status are counted. This filter has an affect only if executionStatus is specified as CLOSED.

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



1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 1273

class CountClosedWorkflowExecutionsInput < Struct.new(
  :domain,
  :start_time_filter,
  :close_time_filter,
  :execution_filter,
  :type_filter,
  :tag_filter,
  :close_status_filter)
  include Aws::Structure
end

#close_time_filterTypes::ExecutionTimeFilter

If specified, only workflow executions that meet the close time criteria of the filter are counted.

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



1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 1273

class CountClosedWorkflowExecutionsInput < Struct.new(
  :domain,
  :start_time_filter,
  :close_time_filter,
  :execution_filter,
  :type_filter,
  :tag_filter,
  :close_status_filter)
  include Aws::Structure
end

#domainString

The name of the domain containing the workflow executions to count.

Returns:

  • (String)


1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 1273

class CountClosedWorkflowExecutionsInput < Struct.new(
  :domain,
  :start_time_filter,
  :close_time_filter,
  :execution_filter,
  :type_filter,
  :tag_filter,
  :close_status_filter)
  include Aws::Structure
end

#execution_filterTypes::WorkflowExecutionFilter

If specified, only workflow executions matching the WorkflowId in the filter are counted.

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



1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 1273

class CountClosedWorkflowExecutionsInput < Struct.new(
  :domain,
  :start_time_filter,
  :close_time_filter,
  :execution_filter,
  :type_filter,
  :tag_filter,
  :close_status_filter)
  include Aws::Structure
end

#start_time_filterTypes::ExecutionTimeFilter

If specified, only workflow executions that meet the start time criteria of the filter are counted.

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



1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 1273

class CountClosedWorkflowExecutionsInput < Struct.new(
  :domain,
  :start_time_filter,
  :close_time_filter,
  :execution_filter,
  :type_filter,
  :tag_filter,
  :close_status_filter)
  include Aws::Structure
end

#tag_filterTypes::TagFilter

If specified, only executions that have a tag that matches the filter are counted.

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

Returns:



1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 1273

class CountClosedWorkflowExecutionsInput < Struct.new(
  :domain,
  :start_time_filter,
  :close_time_filter,
  :execution_filter,
  :type_filter,
  :tag_filter,
  :close_status_filter)
  include Aws::Structure
end

#type_filterTypes::WorkflowTypeFilter

If specified, indicates the type of the workflow executions to be counted.

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



1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 1273

class CountClosedWorkflowExecutionsInput < Struct.new(
  :domain,
  :start_time_filter,
  :close_time_filter,
  :execution_filter,
  :type_filter,
  :tag_filter,
  :close_status_filter)
  include Aws::Structure
end