/AWS1/CL_SWF=>LISTCLOSEDWORKFLOWEXECUTIONS()
¶
About ListClosedWorkflowExecutions¶
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.
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.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_DOMAIN
TYPE /AWS1/SWFDOMAINNAME
/AWS1/SWFDOMAINNAME
¶
The name of the domain that contains the workflow executions to list.
Optional arguments:¶
IO_STARTTIMEFILTER
TYPE REF TO /AWS1/CL_SWFEXECTIMEFILTER
/AWS1/CL_SWFEXECTIMEFILTER
¶
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
andcloseTimeFilter
are mutually exclusive. You must specify one of these in a request but not both.
IO_CLOSETIMEFILTER
TYPE REF TO /AWS1/CL_SWFEXECTIMEFILTER
/AWS1/CL_SWFEXECTIMEFILTER
¶
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
andcloseTimeFilter
are mutually exclusive. You must specify one of these in a request but not both.
IO_EXECUTIONFILTER
TYPE REF TO /AWS1/CL_SWFWORKFLOWEXECFILTER
/AWS1/CL_SWFWORKFLOWEXECFILTER
¶
If specified, only workflow executions matching the workflow ID specified in the filter are returned.
closeStatusFilter
,executionFilter
,typeFilter
andtagFilter
are mutually exclusive. You can specify at most one of these in a request.
IO_CLOSESTATUSFILTER
TYPE REF TO /AWS1/CL_SWFCLOSESTATUSFILTER
/AWS1/CL_SWFCLOSESTATUSFILTER
¶
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
andtagFilter
are mutually exclusive. You can specify at most one of these in a request.
IO_TYPEFILTER
TYPE REF TO /AWS1/CL_SWFWORKFLOWTYPEFILTER
/AWS1/CL_SWFWORKFLOWTYPEFILTER
¶
If specified, only executions of the type specified in the filter are returned.
closeStatusFilter
,executionFilter
,typeFilter
andtagFilter
are mutually exclusive. You can specify at most one of these in a request.
IO_TAGFILTER
TYPE REF TO /AWS1/CL_SWFTAGFILTER
/AWS1/CL_SWFTAGFILTER
¶
If specified, only executions that have the matching tag are listed.
closeStatusFilter
,executionFilter
,typeFilter
andtagFilter
are mutually exclusive. You can specify at most one of these in a request.
IV_NEXTPAGETOKEN
TYPE /AWS1/SWFPAGETOKEN
/AWS1/SWFPAGETOKEN
¶
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.
IV_MAXIMUMPAGESIZE
TYPE /AWS1/SWFPAGESIZE
/AWS1/SWFPAGESIZE
¶
The maximum number of results that are returned per call. Use
nextPageToken
to obtain further pages of results.
IV_REVERSEORDER
TYPE /AWS1/SWFREVERSEORDER
/AWS1/SWFREVERSEORDER
¶
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.