AWS SDK for .NET Documentation
AmazonSimpleWorkflow Interface
AmazonAmazon.SimpleWorkflowAmazonSimpleWorkflow Did this page help you?   Yes   No    Tell us about it...
Interface for accessing AmazonSimpleWorkflow. Amazon Simple Workflow Service

The Amazon Simple Workflow Service API Reference is intended for programmers who need detailed information about the Amazon SWF actions and data types.

For an broader overview of the Amazon SWF programming model, please go to the Amazon SWF Developer Guide.

This section provides an overview of Amazon SWF actions.

Action Categories

The Amazon SWF actions can be grouped into the following major categories.

Actions related to Activities

The following are actions that are performed by activity workers:

Activity workers use the PollForActivityTask to get new activity tasks. After a worker receives an activity task from Amazon SWF, it performs the task and responds using RespondActivityTaskCompleted if successful or RespondActivityTaskFailed if unsuccessful.

Actions related to Deciders

The following are actions that are performed by deciders:

Deciders use PollForDecisionTask to get decision tasks. After a decider receives a decision task from Amazon SWF, it examines its workflow execution history and decides what to do next. It calls RespondDecisionTaskCompletedto complete the decision task and provide zero or more next decisions.

Actions related to Workflow Executions

The following actions operate on a workflow execution:

Actions related to Administration

Although you can perform administrative tasks from the Amazon SWF console, you can use the actions in this section to automate functions or build your own administrative tools.

Activity Management

Workflow Management

Domain Management

Workflow Execution Management

Visibility Actions

Although you can perform visibility actions from the Amazon SWF console, you can use the actions in this section to build your own console or administrative tools.

Declaration Syntax
C#
public interface AmazonSimpleWorkflow : IDisposable
Members
All MembersMethods



IconMemberDescription
BeginCountClosedWorkflowExecutions(CountClosedWorkflowExecutionsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CountClosedWorkflowExecutions operation.

BeginCountOpenWorkflowExecutions(CountOpenWorkflowExecutionsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CountOpenWorkflowExecutions operation.

BeginCountPendingActivityTasks(CountPendingActivityTasksRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CountPendingActivityTasks operation.

BeginCountPendingDecisionTasks(CountPendingDecisionTasksRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CountPendingDecisionTasks operation.

BeginDeprecateActivityType(DeprecateActivityTypeRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeprecateActivityType operation.

BeginDeprecateDomain(DeprecateDomainRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeprecateDomain operation.

BeginDeprecateWorkflowType(DeprecateWorkflowTypeRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeprecateWorkflowType operation.

BeginDescribeActivityType(DescribeActivityTypeRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeActivityType operation.

BeginDescribeDomain(DescribeDomainRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeDomain operation.

BeginDescribeWorkflowExecution(DescribeWorkflowExecutionRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeWorkflowExecution operation.

BeginDescribeWorkflowType(DescribeWorkflowTypeRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeWorkflowType operation.

BeginGetWorkflowExecutionHistory(GetWorkflowExecutionHistoryRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the GetWorkflowExecutionHistory operation.

BeginListActivityTypes(ListActivityTypesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ListActivityTypes operation.

BeginListClosedWorkflowExecutions(ListClosedWorkflowExecutionsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ListClosedWorkflowExecutions operation.

BeginListDomains(ListDomainsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ListDomains operation.

BeginListOpenWorkflowExecutions(ListOpenWorkflowExecutionsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ListOpenWorkflowExecutions operation.

BeginListWorkflowTypes(ListWorkflowTypesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ListWorkflowTypes operation.

BeginPollForActivityTask(PollForActivityTaskRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the PollForActivityTask operation.

BeginPollForDecisionTask(PollForDecisionTaskRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the PollForDecisionTask operation.

BeginRecordActivityTaskHeartbeat(RecordActivityTaskHeartbeatRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the RecordActivityTaskHeartbeat operation.

BeginRegisterActivityType(RegisterActivityTypeRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the RegisterActivityType operation.

BeginRegisterDomain(RegisterDomainRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the RegisterDomain operation.

BeginRegisterWorkflowType(RegisterWorkflowTypeRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the RegisterWorkflowType operation.

BeginRequestCancelWorkflowExecution(RequestCancelWorkflowExecutionRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the RequestCancelWorkflowExecution operation.

BeginRespondActivityTaskCanceled(RespondActivityTaskCanceledRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the RespondActivityTaskCanceled operation.

BeginRespondActivityTaskCompleted(RespondActivityTaskCompletedRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the RespondActivityTaskCompleted operation.

BeginRespondActivityTaskFailed(RespondActivityTaskFailedRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the RespondActivityTaskFailed operation.

BeginRespondDecisionTaskCompleted(RespondDecisionTaskCompletedRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the RespondDecisionTaskCompleted operation.

BeginSignalWorkflowExecution(SignalWorkflowExecutionRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the SignalWorkflowExecution operation.

BeginStartWorkflowExecution(StartWorkflowExecutionRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the StartWorkflowExecution operation.

BeginTerminateWorkflowExecution(TerminateWorkflowExecutionRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the TerminateWorkflowExecution operation.

CountClosedWorkflowExecutions(CountClosedWorkflowExecutionsRequest)

Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.

NOTE: 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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


CountOpenWorkflowExecutions(CountOpenWorkflowExecutionsRequest)

Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.

NOTE: 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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


CountPendingActivityTasks(CountPendingActivityTasksRequest)

Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 will be returned.

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 taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


CountPendingDecisionTasks(CountPendingDecisionTasksRequest)

Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then 0 will be returned.

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 taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


DeprecateActivityType(DeprecateActivityTypeRequest)

Deprecates the specified activity type . After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type that were scheduled before the type was deprecated will continue to run.

NOTE: 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.
    • activityType.name : String constraint. The key is swf:activityType.name .
    • activityType.version : String constraint. The key is swf:activityType.version .

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


DeprecateDomain(DeprecateDomainRequest)

Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain. Executions that were started before the domain was deprecated will continue to run.

NOTE: 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.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


DeprecateWorkflowType(DeprecateWorkflowTypeRequest)

Deprecates the specified workflow type . After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated will continue to run. A deprecated workflow type may still be used when calling visibility actions.

NOTE: 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.
    • workflowType.name : String constraint. The key is swf:workflowType.name .
    • workflowType.version : String constraint. The key is swf:workflowType.version .

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


DescribeActivityType(DescribeActivityTypeRequest)

Returns information about the specified activity type. This includes configuration settings provided at registration time as well as other general information about the type.

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.
    • activityType.name : String constraint. The key is swf:activityType.name .
    • activityType.version : String constraint. The key is swf:activityType.version .

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


DescribeDomain(DescribeDomainRequest)

Returns information about the specified domain including description and status.

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.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


DescribeWorkflowExecution(DescribeWorkflowExecutionRequest)

Returns information about the specified workflow execution including its type and some statistics.

NOTE: 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.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


DescribeWorkflowType(DescribeWorkflowTypeRequest)

Returns information about the specified workflow type . This includes configuration settings specified when the type was registered and other information such as creation date, current status, etc.

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.
    • workflowType.name : String constraint. The key is swf:workflowType.name .
    • workflowType.version : String constraint. The key is swf:workflowType.version .

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


Dispose()()()()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
EndCountClosedWorkflowExecutions(IAsyncResult)
Finishes the asynchronous execution of the CountClosedWorkflowExecutions operation.

EndCountOpenWorkflowExecutions(IAsyncResult)
Finishes the asynchronous execution of the CountOpenWorkflowExecutions operation.

EndCountPendingActivityTasks(IAsyncResult)
Finishes the asynchronous execution of the CountPendingActivityTasks operation.

EndCountPendingDecisionTasks(IAsyncResult)
Finishes the asynchronous execution of the CountPendingDecisionTasks operation.

EndDeprecateActivityType(IAsyncResult)
Finishes the asynchronous execution of the DeprecateActivityType operation.

EndDeprecateDomain(IAsyncResult)
Finishes the asynchronous execution of the DeprecateDomain operation.

EndDeprecateWorkflowType(IAsyncResult)
Finishes the asynchronous execution of the DeprecateWorkflowType operation.

EndDescribeActivityType(IAsyncResult)
Finishes the asynchronous execution of the DescribeActivityType operation.

EndDescribeDomain(IAsyncResult)
Finishes the asynchronous execution of the DescribeDomain operation.

EndDescribeWorkflowExecution(IAsyncResult)
Finishes the asynchronous execution of the DescribeWorkflowExecution operation.

EndDescribeWorkflowType(IAsyncResult)
Finishes the asynchronous execution of the DescribeWorkflowType operation.

EndGetWorkflowExecutionHistory(IAsyncResult)
Finishes the asynchronous execution of the GetWorkflowExecutionHistory operation.

EndListActivityTypes(IAsyncResult)
Finishes the asynchronous execution of the ListActivityTypes operation.

EndListClosedWorkflowExecutions(IAsyncResult)
Finishes the asynchronous execution of the ListClosedWorkflowExecutions operation.

EndListDomains(IAsyncResult)
Finishes the asynchronous execution of the ListDomains operation.

EndListOpenWorkflowExecutions(IAsyncResult)
Finishes the asynchronous execution of the ListOpenWorkflowExecutions operation.

EndListWorkflowTypes(IAsyncResult)
Finishes the asynchronous execution of the ListWorkflowTypes operation.

EndPollForActivityTask(IAsyncResult)
Finishes the asynchronous execution of the PollForActivityTask operation.

EndPollForDecisionTask(IAsyncResult)
Finishes the asynchronous execution of the PollForDecisionTask operation.

EndRecordActivityTaskHeartbeat(IAsyncResult)
Finishes the asynchronous execution of the RecordActivityTaskHeartbeat operation.

EndRegisterActivityType(IAsyncResult)
Finishes the asynchronous execution of the RegisterActivityType operation.

EndRegisterDomain(IAsyncResult)
Finishes the asynchronous execution of the RegisterDomain operation.

EndRegisterWorkflowType(IAsyncResult)
Finishes the asynchronous execution of the RegisterWorkflowType operation.

EndRequestCancelWorkflowExecution(IAsyncResult)
Finishes the asynchronous execution of the RequestCancelWorkflowExecution operation.

EndRespondActivityTaskCanceled(IAsyncResult)
Finishes the asynchronous execution of the RespondActivityTaskCanceled operation.

EndRespondActivityTaskCompleted(IAsyncResult)
Finishes the asynchronous execution of the RespondActivityTaskCompleted operation.

EndRespondActivityTaskFailed(IAsyncResult)
Finishes the asynchronous execution of the RespondActivityTaskFailed operation.

EndRespondDecisionTaskCompleted(IAsyncResult)
Finishes the asynchronous execution of the RespondDecisionTaskCompleted operation.

EndSignalWorkflowExecution(IAsyncResult)
Finishes the asynchronous execution of the SignalWorkflowExecution operation.

EndStartWorkflowExecution(IAsyncResult)
Finishes the asynchronous execution of the StartWorkflowExecution operation.

EndTerminateWorkflowExecution(IAsyncResult)
Finishes the asynchronous execution of the TerminateWorkflowExecution operation.

GetWorkflowExecutionHistory(GetWorkflowExecutionHistoryRequest)

Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

NOTE: 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.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


ListActivityTypes(ListActivityTypesRequest)

Returns information about all activities registered in the specified domain that match the specified name and registration status. The result includes information like creation date, current status of the activity, etc. 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:

  • 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.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


ListClosedWorkflowExecutions(ListClosedWorkflowExecutionsRequest)

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.

NOTE: 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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


ListDomains(ListDomainsRequest)

Returns 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 the nextPageToken returned by the initial call.

NOTE: 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. The element must be set to arn:aws:swf::AccountID:domain/*" , where “AccountID" is the account ID, with no dashes.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


ListOpenWorkflowExecutions(ListOpenWorkflowExecutionsRequest)

Returns 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 subsequent pages, make the call again using the nextPageToken returned by the initial call.

NOTE: 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 does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


ListWorkflowTypes(ListWorkflowTypesRequest)

Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly.

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.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


PollForActivityTask(PollForActivityTaskRequest)

Used 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 responds as soon as a task becomes available. The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll will return an empty result. An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its type to identify and process it correctly.

IMPORTANT: Workers should set their client side socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may hold the poll request).

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 taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


PollForDecisionTask(PollForDecisionTaskRequest)

Used 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 the specified task list. The task includes a paginated view of the history of the workflow execution. The decider should use the workflow type and the history to determine how to properly handle the task.

This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned, but that the value of taskToken is an empty string.

IMPORTANT: Deciders should set their client side socket timeout to at least 70 seconds (10 seconds higher than the timeout).

IMPORTANT: Because the number of workflow history events for a single workflow execution might be very large, the result returned might be split up across a number of pages. To retrieve subsequent pages, make additional calls to PollForDecisionTask using the nextPageToken returned by the initial call. Note that you do not call GetWorkflowExecutionHistory with this nextPageToken. Instead, call PollForDecisionTask again.

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 taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


RecordActivityTaskHeartbeat(RecordActivityTaskHeartbeatRequest)

Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress. The worker can also (optionally) specify details of the progress, for example percent complete, using the details parameter. This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted for the specified task, then the boolean cancelRequested flag returned by the service is set to true .

This action resets the taskHeartbeatTimeout clock. The taskHeartbeatTimeout is specified in RegisterActivityType.

This action does not in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history will contain a ActivityTaskTimedOut event that contains the information from the last heartbeat generated by the activity worker.

NOTE: The taskStartToCloseTimeout of an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. The taskStartToCloseTimeout is also specified in RegisterActivityType.

NOTE: This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted.

IMPORTANT: If the cancelRequested flag returns true, a cancellation is being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request.

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.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


RegisterActivityType(RegisterActivityTypeRequest)

Registers a new activity type along with its configuration settings in the specified domain.

IMPORTANT: A TypeAlreadyExists fault is returned if the type already exists in the domain. You cannot change any configuration settings of the type after its registration, and it must be registered as a new version.

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.
    • defaultTaskList.name : String constraint. The key is swf:defaultTaskList.name .
    • name : String constraint. The key is swf:name .
    • version : String constraint. The key is swf:version .

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


RegisterDomain(RegisterDomainRequest)

Registers 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 policy to control domain access for this action. The name of the domain being registered is available as the resource of this action.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


RegisterWorkflowType(RegisterWorkflowTypeRequest)

Registers a new workflow type and its configuration settings in the specified domain.

The retention period for the workflow history is set by the RegisterDomain action.

IMPORTANT: If the type already exists, then a TypeAlreadyExists fault is returned. You cannot change the configuration settings of a workflow type once it is registered and it must be registered as a new version.

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.
    • defaultTaskList.name : String constraint. The key is swf:defaultTaskList.name .
    • name : String constraint. The key is swf:name .
    • version : String constraint. The key is swf:version .

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


RequestCancelWorkflowExecution(RequestCancelWorkflowExecutionRequest)

Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event.

NOTE: If the runId is not specified, the WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the specified workflowId in the domain.

NOTE: Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of TerminateWorkflowExecution when possible.

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.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


RespondActivityTaskCanceled(RespondActivityTaskCanceledRequest)

Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled. Additional details can be optionally provided using the details argument.

These details (if provided) appear in the ActivityTaskCanceled event added to the workflow history.

IMPORTANT: Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns true and if the activity can be safely undone or abandoned.

A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.

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.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


RespondActivityTaskCompleted(RespondActivityTaskCompletedRequest)

Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided). The result appears in the ActivityTaskCompleted event in the workflow history.

IMPORTANT: If the requested task does not complete successfully, use RespondActivityTaskFailed instead. If the worker finds that the task is canceled through the canceled flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call RespondActivityTaskCanceled.

A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.

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.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


RespondActivityTaskFailed(RespondActivityTaskFailedRequest)

Used 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 the ActivityTaskFailed event added to the workflow history.

A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.

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.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


RespondDecisionTaskCompleted(RespondDecisionTaskCompletedRequest)

Used by deciders to tell the service that the DecisionTask identified by the taskToken has successfully completed. The decisions argument specifies the list of decisions made while processing the task.

A DecisionTaskCompleted event is added to the workflow history. The executionContext specified is attached to the event in the workflow execution history.

Access Control

If an IAM policy grants permission to use RespondDecisionTaskCompleted , it can express permissions for the list of decisions in the decisions parameter. Each of the decisions has one or more parameters, much like a regular API call. To allow for policies to be as readable as possible, you can express permissions on decisions as if they were actual API calls, including applying conditions to some parameters. For more information, see Using IAM to Manage Access to Amazon SWF Workflows.


SignalWorkflowExecution(SignalWorkflowExecutionRequest)

Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided).

NOTE: If a runId is not specified, then the WorkflowExecutionSignaled event is recorded in the history of the current open workflow with the matching workflowId in the domain.

NOTE: If the specified workflow execution is not open, this method fails with UnknownResource.

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.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


StartWorkflowExecution(StartWorkflowExecutionRequest)

Starts an execution of the workflow type in the specified domain using the provided workflowId and input data.

This action returns the newly started workflow execution.

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.
    • tagList.member.0 : The key is swf:tagList.member.0 .
    • tagList.member.1 : The key is swf:tagList.member.1 .
    • tagList.member.2 : The key is swf:tagList.member.2 .
    • tagList.member.3 : The key is swf:tagList.member.3 .
    • tagList.member.4 : The key is swf:tagList.member.4 .
    • taskList : String constraint. The key is swf:taskList.name .
    • name : String constraint. The key is swf:workflowType.name .
    • version : String constraint. The key is swf:workflowType.version .

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


TerminateWorkflowExecution(TerminateWorkflowExecutionRequest)

Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution.

IMPORTANT: If the identified workflow execution was in progress, it is terminated immediately.

NOTE: If a runId is not specified, then the WorkflowExecutionTerminated event is recorded in the history of the current open workflow with the matching workflowId in the domain.

NOTE: You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution does not.

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.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.


Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)