Amazon Web Services, Inc.

Amazon Simple Workflow Service

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…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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
represents a logical unit of work that is performed by a component of your workflow.
Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and
concurrency in accordance with the logical flow of the application.
Amazon SWF gives you full control over implementing tasks and coordinating them without
worrying about underlying complexities such as tracking their progress and maintaining their
state.
This documentation serves as reference only. For a broader overview of the Amazon SWF
programming model, see the
Amazon SWF Developer Guide
.

Endpoints 39

  • POSTCount closed workflow executions/#X-Amz-Target=SimpleWorkflowService.CountClosedWorkflowExecutionsReturns the number of closed workflow executions within the given domain that meet the specified filtering criteria. This operation is eventually consistent.…
  • POSTCount open workflow executions/#X-Amz-Target=SimpleWorkflowService.CountOpenWorkflowExecutionsReturns the number of open workflow executions within the given domain that meet the specified filtering criteria. This operation is eventually consistent.…
  • POSTCount pending activity tasks/#X-Amz-Target=SimpleWorkflowService.CountPendingActivityTasksReturns the estimated number of activity tasks in the specified task list. The count returned is an approximation and isn't guaranteed to be exact. If you…
  • POSTCount pending decision tasks/#X-Amz-Target=SimpleWorkflowService.CountPendingDecisionTasksReturns the estimated number of decision tasks in the specified task list. The count returned is an approximation and isn't guaranteed to be exact. If you…
  • POSTDelete activity type/#X-Amz-Target=SimpleWorkflowService.DeleteActivityTypeDeletes the specified activity type . Note: Prior to deletion, activity types must first be deprecated . After an activity type has been deleted, you cannot…
  • POSTDelete workflow type/#X-Amz-Target=SimpleWorkflowService.DeleteWorkflowTypeDeletes the specified workflow type . Note: Prior to deletion, workflow types must first be deprecated . After a workflow type has been deleted, you cannot…
  • POSTDeprecate activity type/#X-Amz-Target=SimpleWorkflowService.DeprecateActivityTypeDeprecates the specified activity type . After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type…
  • POSTDeprecate domain/#X-Amz-Target=SimpleWorkflowService.DeprecateDomainDeprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you…
  • POSTDeprecate workflow type/#X-Amz-Target=SimpleWorkflowService.DeprecateWorkflowTypeDeprecates the specified workflow type . After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were…
  • POSTDescribe activity type/#X-Amz-Target=SimpleWorkflowService.DescribeActivityTypeReturns information about the specified activity type. This includes configuration settings provided when the type was registered and other general…
  • POSTDescribe domain/#X-Amz-Target=SimpleWorkflowService.DescribeDomainReturns information about the specified domain, including description and status. Access Control You can use IAM policies to control this action's access to…
  • POSTDescribe workflow execution/#X-Amz-Target=SimpleWorkflowService.DescribeWorkflowExecutionReturns information about the specified workflow execution including its type and some statistics. This operation is eventually consistent. The results are…
  • POSTDescribe workflow type/#X-Amz-Target=SimpleWorkflowService.DescribeWorkflowTypeReturns information about the specified workflow type . This includes configuration settings specified when the type was registered and other information such…
  • POSTGet workflow execution history/#X-Amz-Target=SimpleWorkflowService.GetWorkflowExecutionHistoryReturns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using…
  • POSTList activity types/#X-Amz-Target=SimpleWorkflowService.ListActivityTypesReturns information about all activities registered in the specified domain that match the specified name and registration status. The result includes…
  • POSTList closed workflow executions/#X-Amz-Target=SimpleWorkflowService.ListClosedWorkflowExecutionsReturns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To…
  • POSTList domains/#X-Amz-Target=SimpleWorkflowService.ListDomainsReturns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using…
  • POSTList open workflow executions/#X-Amz-Target=SimpleWorkflowService.ListOpenWorkflowExecutionsReturns 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…
  • POSTList tags for resource/#X-Amz-Target=SimpleWorkflowService.ListTagsForResourceList tags for a given domain.
  • POSTList workflow types/#X-Amz-Target=SimpleWorkflowService.ListWorkflowTypesReturns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call…
  • POSTPoll for activity task/#X-Amz-Target=SimpleWorkflowService.PollForActivityTaskUsed by workers to get an ActivityTask from the specified activity taskList . This initiates a long poll, where the service holds the HTTP connection open and…
  • POSTPoll for decision task/#X-Amz-Target=SimpleWorkflowService.PollForDecisionTaskUsed by deciders to get a DecisionTask from the specified decision taskList . A decision task may be returned for any open workflow execution that is using…
  • POSTRecord activity task heartbeat/#X-Amz-Target=SimpleWorkflowService.RecordActivityTaskHeartbeatUsed by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress. The worker can also…
  • POSTRegister activity type/#X-Amz-Target=SimpleWorkflowService.RegisterActivityTypeRegisters a new activity type along with its configuration settings in the specified domain. A TypeAlreadyExists fault is returned if the type already exists…
  • POSTRegister domain/#X-Amz-Target=SimpleWorkflowService.RegisterDomainRegisters a new domain. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows: You cannot use an IAM…
  • POSTRegister workflow type/#X-Amz-Target=SimpleWorkflowService.RegisterWorkflowTypeRegisters a new workflow type and its configuration settings in the specified domain. The retention period for the workflow history is set by the…
  • POSTRequest cancel workflow execution/#X-Amz-Target=SimpleWorkflowService.RequestCancelWorkflowExecutionRecords a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId. This…
  • POSTRespond activity task canceled/#X-Amz-Target=SimpleWorkflowService.RespondActivityTaskCanceledUsed by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled. Additional details can be provided using the…
  • POSTRespond activity task completed/#X-Amz-Target=SimpleWorkflowService.RespondActivityTaskCompletedUsed by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided). The result appears…
  • POSTRespond activity task failed/#X-Amz-Target=SimpleWorkflowService.RespondActivityTaskFailedUsed by workers to tell the service that the ActivityTask identified by the taskToken has failed with reason (if specified). The reason and details appear in…
  • POSTRespond decision task completed/#X-Amz-Target=SimpleWorkflowService.RespondDecisionTaskCompletedUsed by deciders to tell the service that the DecisionTask identified by the taskToken has successfully completed. The decisions argument specifies the list…
  • POSTSignal workflow execution/#X-Amz-Target=SimpleWorkflowService.SignalWorkflowExecutionRecords a WorkflowExecutionSignaled event in the workflow execution history and creates a decision task for the workflow execution identified by the given…
  • POSTStart workflow execution/#X-Amz-Target=SimpleWorkflowService.StartWorkflowExecutionStarts an execution of the workflow type in the specified domain using the provided workflowId and input data. This action returns the newly started workflow…
  • POSTTag resource/#X-Amz-Target=SimpleWorkflowService.TagResourceAdd a tag to a Amazon SWF domain. Amazon SWF supports a maximum of 50 tags per resource.
  • POSTTerminate workflow execution/#X-Amz-Target=SimpleWorkflowService.TerminateWorkflowExecutionRecords a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child…
  • POSTUndeprecate activity type/#X-Amz-Target=SimpleWorkflowService.UndeprecateActivityTypeUndeprecates a previously deprecated activity type . After an activity type has been undeprecated, you can create new tasks of that activity type. This…
  • POSTUndeprecate domain/#X-Amz-Target=SimpleWorkflowService.UndeprecateDomainUndeprecates a previously deprecated domain. After a domain has been undeprecated it can be used to create new workflow executions or register new types. This…
  • POSTUndeprecate workflow type/#X-Amz-Target=SimpleWorkflowService.UndeprecateWorkflowTypeUndeprecates a previously deprecated workflow type . After a workflow type has been undeprecated, you can create new executions of that type. This operation…
  • POSTUntag resource/#X-Amz-Target=SimpleWorkflowService.UntagResourceRemove a tag from a Amazon SWF domain.

API details

Base URL
https://swf.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
39 operations on 39 pathsPOST 39
Description format
AWS Smithy model, API version 2012-01-25

How to test the Amazon Simple Workflow Service in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Simple Workflow Service collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Count closed workflow executions” (POST /#X-Amz-Target=SimpleWorkflowService.CountClosedWorkflowExecutions), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Simple Workflow Service?

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… It is listed under Developer tools and has 39 endpoints.

Who publishes the Amazon Simple Workflow Service?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Simple Workflow Service?

Requests go to https://swf.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Simple Workflow Service?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Simple Workflow Service have?

39 operations on 39 paths (39 POST).

Is forking the Amazon Simple Workflow Service free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.