com.amazonaws.services.simpleworkflow
Class AmazonSimpleWorkflowAsyncClient

java.lang.Object
  com.amazonaws.AmazonWebServiceClient
      com.amazonaws.services.simpleworkflow.AmazonSimpleWorkflowClient
          com.amazonaws.services.simpleworkflow.AmazonSimpleWorkflowAsyncClient

All Implemented Interfaces:

AmazonSimpleWorkflow, AmazonSimpleWorkflowAsync

public class AmazonSimpleWorkflowAsyncClient
extends AmazonSimpleWorkflowClient
implements AmazonSimpleWorkflowAsync

Client for accessing AmazonSimpleWorkflow. All calls made using this client are non-blocking and will immediately return a Java Future. Callers must use the Future object to determine when the service call has actually completed. 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

Constructor Summary

AmazonSimpleWorkflowAsyncClient()
Constructs a new asynchronous client to invoke service methods on AmazonSimpleWorkflow.

AmazonSimpleWorkflowAsyncClient(AWSCredentials awsCredentials)
Constructs a new asynchronous client to invoke service methods on AmazonSimpleWorkflow using the specified AWS account credentials.

AmazonSimpleWorkflowAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AmazonSimpleWorkflow using the specified AWS account credentials, executor service, and client configuration options.

AmazonSimpleWorkflowAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AmazonSimpleWorkflow using the specified AWS account credentials and executor service.

AmazonSimpleWorkflowAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new asynchronous client to invoke service methods on AmazonSimpleWorkflow using the specified AWS account credentials provider.

AmazonSimpleWorkflowAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AmazonSimpleWorkflow using the specified AWS account credentials provider, executor service, and client configuration options.

AmazonSimpleWorkflowAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AmazonSimpleWorkflow using the specified AWS account credentials provider and executor service.

AmazonSimpleWorkflowAsyncClient(ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on AmazonSimpleWorkflow.

Method Summary

Future<WorkflowExecutionCount>	countClosedWorkflowExecutionsAsync(CountClosedWorkflowExecutionsRequest countClosedWorkflowExecutionsRequest) Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.
Future<WorkflowExecutionCount>	countOpenWorkflowExecutionsAsync(CountOpenWorkflowExecutionsRequest countOpenWorkflowExecutionsRequest) Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.
Future<PendingTaskCount>	countPendingActivityTasksAsync(CountPendingActivityTasksRequest countPendingActivityTasksRequest) Returns the estimated number of activity tasks in the specified task list.
Future<PendingTaskCount>	countPendingDecisionTasksAsync(CountPendingDecisionTasksRequest countPendingDecisionTasksRequest) Returns the estimated number of decision tasks in the specified task list.
Future<Void>	deprecateActivityTypeAsync(DeprecateActivityTypeRequest deprecateActivityTypeRequest) Deprecates the specified activity type .
Future<Void>	deprecateDomainAsync(DeprecateDomainRequest deprecateDomainRequest) Deprecates the specified domain.
Future<Void>	deprecateWorkflowTypeAsync(DeprecateWorkflowTypeRequest deprecateWorkflowTypeRequest) Deprecates the specified workflow type .
Future<ActivityTypeDetail>	describeActivityTypeAsync(DescribeActivityTypeRequest describeActivityTypeRequest) Returns information about the specified activity type.
Future<DomainDetail>	describeDomainAsync(DescribeDomainRequest describeDomainRequest) Returns information about the specified domain including description and status.
Future<WorkflowExecutionDetail>	describeWorkflowExecutionAsync(DescribeWorkflowExecutionRequest describeWorkflowExecutionRequest) Returns information about the specified workflow execution including its type and some statistics.
Future<WorkflowTypeDetail>	describeWorkflowTypeAsync(DescribeWorkflowTypeRequest describeWorkflowTypeRequest) Returns information about the specified workflow type .
ExecutorService	getExecutorService() Returns the executor service used by this async client to execute requests.
Future<History>	getWorkflowExecutionHistoryAsync(GetWorkflowExecutionHistoryRequest getWorkflowExecutionHistoryRequest) Returns the history of the specified workflow execution.
Future<ActivityTypeInfos>	listActivityTypesAsync(ListActivityTypesRequest listActivityTypesRequest) Returns information about all activities registered in the specified domain that match the specified name and registration status.
Future<WorkflowExecutionInfos>	listClosedWorkflowExecutionsAsync(ListClosedWorkflowExecutionsRequest listClosedWorkflowExecutionsRequest) Returns a list of closed workflow executions in the specified domain that meet the filtering criteria.
Future<DomainInfos>	listDomainsAsync(ListDomainsRequest listDomainsRequest) Returns the list of domains registered in the account.
Future<WorkflowExecutionInfos>	listOpenWorkflowExecutionsAsync(ListOpenWorkflowExecutionsRequest listOpenWorkflowExecutionsRequest) Returns a list of open workflow executions in the specified domain that meet the filtering criteria.
Future<WorkflowTypeInfos>	listWorkflowTypesAsync(ListWorkflowTypesRequest listWorkflowTypesRequest) Returns information about workflow types in the specified domain.
Future<ActivityTask>	pollForActivityTaskAsync(PollForActivityTaskRequest pollForActivityTaskRequest) Used by workers to get an ActivityTask from the specified activity taskList .
Future<DecisionTask>	pollForDecisionTaskAsync(PollForDecisionTaskRequest pollForDecisionTaskRequest) Used by deciders to get a DecisionTask from the specified decision taskList .
Future<ActivityTaskStatus>	recordActivityTaskHeartbeatAsync(RecordActivityTaskHeartbeatRequest recordActivityTaskHeartbeatRequest) Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress.
Future<Void>	registerActivityTypeAsync(RegisterActivityTypeRequest registerActivityTypeRequest) Registers a new activity type along with its configuration settings in the specified domain.
Future<Void>	registerDomainAsync(RegisterDomainRequest registerDomainRequest) Registers a new domain.
Future<Void>	registerWorkflowTypeAsync(RegisterWorkflowTypeRequest registerWorkflowTypeRequest) Registers a new workflow type and its configuration settings in the specified domain.
Future<Void>	requestCancelWorkflowExecutionAsync(RequestCancelWorkflowExecutionRequest requestCancelWorkflowExecutionRequest) Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId.
Future<Void>	respondActivityTaskCanceledAsync(RespondActivityTaskCanceledRequest respondActivityTaskCanceledRequest) Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled.
Future<Void>	respondActivityTaskCompletedAsync(RespondActivityTaskCompletedRequest respondActivityTaskCompletedRequest) Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided).
Future<Void>	respondActivityTaskFailedAsync(RespondActivityTaskFailedRequest respondActivityTaskFailedRequest) Used by workers to tell the service that the ActivityTask identified by the taskToken has failed with reason (if specified).
Future<Void>	respondDecisionTaskCompletedAsync(RespondDecisionTaskCompletedRequest respondDecisionTaskCompletedRequest) Used by deciders to tell the service that the DecisionTask identified by the taskToken has successfully completed.
void	shutdown() Shuts down the client, releasing all managed resources.
Future<Void>	signalWorkflowExecutionAsync(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.
Future<Run>	startWorkflowExecutionAsync(StartWorkflowExecutionRequest startWorkflowExecutionRequest) Starts an execution of the workflow type in the specified domain using the provided workflowId and input data.
Future<Void>	terminateWorkflowExecutionAsync(TerminateWorkflowExecutionRequest terminateWorkflowExecutionRequest) Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId.

Methods inherited from class com.amazonaws.services.simpleworkflow.AmazonSimpleWorkflowClient

countClosedWorkflowExecutions, countOpenWorkflowExecutions, countPendingActivityTasks, countPendingDecisionTasks, deprecateActivityType, deprecateDomain, deprecateWorkflowType, describeActivityType, describeDomain, describeWorkflowExecution, describeWorkflowType, getCachedResponseMetadata, getWorkflowExecutionHistory, listActivityTypes, listClosedWorkflowExecutions, listDomains, listOpenWorkflowExecutions, listWorkflowTypes, pollForActivityTask, pollForDecisionTask, recordActivityTaskHeartbeat, registerActivityType, registerDomain, registerWorkflowType, requestCancelWorkflowExecution, respondActivityTaskCanceled, respondActivityTaskCompleted, respondActivityTaskFailed, respondDecisionTaskCompleted, signalWorkflowExecution, startWorkflowExecution, terminateWorkflowExecution

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, removeRequestHandler, setConfiguration, setEndpoint

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.simpleworkflow.AmazonSimpleWorkflow

countClosedWorkflowExecutions, countOpenWorkflowExecutions, countPendingActivityTasks, countPendingDecisionTasks, deprecateActivityType, deprecateDomain, deprecateWorkflowType, describeActivityType, describeDomain, describeWorkflowExecution, describeWorkflowType, getCachedResponseMetadata, getWorkflowExecutionHistory, listActivityTypes, listClosedWorkflowExecutions, listDomains, listOpenWorkflowExecutions, listWorkflowTypes, pollForActivityTask, pollForDecisionTask, recordActivityTaskHeartbeat, registerActivityType, registerDomain, registerWorkflowType, requestCancelWorkflowExecution, respondActivityTaskCanceled, respondActivityTaskCompleted, respondActivityTaskFailed, respondDecisionTaskCompleted, setEndpoint, signalWorkflowExecution, startWorkflowExecution, terminateWorkflowExecution

Constructor Detail

AmazonSimpleWorkflowAsyncClient

public AmazonSimpleWorkflowAsyncClient()

Constructs a new asynchronous client to invoke service methods on AmazonSimpleWorkflow. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProvider

AmazonSimpleWorkflowAsyncClient

public AmazonSimpleWorkflowAsyncClient(ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on AmazonSimpleWorkflow. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AmazonSimpleWorkflow (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProvider

AmazonSimpleWorkflowAsyncClient

public AmazonSimpleWorkflowAsyncClient(AWSCredentials awsCredentials)

Constructs a new asynchronous client to invoke service methods on AmazonSimpleWorkflow using the specified AWS account credentials. Default client settings will be used, and a default cached thread pool will be created for executing the asynchronous tasks.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonSimpleWorkflowAsyncClient

public AmazonSimpleWorkflowAsyncClient(AWSCredentials awsCredentials,
                                       ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonSimpleWorkflow using the specified AWS account credentials and executor service. Default client settings will be used.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AmazonSimpleWorkflowAsyncClient

public AmazonSimpleWorkflowAsyncClient(AWSCredentials awsCredentials,
                                       ClientConfiguration clientConfiguration,
                                       ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonSimpleWorkflow using the specified AWS account credentials, executor service, and client configuration options.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

AmazonSimpleWorkflowAsyncClient

public AmazonSimpleWorkflowAsyncClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new asynchronous client to invoke service methods on AmazonSimpleWorkflow using the specified AWS account credentials provider. Default client settings will be used, and a default cached thread pool will be created for executing the asynchronous tasks.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonSimpleWorkflowAsyncClient

public AmazonSimpleWorkflowAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                       ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonSimpleWorkflow using the specified AWS account credentials provider and executor service. Default client settings will be used.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AmazonSimpleWorkflowAsyncClient

public AmazonSimpleWorkflowAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                       ClientConfiguration clientConfiguration,
                                       ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonSimpleWorkflow using the specified AWS account credentials provider, executor service, and client configuration options.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

Method Detail

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this async client to execute requests.

Returns:

The executor service used by this async client to execute requests.

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() prior to calling this method.

Specified by:

shutdown in interface AmazonSimpleWorkflow

Overrides:

shutdown in class AmazonWebServiceClient

deprecateWorkflowTypeAsync

public Future<Void> deprecateWorkflowTypeAsync(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.

Specified by:

deprecateWorkflowTypeAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the DeprecateWorkflowType service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

deprecateDomainAsync

public Future<Void> deprecateDomainAsync(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.

Specified by:

deprecateDomainAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the DeprecateDomain service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

registerWorkflowTypeAsync

public Future<Void> registerWorkflowTypeAsync(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.

Specified by:

registerWorkflowTypeAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the RegisterWorkflowType service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

listWorkflowTypesAsync

public Future<WorkflowTypeInfos> listWorkflowTypesAsync(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.

Specified by:

listWorkflowTypesAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the ListWorkflowTypes service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

startWorkflowExecutionAsync

public Future<Run> startWorkflowExecutionAsync(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.

Specified by:

startWorkflowExecutionAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the StartWorkflowExecution service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

signalWorkflowExecutionAsync

public Future<Void> signalWorkflowExecutionAsync(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.

Specified by:

signalWorkflowExecutionAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the SignalWorkflowExecution service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

listDomainsAsync

public Future<DomainInfos> listDomainsAsync(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.

Specified by:

listDomainsAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the ListDomains service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

requestCancelWorkflowExecutionAsync

public Future<Void> requestCancelWorkflowExecutionAsync(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.

Specified by:

requestCancelWorkflowExecutionAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the RequestCancelWorkflowExecution service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

describeWorkflowTypeAsync

public Future<WorkflowTypeDetail> describeWorkflowTypeAsync(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.

Specified by:

describeWorkflowTypeAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the DescribeWorkflowType service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

deprecateActivityTypeAsync

public Future<Void> deprecateActivityTypeAsync(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.

Specified by:

deprecateActivityTypeAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the DeprecateActivityType service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

countClosedWorkflowExecutionsAsync

public Future<WorkflowExecutionCount> countClosedWorkflowExecutionsAsync(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.

Specified by:

countClosedWorkflowExecutionsAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the CountClosedWorkflowExecutions service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

countPendingActivityTasksAsync

public Future<PendingTaskCount> countPendingActivityTasksAsync(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.

Specified by:

countPendingActivityTasksAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the CountPendingActivityTasks service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

respondActivityTaskCanceledAsync

public Future<Void> respondActivityTaskCanceledAsync(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.

Specified by:

respondActivityTaskCanceledAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the RespondActivityTaskCanceled service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

respondDecisionTaskCompletedAsync

public Future<Void> respondDecisionTaskCompletedAsync(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.

Specified by:

respondDecisionTaskCompletedAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the RespondDecisionTaskCompleted service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

respondActivityTaskCompletedAsync

public Future<Void> respondActivityTaskCompletedAsync(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.

Specified by:

respondActivityTaskCompletedAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the RespondActivityTaskCompleted service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

pollForActivityTaskAsync

public Future<ActivityTask> pollForActivityTaskAsync(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).

Specified by:

pollForActivityTaskAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the PollForActivityTask service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

countOpenWorkflowExecutionsAsync

public Future<WorkflowExecutionCount> countOpenWorkflowExecutionsAsync(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.

Specified by:

countOpenWorkflowExecutionsAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the CountOpenWorkflowExecutions service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

describeActivityTypeAsync

public Future<ActivityTypeDetail> describeActivityTypeAsync(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.

Specified by:

describeActivityTypeAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the DescribeActivityType service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

listOpenWorkflowExecutionsAsync

public Future<WorkflowExecutionInfos> listOpenWorkflowExecutionsAsync(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.

Specified by:

listOpenWorkflowExecutionsAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the ListOpenWorkflowExecutions service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

getWorkflowExecutionHistoryAsync

public Future<History> getWorkflowExecutionHistoryAsync(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.

Specified by:

getWorkflowExecutionHistoryAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the GetWorkflowExecutionHistory service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

registerDomainAsync

public Future<Void> registerDomainAsync(RegisterDomainRequest registerDomainRequest)
                                 throws AmazonServiceException,
                                        AmazonClientException

Registers a new domain.

Specified by:

registerDomainAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the RegisterDomain service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

registerActivityTypeAsync

public Future<Void> registerActivityTypeAsync(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.

Specified by:

registerActivityTypeAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the RegisterActivityType service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

listClosedWorkflowExecutionsAsync

public Future<WorkflowExecutionInfos> listClosedWorkflowExecutionsAsync(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.

Specified by:

listClosedWorkflowExecutionsAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the ListClosedWorkflowExecutions service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

recordActivityTaskHeartbeatAsync

public Future<ActivityTaskStatus> recordActivityTaskHeartbeatAsync(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.

Specified by:

recordActivityTaskHeartbeatAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the RecordActivityTaskHeartbeat service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

pollForDecisionTaskAsync

public Future<DecisionTask> pollForDecisionTaskAsync(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.

Specified by:

pollForDecisionTaskAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the PollForDecisionTask service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

listActivityTypesAsync

public Future<ActivityTypeInfos> listActivityTypesAsync(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.

Specified by:

listActivityTypesAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the ListActivityTypes service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

describeDomainAsync

public Future<DomainDetail> describeDomainAsync(DescribeDomainRequest describeDomainRequest)
                                         throws AmazonServiceException,
                                                AmazonClientException

Returns information about the specified domain including description and status.

Specified by:

describeDomainAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the DescribeDomain service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

respondActivityTaskFailedAsync

public Future<Void> respondActivityTaskFailedAsync(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.

Specified by:

respondActivityTaskFailedAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the RespondActivityTaskFailed service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

countPendingDecisionTasksAsync

public Future<PendingTaskCount> countPendingDecisionTasksAsync(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.

Specified by:

countPendingDecisionTasksAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the CountPendingDecisionTasks service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

terminateWorkflowExecutionAsync

public Future<Void> terminateWorkflowExecutionAsync(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.

Specified by:

terminateWorkflowExecutionAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the TerminateWorkflowExecution service method, as returned by AmazonSimpleWorkflow.

Throws:

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.

describeWorkflowExecutionAsync

public Future<WorkflowExecutionDetail> describeWorkflowExecutionAsync(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.

Specified by:

describeWorkflowExecutionAsync in interface AmazonSimpleWorkflowAsync

Parameters:

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

Returns:

A Java Future object containing the response from the DescribeWorkflowExecution service method, as returned by AmazonSimpleWorkflow.

Throws:

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.