AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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.
Namespace: Amazon.SimpleWorkflow
Assembly: AWSSDK.dll
Version: (assembly version)
public class AmazonSimpleWorkflowClient : AmazonServiceClient IAmazonSimpleWorkflow, IDisposable
The AmazonSimpleWorkflowClient type exposes the following members
Name | Description | |
---|---|---|
AmazonSimpleWorkflowClient() |
Constructs AmazonSimpleWorkflowClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonSimpleWorkflowClient(RegionEndpoint) |
Constructs AmazonSimpleWorkflowClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonSimpleWorkflowClient(AmazonSimpleWorkflowConfig) |
Constructs AmazonSimpleWorkflowClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonSimpleWorkflowClient(AWSCredentials) | Constructs AmazonSimpleWorkflowClient with AWS Credentials | |
AmazonSimpleWorkflowClient(AWSCredentials, RegionEndpoint) | Constructs AmazonSimpleWorkflowClient with AWS Credentials | |
AmazonSimpleWorkflowClient(AWSCredentials, AmazonSimpleWorkflowConfig) | Constructs AmazonSimpleWorkflowClient with AWS Credentials and an AmazonSimpleWorkflowClient Configuration object. | |
AmazonSimpleWorkflowClient(string, string) | Constructs AmazonSimpleWorkflowClient with AWS Access Key ID and AWS Secret Key | |
AmazonSimpleWorkflowClient(string, string, RegionEndpoint) | Constructs AmazonSimpleWorkflowClient with AWS Access Key ID and AWS Secret Key | |
AmazonSimpleWorkflowClient(string, string, AmazonSimpleWorkflowConfig) | Constructs AmazonSimpleWorkflowClient with AWS Access Key ID, AWS Secret Key and an AmazonSimpleWorkflowClient Configuration object. | |
AmazonSimpleWorkflowClient(string, string, string) | Constructs AmazonSimpleWorkflowClient with AWS Access Key ID and AWS Secret Key | |
AmazonSimpleWorkflowClient(string, string, string, RegionEndpoint) | Constructs AmazonSimpleWorkflowClient with AWS Access Key ID and AWS Secret Key | |
AmazonSimpleWorkflowClient(string, string, string, AmazonSimpleWorkflowConfig) | Constructs AmazonSimpleWorkflowClient with AWS Access Key ID, AWS Secret Key and an AmazonSimpleWorkflowClient Configuration object. |
Name | Description | |
---|---|---|
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.
Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. 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.
Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. 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:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. 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:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. 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.
Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. 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.
Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. 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.
Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. 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 when the type was registered and 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:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. 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:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. 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.
Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. 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, and so on.
Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows. |
|
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. | |
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.
Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. 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:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. 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.
Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. 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.
Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. 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.
Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. 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:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. 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.
Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. 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 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:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. 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
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 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.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:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. 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.
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:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. 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:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. 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. 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:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. 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.
WorkflowExecutionCancelRequested
event is recorded in the history of the current open workflow execution with the specified
workflowId in the domain.Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. 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 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:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. 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.
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:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. 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:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. 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 Access Control
If an IAM policy grants permission to use |
|
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).
WorkflowExecutionSignaled
event is recorded in the history of the current open workflow with the matching workflowId
in the domain.UnknownResource .Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. 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:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. 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.
WorkflowExecutionTerminated
event is recorded in the history of the current open workflow with the matching workflowId
in the domain.Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows. |
Name | Description | |
---|---|---|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8