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

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

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

Overview

Note:

When passing ListClosedWorkflowExecutionsInput 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
  },
  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_filter ⇒ Types::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.

Returns:

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

Returns:

  • (Types::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.

#domain ⇒ String

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

Returns:

  • (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.

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

Returns:

#maximum_page_size ⇒ Integer

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

Returns:

  • (Integer) —

    The maximum number of results that are returned per call.

#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 60 seconds. 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.

Returns:

  • (String) —

    If NextPageToken is returned there are more results available.

#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 or the close time of the executions.

Returns:

  • (Boolean) —

    When set to true, returns the results in reverse order.

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

Returns:

  • (Types::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.

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

  • (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.

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

Returns: