Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1437225343.0 KB

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

post/#X-Amz-Target=SimpleWorkflowService.ListClosedWorkflowExecutions

Query parameters

maximumPageSizestring

Pagination limit

nextPageTokenstring

Pagination token

Headers

X-Amz-Target'SimpleWorkflowService.ListClosedWorkflowExecutions' required

Request body

domainstring required

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

nextPageTokenstring
<p>If <code>NextPageToken</code> is returned there are more results available. The value of <code>NextPageToken</code> 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 <code>400</code> error: "<code>Specified token has exceeded its maximum lifetime</code>". </p> <p>The configured <code>maximumPageSize</code> determines how many results can be returned in a single call. </p>
maximumPageSizeinteger

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

reverseOrderboolean

When set to <code>true</code>, 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.

Response

Success

nextPageTokenstring
<p>If a <code>NextPageToken</code> 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 <code>nextPageToken</code>. Keep all other arguments unchanged.</p> <p>The configured <code>maximumPageSize</code> determines how many results can be returned in a single call.</p>