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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CountClosedWorkflowExecutionsInput as input to an Aws::Client method, you can use a vanilla 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_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.

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

Returns:

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

Returns:

  • (Types::ExecutionTimeFilter) —

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

#domain ⇒ String

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

Returns:

  • (String) —

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

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

Returns:

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

Returns:

  • (Types::ExecutionTimeFilter) —

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

#tag_filter ⇒ Types::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:

  • (Types::TagFilter) —

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

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

Returns: