com.amazonaws.services.simpleworkflow
Interface AmazonSimpleWorkflow

All Known Subinterfaces:

AmazonSimpleWorkflowAsync

All Known Implementing Classes:

AmazonSimpleWorkflowAsyncClient, AmazonSimpleWorkflowClient

public interface AmazonSimpleWorkflow

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

• Actions related to Deciders

• Actions related to Workflow Executions

• Actions related to Administration

• Actions related to Visibility

Actions related to Activities

The following are actions that are performed by activity workers:

• PollForActivityTask

• RespondActivityTaskCompleted

• RespondActivityTaskFailed

• RespondActivityTaskCanceled

• RecordActivityTaskHeartbeat

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:

• PollForDecisionTask

• RespondDecisionTaskCompleted

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:

• RequestCancelWorkflowExecution

• StartWorkflowExecution

• SignalWorkflowExecution

• TerminateWorkflowExecution

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

• RegisterActivityType

• DeprecateActivityType

Workflow Management

• RegisterWorkflowType

• DeprecateWorkflowType

Domain Management

• RegisterDomain

• DeprecateDomain

Workflow Execution Management

• RequestCancelWorkflowExecution

• TerminateWorkflowExecution

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.

Activity Visibility

• ListActivityTypes

• DescribeActivity

Workflow Visibility

• ListWorkflowTypes

• DescribeWorkflowType

Workflow Execution Visibility

• DescribeWorkflowExecution

• ListOpenWorkflowExecutions

• ListClosedWorkflowExecutions

• CountOpenWorkflowExecutions

• CountClosedWorkflowExecutions

• GetWorkflowExecutionHistory

Domain Visibility

• ListDomains

• DescribeDomain

Task List Visibility

• CountPendingActivityTasks

• CountPendingDecisionTasks

Method Summary

WorkflowExecutionCount	countClosedWorkflowExecutions(CountClosedWorkflowExecutionsRequest countClosedWorkflowExecutionsRequest) Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.
WorkflowExecutionCount	countOpenWorkflowExecutions(CountOpenWorkflowExecutionsRequest countOpenWorkflowExecutionsRequest) Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.
PendingTaskCount	countPendingActivityTasks(CountPendingActivityTasksRequest countPendingActivityTasksRequest) Returns the estimated number of activity tasks in the specified task list.
PendingTaskCount	countPendingDecisionTasks(CountPendingDecisionTasksRequest countPendingDecisionTasksRequest) Returns the estimated number of decision tasks in the specified task list.
void	deprecateActivityType(DeprecateActivityTypeRequest deprecateActivityTypeRequest) Deprecates the specified activity type .
void	deprecateDomain(DeprecateDomainRequest deprecateDomainRequest) Deprecates the specified domain.
void	deprecateWorkflowType(DeprecateWorkflowTypeRequest deprecateWorkflowTypeRequest) Deprecates the specified workflow type .
ActivityTypeDetail	describeActivityType(DescribeActivityTypeRequest describeActivityTypeRequest) Returns information about the specified activity type.
DomainDetail	describeDomain(DescribeDomainRequest describeDomainRequest) Returns information about the specified domain including description and status.
WorkflowExecutionDetail	describeWorkflowExecution(DescribeWorkflowExecutionRequest describeWorkflowExecutionRequest) Returns information about the specified workflow execution including its type and some statistics.
WorkflowTypeDetail	describeWorkflowType(DescribeWorkflowTypeRequest describeWorkflowTypeRequest) Returns information about the specified workflow type .
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
History	getWorkflowExecutionHistory(GetWorkflowExecutionHistoryRequest getWorkflowExecutionHistoryRequest) Returns the history of the specified workflow execution.
ActivityTypeInfos	listActivityTypes(ListActivityTypesRequest listActivityTypesRequest) Returns information about all activities registered in the specified domain that match the specified name and registration status.
WorkflowExecutionInfos	listClosedWorkflowExecutions(ListClosedWorkflowExecutionsRequest listClosedWorkflowExecutionsRequest) Returns a list of closed workflow executions in the specified domain that meet the filtering criteria.
DomainInfos	listDomains(ListDomainsRequest listDomainsRequest) Returns the list of domains registered in the account.
WorkflowExecutionInfos	listOpenWorkflowExecutions(ListOpenWorkflowExecutionsRequest listOpenWorkflowExecutionsRequest) Returns a list of open workflow executions in the specified domain that meet the filtering criteria.
WorkflowTypeInfos	listWorkflowTypes(ListWorkflowTypesRequest listWorkflowTypesRequest) Returns information about workflow types in the specified domain.
ActivityTask	pollForActivityTask(PollForActivityTaskRequest pollForActivityTaskRequest) Used by workers to get an ActivityTask from the specified activity taskList .
DecisionTask	pollForDecisionTask(PollForDecisionTaskRequest pollForDecisionTaskRequest) Used by deciders to get a DecisionTask from the specified decision taskList .
ActivityTaskStatus	recordActivityTaskHeartbeat(RecordActivityTaskHeartbeatRequest recordActivityTaskHeartbeatRequest) Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress.
void	registerActivityType(RegisterActivityTypeRequest registerActivityTypeRequest) Registers a new activity type along with its configuration settings in the specified domain.
void	registerDomain(RegisterDomainRequest registerDomainRequest) Registers a new domain.
void	registerWorkflowType(RegisterWorkflowTypeRequest registerWorkflowTypeRequest) Registers a new workflow type and its configuration settings in the specified domain.
void	requestCancelWorkflowExecution(RequestCancelWorkflowExecutionRequest requestCancelWorkflowExecutionRequest) Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId.
void	respondActivityTaskCanceled(RespondActivityTaskCanceledRequest respondActivityTaskCanceledRequest) Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled.
void	respondActivityTaskCompleted(RespondActivityTaskCompletedRequest respondActivityTaskCompletedRequest) Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided).
void	respondActivityTaskFailed(RespondActivityTaskFailedRequest respondActivityTaskFailedRequest) Used by workers to tell the service that the ActivityTask identified by the taskToken has failed with reason (if specified).
void	respondDecisionTaskCompleted(RespondDecisionTaskCompletedRequest respondDecisionTaskCompletedRequest) Used by deciders to tell the service that the DecisionTask identified by the taskToken has successfully completed.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://swf.us-east-1.amazonaws.com").
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
void	signalWorkflowExecution(SignalWorkflowExecutionRequest 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.
Run	startWorkflowExecution(StartWorkflowExecutionRequest startWorkflowExecutionRequest) Starts an execution of the workflow type in the specified domain using the provided workflowId and input data.
void	terminateWorkflowExecution(TerminateWorkflowExecutionRequest terminateWorkflowExecutionRequest) Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
                 throws IllegalArgumentException

Overrides the default endpoint for this client ("https://swf.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "swf.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://swf.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

Parameters:

endpoint - The endpoint (ex: "swf.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://swf.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

deprecateWorkflowType

void deprecateWorkflowType(DeprecateWorkflowTypeRequest deprecateWorkflowTypeRequest)
                           throws AmazonServiceException,
                                  AmazonClientException

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.

Parameters:

deprecateWorkflowTypeRequest - Container for the necessary parameters to execute the DeprecateWorkflowType service method on AmazonSimpleWorkflow.

Throws:

TypeDeprecatedException

OperationNotPermittedException

UnknownResourceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

deprecateDomain

void deprecateDomain(DeprecateDomainRequest deprecateDomainRequest)
                     throws AmazonServiceException,
                            AmazonClientException

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.

Parameters:

deprecateDomainRequest - Container for the necessary parameters to execute the DeprecateDomain service method on AmazonSimpleWorkflow.

Throws:

DomainDeprecatedException

OperationNotPermittedException

UnknownResourceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

registerWorkflowType

void registerWorkflowType(RegisterWorkflowTypeRequest registerWorkflowTypeRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

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

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.

Parameters:

registerWorkflowTypeRequest - Container for the necessary parameters to execute the RegisterWorkflowType service method on AmazonSimpleWorkflow.

Throws:

OperationNotPermittedException

UnknownResourceException

TypeAlreadyExistsException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

listWorkflowTypes

WorkflowTypeInfos listWorkflowTypes(ListWorkflowTypesRequest listWorkflowTypesRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

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.

Parameters:

listWorkflowTypesRequest - Container for the necessary parameters to execute the ListWorkflowTypes service method on AmazonSimpleWorkflow.

Returns:

The response from the ListWorkflowTypes service method, as returned by AmazonSimpleWorkflow.

Throws:

OperationNotPermittedException

UnknownResourceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

startWorkflowExecution

Run startWorkflowExecution(StartWorkflowExecutionRequest startWorkflowExecutionRequest)
                           throws AmazonServiceException,
                                  AmazonClientException

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.

Parameters:

startWorkflowExecutionRequest - Container for the necessary parameters to execute the StartWorkflowExecution service method on AmazonSimpleWorkflow.

Returns:

The response from the StartWorkflowExecution service method, as returned by AmazonSimpleWorkflow.

Throws:

TypeDeprecatedException

OperationNotPermittedException

DefaultUndefinedException

UnknownResourceException

WorkflowExecutionAlreadyStartedException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

signalWorkflowExecution

void signalWorkflowExecution(SignalWorkflowExecutionRequest signalWorkflowExecutionRequest)
                             throws AmazonServiceException,
                                    AmazonClientException

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.

Parameters:

signalWorkflowExecutionRequest - Container for the necessary parameters to execute the SignalWorkflowExecution service method on AmazonSimpleWorkflow.

Throws:

OperationNotPermittedException

UnknownResourceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

listDomains

DomainInfos listDomains(ListDomainsRequest listDomainsRequest)
                        throws AmazonServiceException,
                               AmazonClientException

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.

Parameters:

listDomainsRequest - Container for the necessary parameters to execute the ListDomains service method on AmazonSimpleWorkflow.

Returns:

The response from the ListDomains service method, as returned by AmazonSimpleWorkflow.

Throws:

OperationNotPermittedException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

requestCancelWorkflowExecution

void requestCancelWorkflowExecution(RequestCancelWorkflowExecutionRequest requestCancelWorkflowExecutionRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

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.

Parameters:

requestCancelWorkflowExecutionRequest - Container for the necessary parameters to execute the RequestCancelWorkflowExecution service method on AmazonSimpleWorkflow.

Throws:

OperationNotPermittedException

UnknownResourceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

describeWorkflowType

WorkflowTypeDetail describeWorkflowType(DescribeWorkflowTypeRequest describeWorkflowTypeRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

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.

Parameters:

describeWorkflowTypeRequest - Container for the necessary parameters to execute the DescribeWorkflowType service method on AmazonSimpleWorkflow.

Returns:

The response from the DescribeWorkflowType service method, as returned by AmazonSimpleWorkflow.

Throws:

OperationNotPermittedException

UnknownResourceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

deprecateActivityType

void deprecateActivityType(DeprecateActivityTypeRequest deprecateActivityTypeRequest)
                           throws AmazonServiceException,
                                  AmazonClientException

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.

Parameters:

deprecateActivityTypeRequest - Container for the necessary parameters to execute the DeprecateActivityType service method on AmazonSimpleWorkflow.

Throws:

TypeDeprecatedException

OperationNotPermittedException

UnknownResourceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

countClosedWorkflowExecutions

WorkflowExecutionCount countClosedWorkflowExecutions(CountClosedWorkflowExecutionsRequest countClosedWorkflowExecutionsRequest)
                                                     throws AmazonServiceException,
                                                            AmazonClientException

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.

Parameters:

countClosedWorkflowExecutionsRequest - Container for the necessary parameters to execute the CountClosedWorkflowExecutions service method on AmazonSimpleWorkflow.

Returns:

The response from the CountClosedWorkflowExecutions service method, as returned by AmazonSimpleWorkflow.

Throws:

OperationNotPermittedException

UnknownResourceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

countPendingActivityTasks

PendingTaskCount countPendingActivityTasks(CountPendingActivityTasksRequest countPendingActivityTasksRequest)
                                           throws AmazonServiceException,
                                                  AmazonClientException

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.

Parameters:

countPendingActivityTasksRequest - Container for the necessary parameters to execute the CountPendingActivityTasks service method on AmazonSimpleWorkflow.

Returns:

The response from the CountPendingActivityTasks service method, as returned by AmazonSimpleWorkflow.

Throws:

OperationNotPermittedException

UnknownResourceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

respondActivityTaskCanceled

void respondActivityTaskCanceled(RespondActivityTaskCanceledRequest respondActivityTaskCanceledRequest)
                                 throws AmazonServiceException,
                                        AmazonClientException

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.

Parameters:

respondActivityTaskCanceledRequest - Container for the necessary parameters to execute the RespondActivityTaskCanceled service method on AmazonSimpleWorkflow.

Throws:

OperationNotPermittedException

UnknownResourceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

respondDecisionTaskCompleted

void respondDecisionTaskCompleted(RespondDecisionTaskCompletedRequest respondDecisionTaskCompletedRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

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.

Parameters:

respondDecisionTaskCompletedRequest - Container for the necessary parameters to execute the RespondDecisionTaskCompleted service method on AmazonSimpleWorkflow.

Throws:

OperationNotPermittedException

UnknownResourceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

respondActivityTaskCompleted

void respondActivityTaskCompleted(RespondActivityTaskCompletedRequest respondActivityTaskCompletedRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

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.

Parameters:

respondActivityTaskCompletedRequest - Container for the necessary parameters to execute the RespondActivityTaskCompleted service method on AmazonSimpleWorkflow.

Throws:

OperationNotPermittedException

UnknownResourceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

pollForActivityTask

ActivityTask pollForActivityTask(PollForActivityTaskRequest pollForActivityTaskRequest)
                                 throws AmazonServiceException,
                                        AmazonClientException

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).

Parameters:

pollForActivityTaskRequest - Container for the necessary parameters to execute the PollForActivityTask service method on AmazonSimpleWorkflow.

Returns:

The response from the PollForActivityTask service method, as returned by AmazonSimpleWorkflow.

Throws:

OperationNotPermittedException

UnknownResourceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

countOpenWorkflowExecutions

WorkflowExecutionCount countOpenWorkflowExecutions(CountOpenWorkflowExecutionsRequest countOpenWorkflowExecutionsRequest)
                                                   throws AmazonServiceException,
                                                          AmazonClientException

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.

Parameters:

countOpenWorkflowExecutionsRequest - Container for the necessary parameters to execute the CountOpenWorkflowExecutions service method on AmazonSimpleWorkflow.

Returns:

The response from the CountOpenWorkflowExecutions service method, as returned by AmazonSimpleWorkflow.

Throws:

OperationNotPermittedException

UnknownResourceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

describeActivityType

ActivityTypeDetail describeActivityType(DescribeActivityTypeRequest describeActivityTypeRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

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

Parameters:

describeActivityTypeRequest - Container for the necessary parameters to execute the DescribeActivityType service method on AmazonSimpleWorkflow.

Returns:

The response from the DescribeActivityType service method, as returned by AmazonSimpleWorkflow.

Throws:

OperationNotPermittedException

UnknownResourceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

listOpenWorkflowExecutions

WorkflowExecutionInfos listOpenWorkflowExecutions(ListOpenWorkflowExecutionsRequest listOpenWorkflowExecutionsRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

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.

Parameters:

listOpenWorkflowExecutionsRequest - Container for the necessary parameters to execute the ListOpenWorkflowExecutions service method on AmazonSimpleWorkflow.

Returns:

The response from the ListOpenWorkflowExecutions service method, as returned by AmazonSimpleWorkflow.

Throws:

OperationNotPermittedException

UnknownResourceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

getWorkflowExecutionHistory

History getWorkflowExecutionHistory(GetWorkflowExecutionHistoryRequest getWorkflowExecutionHistoryRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

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.

Parameters:

getWorkflowExecutionHistoryRequest - Container for the necessary parameters to execute the GetWorkflowExecutionHistory service method on AmazonSimpleWorkflow.

Returns:

The response from the GetWorkflowExecutionHistory service method, as returned by AmazonSimpleWorkflow.

Throws:

OperationNotPermittedException

UnknownResourceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

registerDomain

void registerDomain(RegisterDomainRequest registerDomainRequest)
                    throws AmazonServiceException,
                           AmazonClientException

Registers a new domain.

Parameters:

registerDomainRequest - Container for the necessary parameters to execute the RegisterDomain service method on AmazonSimpleWorkflow.

Throws:

DomainAlreadyExistsException

OperationNotPermittedException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

registerActivityType

void registerActivityType(RegisterActivityTypeRequest registerActivityTypeRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

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.

Parameters:

registerActivityTypeRequest - Container for the necessary parameters to execute the RegisterActivityType service method on AmazonSimpleWorkflow.

Throws:

OperationNotPermittedException

UnknownResourceException

TypeAlreadyExistsException

LimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

listClosedWorkflowExecutions

WorkflowExecutionInfos listClosedWorkflowExecutions(ListClosedWorkflowExecutionsRequest listClosedWorkflowExecutionsRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

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.

Parameters:

listClosedWorkflowExecutionsRequest - Container for the necessary parameters to execute the ListClosedWorkflowExecutions service method on AmazonSimpleWorkflow.

Returns:

The response from the ListClosedWorkflowExecutions service method, as returned by AmazonSimpleWorkflow.

Throws:

OperationNotPermittedException

UnknownResourceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

recordActivityTaskHeartbeat

ActivityTaskStatus recordActivityTaskHeartbeat(RecordActivityTaskHeartbeatRequest recordActivityTaskHeartbeatRequest)
                                               throws AmazonServiceException,
                                                      AmazonClientException

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.

Parameters:

recordActivityTaskHeartbeatRequest - Container for the necessary parameters to execute the RecordActivityTaskHeartbeat service method on AmazonSimpleWorkflow.

Returns:

The response from the RecordActivityTaskHeartbeat service method, as returned by AmazonSimpleWorkflow.

Throws:

OperationNotPermittedException

UnknownResourceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

pollForDecisionTask

DecisionTask pollForDecisionTask(PollForDecisionTaskRequest pollForDecisionTaskRequest)
                                 throws AmazonServiceException,
                                        AmazonClientException

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.

Parameters:

pollForDecisionTaskRequest - Container for the necessary parameters to execute the PollForDecisionTask service method on AmazonSimpleWorkflow.

Returns:

The response from the PollForDecisionTask service method, as returned by AmazonSimpleWorkflow.

Throws:

OperationNotPermittedException

UnknownResourceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

listActivityTypes

ActivityTypeInfos listActivityTypes(ListActivityTypesRequest listActivityTypesRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

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.

Parameters:

listActivityTypesRequest - Container for the necessary parameters to execute the ListActivityTypes service method on AmazonSimpleWorkflow.

Returns:

The response from the ListActivityTypes service method, as returned by AmazonSimpleWorkflow.

Throws:

OperationNotPermittedException

UnknownResourceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

describeDomain

DomainDetail describeDomain(DescribeDomainRequest describeDomainRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Returns information about the specified domain including description and status.

Parameters:

describeDomainRequest - Container for the necessary parameters to execute the DescribeDomain service method on AmazonSimpleWorkflow.

Returns:

The response from the DescribeDomain service method, as returned by AmazonSimpleWorkflow.

Throws:

OperationNotPermittedException

UnknownResourceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

respondActivityTaskFailed

void respondActivityTaskFailed(RespondActivityTaskFailedRequest respondActivityTaskFailedRequest)
                               throws AmazonServiceException,
                                      AmazonClientException

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.

Parameters:

respondActivityTaskFailedRequest - Container for the necessary parameters to execute the RespondActivityTaskFailed service method on AmazonSimpleWorkflow.

Throws:

OperationNotPermittedException

UnknownResourceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

countPendingDecisionTasks

PendingTaskCount countPendingDecisionTasks(CountPendingDecisionTasksRequest countPendingDecisionTasksRequest)
                                           throws AmazonServiceException,
                                                  AmazonClientException

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.

Parameters:

countPendingDecisionTasksRequest - Container for the necessary parameters to execute the CountPendingDecisionTasks service method on AmazonSimpleWorkflow.

Returns:

The response from the CountPendingDecisionTasks service method, as returned by AmazonSimpleWorkflow.

Throws:

OperationNotPermittedException

UnknownResourceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

terminateWorkflowExecution

void terminateWorkflowExecution(TerminateWorkflowExecutionRequest terminateWorkflowExecutionRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

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.

Parameters:

terminateWorkflowExecutionRequest - Container for the necessary parameters to execute the TerminateWorkflowExecution service method on AmazonSimpleWorkflow.

Throws:

OperationNotPermittedException

UnknownResourceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

describeWorkflowExecution

WorkflowExecutionDetail describeWorkflowExecution(DescribeWorkflowExecutionRequest describeWorkflowExecutionRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

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.

Parameters:

describeWorkflowExecutionRequest - Container for the necessary parameters to execute the DescribeWorkflowExecution service method on AmazonSimpleWorkflow.

Returns:

The response from the DescribeWorkflowExecution service method, as returned by AmazonSimpleWorkflow.

Throws:

OperationNotPermittedException

UnknownResourceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating either a problem with the data in the request, or a server side issue.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.