# Amazon Simple Workflow Service API

> Amazon Simple Workflow Service API on Apizie: 37 endpoints (Returns the number of closed workflow executions within the given domain that meet the specified filtering…, Returns the number of open workflow executions within the given domain that meet the specified filtering…, Returns the estimated number of activity tasks in the specified task list. The count returned is an…, Returns the estimated number of decision tasks in the specified task list. The count returned is an…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:amazonaws-swf/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:amazonaws-swf`
- Category: Cloud
- Status: byok
- Source: https://github.com/mermade/aws2openapi
- Page: https://zieapi.vercel.app/api/cloud/amazonaws-swf
- OpenAPI: https://zieapi.vercel.app/api/cloud/amazonaws-swf/openapi.json

Amazon Simple Workflow Service The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to coordinate work across distributed components. In Amazon SWF, a task…

## Endpoints

### Returns the number of closed workflow executions within the given domain that meet the specified filtering…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/count-closed-workflow-executions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Returns the number of open workflow executions within the given domain that meet the specified filtering…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/count-open-workflow-executions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Returns the estimated number of activity tasks in the specified task list. The count returned is an…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/count-pending-activity-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Returns the estimated number of decision tasks in the specified task list. The count returned is an…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/count-pending-decision-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deprecates the specified activity type . After an activity type has been deprecated, you cannot create new…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/deprecate-activity-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/deprecate-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deprecates the specified workflow type . After a workflow type has been deprecated, you cannot create new…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/deprecate-workflow-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Returns information about the specified activity type. This includes configuration settings provided when…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/describe-activity-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Returns information about the specified domain, including description and status. Access Control You can use…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/describe-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Returns information about the specified workflow execution including its type and some statistics. This…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/describe-workflow-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Returns information about the specified workflow type . This includes configuration settings specified when…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/describe-workflow-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Returns the history of the specified workflow execution. The results may be split into multiple pages. To…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/get-workflow-execution-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maximumPageSize | string | no | Pagination limit |
| nextPageToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Returns information about all activities registered in the specified domain that match the specified name…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/list-activity-types` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maximumPageSize | string | no | Pagination limit |
| nextPageToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/list-closed-workflow-executions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maximumPageSize | string | no | Pagination limit |
| nextPageToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Returns the list of domains registered in the account. The results may be split into multiple pages. To…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/list-domains` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maximumPageSize | string | no | Pagination limit |
| nextPageToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/list-open-workflow-executions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maximumPageSize | string | no | Pagination limit |
| nextPageToken | string | no | Pagination token |
| body | object | no | JSON request body |

### List tags for a given domain.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/list-tags-for-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Returns information about workflow types in the specified domain. The results may be split into multiple…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/list-workflow-types` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maximumPageSize | string | no | Pagination limit |
| nextPageToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Used by workers to get an ActivityTask from the specified activity taskList . This initiates a long poll,…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/poll-for-activity-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Used by deciders to get a DecisionTask from the specified decision taskList . A decision task may be…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/poll-for-decision-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maximumPageSize | string | no | Pagination limit |
| nextPageToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Used by activity workers to report to the service that the ActivityTask represented by the specified…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/record-activity-task-heartbeat` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Registers a new activity type along with its configuration settings in the specified domain. A…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/register-activity-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Registers a new domain. Access Control You can use IAM policies to control this action's access to Amazon…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/register-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Registers a new workflow type and its configuration settings in the specified domain. The retention period…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/register-workflow-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/request-cancel-workflow-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/respond-activity-task-canceled` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/respond-activity-task-completed` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Used by workers to tell the service that the ActivityTask identified by the taskToken has failed with reason…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/respond-activity-task-failed` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Used by deciders to tell the service that the DecisionTask identified by the taskToken has successfully…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/respond-decision-task-completed` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision task for…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/signal-workflow-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Starts an execution of the workflow type in the specified domain using the provided workflowId and input…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/start-workflow-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Add a tag to a Amazon SWF domain. Amazon SWF supports a maximum of 50 tags per resource.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/tag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/terminate-workflow-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Undeprecates a previously deprecated activity type . After an activity type has been undeprecated, you can…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/undeprecate-activity-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Undeprecates a previously deprecated domain. After a domain has been undeprecated it can be used to create…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/undeprecate-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Undeprecates a previously deprecated workflow type . After a workflow type has been undeprecated, you can…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/undeprecate-workflow-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Remove a tag from a Amazon SWF domain.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/untag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:amazonaws-swf/count-closed-workflow-executions" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Amazon Simple Workflow Service API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:amazonaws-swf/count-closed-workflow-executions with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Amazon Simple Workflow Service API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Amazon Simple Workflow Service itself also needs your own key from amazonaws.com.

### Can AI agents use the Amazon Simple Workflow Service API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-swf.

### What is the status of the Amazon Simple Workflow Service API?
Needs your own provider key (bring your own key)