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.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

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.

Request Syntax

{
   "closeStatusFilter": { 
      "status": "string"
   },
   "closeTimeFilter": { 
      "latestDate": number,
      "oldestDate": number
   },
   "domain": "string",
   "executionFilter": { 
      "workflowId": "string"
   },
   "maximumPageSize": number,
   "nextPageToken": "string",
   "reverseOrder": boolean,
   "startTimeFilter": { 
      "latestDate": number,
      "oldestDate": number
   },
   "tagFilter": { 
      "tag": "string"
   },
   "typeFilter": { 
      "name": "string",
      "version": "string"
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Response Syntax

{
   "executionInfos": [ 
      { 
         "cancelRequested": boolean,
         "closeStatus": "string",
         "closeTimestamp": number,
         "execution": { 
            "runId": "string",
            "workflowId": "string"
         },
         "executionStatus": "string",
         "parent": { 
            "runId": "string",
            "workflowId": "string"
         },
         "startTimestamp": number,
         "tagList": [ "string" ],
         "workflowType": { 
            "name": "string",
            "version": "string"
         }
      }
   ],
   "nextPageToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Errors

For information about the errors that are common to all actions, see Common Errors.

Examples

ListClosedWorkflowExecutions Example

This example illustrates one usage of ListClosedWorkflowExecutions.

Sample Request

POST / HTTP/1.1
Host: swf.us-east-1.amazonaws.com
User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)
Accept: application/json, text/javascript, */*
Accept-Language: en-us,en;q=0.5
Accept-Encoding: gzip,deflate
Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7
Keep-Alive: 115
Connection: keep-alive
Content-Type: application/x-amz-json-1.0
X-Requested-With: XMLHttpRequest
X-Amz-Date: Sun, 15 Jan 2012 02:51:01 GMT
X-Amz-Target: SimpleWorkflowService.ListClosedWorkflowExecutions
Content-Encoding: amz-1.0
X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=WY9jGbf5E3F9smGJHANhEXz9VL+1oGVgNL0/o7cBxQw=
Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html
Content-Length: 150
Pragma: no-cache
Cache-Control: no-cache

{"domain": "867530901",
"closeTimeFilter":
{"oldestDate": 1325376070,
"latestDate": 1356998399},
"tagFilter":
{"tag": "ricoh-the-dog"}
}

Sample Response

HTTP/1.1 200 OK
Content-Length: 1084
Content-Type: application/json
x-amzn-RequestId: c28b4df4-3f23-11e1-9e8f-57bb03e21482

{"executionInfos":
[
{"cancelRequested": false,
"closeStatus": "TIMED_OUT",
"closeTimestamp": 1326590754.654,
"execution":
{"runId": "c724e07a-b966-441f-a1c0-4831acbda1cd",
"workflowId": "20110927-T-1"},
"executionStatus": "CLOSED",
"startTimestamp": 1326587154.626,
"tagList":
["music purchase", "digital", "ricoh-the-dog"],
"workflowType":
{"name": "customerOrderWorkflow",
"version": "1.0"}
},
{"cancelRequested": false,
"closeStatus": "TIMED_OUT",
"closeTimestamp": 1326586831.628,
"execution":
{"runId": "f5ebbac6-941c-4342-ad69-dfd2f8be6689",
"workflowId": "20110927-T-1"},
"executionStatus": "CLOSED",
"startTimestamp": 1326585031.619,
"tagList":
["music purchase", "digital", "ricoh-the-dog"],
"workflowType":
{"name": "customerOrderWorkflow",
"version": "1.0"}
},
{"cancelRequested": false,
"closeStatus": "TIMED_OUT",
"closeTimestamp": 1326582914.031,
"execution":
{"runId": "1e536162-f1ea-48b0-85f3-aade88eef2f7",
"workflowId": "20110927-T-1"},
"executionStatus": "CLOSED",
"startTimestamp": 1326581114.02,
"tagList":
["music purchase", "digital", "ricoh-the-dog"],
"workflowType":
{"name": "customerOrderWorkflow",
"version": "1.0"}
}
]
}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: