Returns a list of open 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.
swf_list_open_workflow_executions(domain, startTimeFilter, typeFilter,
tagFilter, nextPageToken, maximumPageSize, reverseOrder,
executionFilter)
[required] The name of the domain that contains the workflow executions to list.
[required] Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.
If specified, only executions of the type specified in the filter are returned.
executionFilter
, typeFilter
and tagFilter
are mutually exclusive.
You can specify at most one of these in a request.
If specified, only executions that have the matching tag are listed.
executionFilter
, typeFilter
and tagFilter
are mutually exclusive.
You can specify at most one of these in a request.
If a NextPageToken
was returned by a previous call, there are more
results available. To retrieve the next page of results, make the call
again using the returned token in nextPageToken
. Keep all other
arguments unchanged.
The configured maximumPageSize
determines how many results can be
returned in a single call.
The maximum number of results that are returned per call.
nextPageToken
can be used to obtain futher pages of results. The
default is 1000, which is the maximum allowed page size. You can,
however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
When set to true
, returns the results in reverse order. By default the
results are returned in descending order of the start time of the
executions.
If specified, only workflow executions matching the workflow ID specified in the filter are returned.
executionFilter
, typeFilter
and tagFilter
are mutually exclusive.
You can specify at most one of these in a request.
svc$list_open_workflow_executions( domain = "string", startTimeFilter = list( oldestDate = as.POSIXct( "2015-01-01" ), latestDate = as.POSIXct( "2015-01-01" ) ), typeFilter = list( name = "string", version = "string" ), tagFilter = list( tag = "string" ), nextPageToken = "string", maximumPageSize = 123, reverseOrder = TRUE|FALSE, executionFilter = list( workflowId = "string" ) )
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Use a Resource
element with the domain name to limit the action to
only specified domains.
Use an Action
element to allow or deny permission to call this
action.
Constrain the following parameters by using a Condition
element
with the appropriate keys.
tagFilter.tag
: String constraint. The key is
swf:tagFilter.tag
.
typeFilter.name
: String constraint. The key is
swf:typeFilter.name
.
typeFilter.version
: String constraint. The key is
swf:typeFilter.version
.
If the caller doesn't have sufficient permissions to invoke the action,
or the parameter values fall outside the specified constraints, the
action fails. The associated event attribute's cause
parameter is set
to OPERATION_NOT_PERMITTED
. For details and example IAM policies, see
Using IAM to Manage Access to Amazon SWF Workflows
in the Amazon SWF Developer Guide.