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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
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
  },
}

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#close_status_filter ⇒ Types::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`.

<note markdown=“1”> ‘closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.

</note>

Returns:



1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
 
# File 'lib/aws-sdk-swf/types.rb', line 1304

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

#close_time_filter ⇒ Types::ExecutionTimeFilter

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

<note markdown=“1”> ‘startTimeFilter` and `closeTimeFilter` are mutually exclusive. You must specify one of these in a request but not both.

</note>

Returns:



1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
 
# File 'lib/aws-sdk-swf/types.rb', line 1304

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

#domain ⇒ String

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

Returns:

  • (String) 


1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
 
# File 'lib/aws-sdk-swf/types.rb', line 1304

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

#execution_filter ⇒ Types::WorkflowExecutionFilter

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

<note markdown=“1”> ‘closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.

</note>

Returns:



1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
 
# File 'lib/aws-sdk-swf/types.rb', line 1304

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

#start_time_filter ⇒ Types::ExecutionTimeFilter

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

<note markdown=“1”> ‘startTimeFilter` and `closeTimeFilter` are mutually exclusive. You must specify one of these in a request but not both.

</note>

Returns:



1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
 
# File 'lib/aws-sdk-swf/types.rb', line 1304

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

#tag_filter ⇒ Types::TagFilter

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

<note markdown=“1”> ‘closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.

</note>

Returns:



1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
 
# File 'lib/aws-sdk-swf/types.rb', line 1304

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

#type_filter ⇒ Types::WorkflowTypeFilter

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

<note markdown=“1”> ‘closeStatusFilter`, `executionFilter`, `typeFilter` and `tagFilter` are mutually exclusive. You can specify at most one of these in a request.

</note>

Returns:



1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
 
# File 'lib/aws-sdk-swf/types.rb', line 1304

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