swf_list_closed_workflow_executions: Returns a list of closed workflow executions in the specified...

View source: R/swf_operations.R

swf_list_closed_workflow_executionsR Documentation

Returns a list of closed workflow executions in the specified domain that meet the filtering criteria

Description

Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

See https://www.paws-r-sdk.com/docs/swf_list_closed_workflow_executions/ for full documentation.

Usage

swf_list_closed_workflow_executions(
  domain,
  startTimeFilter = NULL,
  closeTimeFilter = NULL,
  executionFilter = NULL,
  closeStatusFilter = NULL,
  typeFilter = NULL,
  tagFilter = NULL,
  nextPageToken = NULL,
  maximumPageSize = NULL,
  reverseOrder = NULL
)

Arguments

domain

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

startTimeFilter

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.

closeTimeFilter

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.

executionFilter

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.

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.

typeFilter

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.

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.

nextPageToken

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 24 hours. 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.

maximumPageSize

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

reverseOrder

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.


paws.application.integration documentation built on Sept. 12, 2024, 6:11 a.m.