List Open Workflow Executions
swf_list_open_workflow_executions | R Documentation |
Returns a list of open workflow executions in the specified domain that meet the filtering criteria¶
Description¶
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.
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 isswf:tagFilter.tag
. -
typeFilter.name
: String constraint. The key isswf:typeFilter.name
. -
typeFilter.version
: String constraint. The key isswf: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.
Usage¶
swf_list_open_workflow_executions(domain, startTimeFilter, typeFilter,
tagFilter, nextPageToken, maximumPageSize, reverseOrder,
executionFilter)
Arguments¶
domain
[required] The name of the domain that contains the workflow executions to list.
startTimeFilter
[required] Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.
typeFilter
If specified, only executions of the type specified in the filter are returned.
executionFilter
,typeFilter
andtagFilter
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.
executionFilter
,typeFilter
andtagFilter
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 ofNextPageToken
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 a400
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 time of the executions.executionFilter
If specified, only workflow executions matching the workflow ID specified in the filter are returned.
executionFilter
,typeFilter
andtagFilter
are mutually exclusive. You can specify at most one of these in a request.
Value¶
A list with the following syntax:
list(
executionInfos = list(
list(
execution = list(
workflowId = "string",
runId = "string"
),
workflowType = list(
name = "string",
version = "string"
),
startTimestamp = as.POSIXct(
"2015-01-01"
),
closeTimestamp = as.POSIXct(
"2015-01-01"
),
executionStatus = "OPEN"|"CLOSED",
closeStatus = "COMPLETED"|"FAILED"|"CANCELED"|"TERMINATED"|"CONTINUED_AS_NEW"|"TIMED_OUT",
parent = list(
workflowId = "string",
runId = "string"
),
tagList = list(
"string"
),
cancelRequested = TRUE|FALSE
)
),
nextPageToken = "string"
)
Request syntax¶
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"
)
)