AmazonSimpleWorkflowClient (AWS SDK for Java

Overview

Package

Class

Index

Help

Did this page help you?
Yes No Tell us about it...

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.simpleworkflow
Class AmazonSimpleWorkflowClient

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

All Implemented Interfaces:: AmazonSimpleWorkflow

Direct Known Subclasses:: AmazonSimpleWorkflowAsyncClient

public class AmazonSimpleWorkflowClient
extends AmazonWebServiceClient
implements AmazonSimpleWorkflow
extends AmazonWebServiceClient
implements AmazonSimpleWorkflow

Client for accessing AmazonSimpleWorkflow. All service calls made using this client are blocking, and will not return until the service call completes.

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
`AmazonSimpleWorkflowClient()` Constructs a new client to invoke service methods on AmazonSimpleWorkflow.
`AmazonSimpleWorkflowClient(AWSCredentials awsCredentials)` Constructs a new client to invoke service methods on AmazonSimpleWorkflow using the specified AWS account credentials.
`AmazonSimpleWorkflowClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on AmazonSimpleWorkflow using the specified AWS account credentials and client configuration options.
`AmazonSimpleWorkflowClient(AWSCredentialsProvider awsCredentialsProvider)` Constructs a new client to invoke service methods on AmazonSimpleWorkflow using the specified AWS account credentials provider.
`AmazonSimpleWorkflowClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on AmazonSimpleWorkflow using the specified AWS account credentials provider and client configuration options.
`AmazonSimpleWorkflowClient(ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on AmazonSimpleWorkflow.

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

Methods inherited from class com.amazonaws.AmazonWebServiceClient
`addRequestHandler, getTimeOffset, removeRequestHandler, setConfiguration, setEndpoint, setRegion, setTimeOffset, shutdown, withTimeOffset`

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
`setEndpoint, setRegion, shutdown`

Constructor Detail

AmazonSimpleWorkflowClient

public AmazonSimpleWorkflowClient()

Constructs a new 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

AmazonSimpleWorkflowClient

public AmazonSimpleWorkflowClient(ClientConfiguration clientConfiguration)

Constructs a new 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

AmazonSimpleWorkflowClient

public AmazonSimpleWorkflowClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AmazonSimpleWorkflow using the specified AWS account credentials.

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

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

AmazonSimpleWorkflowClient

public AmazonSimpleWorkflowClient(AWSCredentials awsCredentials,
                                  ClientConfiguration clientConfiguration)

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

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

Parameters:: awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.; clientConfiguration - The client configuration options controlling how this client connects to AmazonSimpleWorkflow (ex: proxy settings, retry counts, etc.).

AmazonSimpleWorkflowClient

public AmazonSimpleWorkflowClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AmazonSimpleWorkflow using the specified AWS account credentials provider.

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

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

AmazonSimpleWorkflowClient

public AmazonSimpleWorkflowClient(AWSCredentialsProvider awsCredentialsProvider,
                                  ClientConfiguration clientConfiguration)

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

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

Parameters:: awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.; clientConfiguration - The client configuration options controlling how this client connects to AmazonSimpleWorkflow (ex: proxy settings, retry counts, etc.).

Method Detail

deprecateWorkflowType

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
- workflowType.name : String constraint. The key is swf:workflowType.name .
- workflowType.version : String constraint. The key is swf:workflowType.version .

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

Specified by:: deprecateWorkflowType in interface AmazonSimpleWorkflow

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

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

Specified by:: deprecateDomain in interface AmazonSimpleWorkflow

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

public void registerWorkflowType(RegisterWorkflowTypeRequest registerWorkflowTypeRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

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

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

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
- defaultTaskList : String constraint. The key is swf:defaultTaskList.name .
- name : String constraint. The key is swf:name .
- version : String constraint. The key is swf:version .

Specified by:: registerWorkflowType in interface AmazonSimpleWorkflow

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

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

Specified by:: listWorkflowTypes in interface AmazonSimpleWorkflow

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

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
- tagList.member.0 : The key is swf:tagList.member.0 .
- tagList.member.1 : The key is swf:tagList.member.1 .
- tagList.member.2 : The key is swf:tagList.member.2 .
- tagList.member.3 : The key is swf:tagList.member.3 .
- tagList.member.4 : The key is swf:tagList.member.4 .
- taskList : String constraint. The key is swf:taskList.name .
- name : String constraint. The key is swf:workflowType.name .
- version : String constraint. The key is swf:workflowType.version .

Specified by:: startWorkflowExecution in interface AmazonSimpleWorkflow

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

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

Specified by:: signalWorkflowExecution in interface AmazonSimpleWorkflow

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

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains. The element must be set to arn:aws:swf::AccountID:domain/*" , where ???AccountID" is the account ID, with no dashes.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

Specified by:: listDomains in interface AmazonSimpleWorkflow

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

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

Specified by:: requestCancelWorkflowExecution in interface AmazonSimpleWorkflow

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

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
- workflowType.name : String constraint. The key is swf:workflowType.name .
- workflowType.version : String constraint. The key is swf:workflowType.version .

Specified by:: describeWorkflowType in interface AmazonSimpleWorkflow

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

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
- activityType.name : String constraint. The key is swf:activityType.name .
- activityType.version : String constraint. The key is swf:activityType.version .

Specified by:: deprecateActivityType in interface AmazonSimpleWorkflow

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

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
- tag : String constraint. The key is swf:tagFilter.tag .
- typeFilter.name : String constraint. String constraint. The key is swf:typeFilter.name .
- typeFilter.version : String constraint. String constraint. The key is swf:typeFilter.version .

Specified by:: countClosedWorkflowExecutions in interface AmazonSimpleWorkflow

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

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Use a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

Specified by:: countPendingActivityTasks in interface AmazonSimpleWorkflow

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

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

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

Specified by:: respondActivityTaskCanceled in interface AmazonSimpleWorkflow

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

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

Access Control

If an IAM policy grants permission to use RespondDecisionTaskCompleted , it can express permissions for the list of decisions in the decisions parameter in the same way as for the regular API. This approach maintains a uniform conceptual model and helps keep policies readable. For more information, see Using IAM to Manage Access to Amazon SWF Workflows .

Specified by:: respondDecisionTaskCompleted in interface AmazonSimpleWorkflow

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

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

Specified by:: respondActivityTaskCompleted in interface AmazonSimpleWorkflow

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

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Use a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

Specified by:: pollForActivityTask in interface AmazonSimpleWorkflow

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

countOpenWorkflowExecutions

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
- tag : String constraint. The key is swf:tagFilter.tag .
- typeFilter.name : String constraint. String constraint. The key is swf:typeFilter.name .
- typeFilter.version : String constraint. String constraint. The key is swf:typeFilter.version .

Specified by:: countOpenWorkflowExecutions in interface AmazonSimpleWorkflow

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

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
- activityType.name : String constraint. The key is swf:activityType.name .
- activityType.version : String constraint. The key is swf:activityType.version .

Specified by:: describeActivityType in interface AmazonSimpleWorkflow

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

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
- tag : String constraint. The key is swf:tagFilter.tag .
- typeFilter.name : String constraint. String constraint. The key is swf:typeFilter.name .
- typeFilter.version : String constraint. String constraint. The key is swf:typeFilter.version .

Specified by:: listOpenWorkflowExecutions in interface AmazonSimpleWorkflow

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

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

Specified by:: getWorkflowExecutionHistory in interface AmazonSimpleWorkflow

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

public void registerDomain(RegisterDomainRequest registerDomainRequest)
                    throws AmazonServiceException,
                           AmazonClientException

Registers a new domain.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

You cannot use an IAM policy to control domain access for this action. The name of the domain being registered is available as the resource of this action.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

Specified by:: registerDomain in interface AmazonSimpleWorkflow

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

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
- defaultTaskList : String constraint. The key is swf:defaultTaskList.name .
- name : String constraint. The key is swf:name .
- version : String constraint. The key is swf:version .

Specified by:: registerActivityType in interface AmazonSimpleWorkflow

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

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Constrain the following parameters by using a Condition element with the appropriate keys.
- tag : String constraint. The key is swf:tagFilter.tag .
- typeFilter.name : String constraint. String constraint. The key is swf:typeFilter.name .
- typeFilter.version : String constraint. String constraint. The key is swf:typeFilter.version .

Specified by:: listClosedWorkflowExecutions in interface AmazonSimpleWorkflow

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

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

Specified by:: recordActivityTaskHeartbeat in interface AmazonSimpleWorkflow

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

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Use a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

Specified by:: pollForDecisionTask in interface AmazonSimpleWorkflow

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

listActivityTypes

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

Specified by:: listActivityTypes in interface AmazonSimpleWorkflow

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

public DomainDetail describeDomain(DescribeDomainRequest describeDomainRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Returns information about the specified domain including description and status.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

Specified by:: describeDomain in interface AmazonSimpleWorkflow

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

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

Specified by:: respondActivityTaskFailed in interface AmazonSimpleWorkflow

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

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
Use a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

Specified by:: countPendingDecisionTasks in interface AmazonSimpleWorkflow

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

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

Specified by:: terminateWorkflowExecution in interface AmazonSimpleWorkflow

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

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

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

Specified by:: describeWorkflowExecution in interface AmazonSimpleWorkflow

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.

getCachedResponseMetadata

public 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 the request.

Specified by:: getCachedResponseMetadata in interface AmazonSimpleWorkflow

Parameters:: request - The originally executed request
Returns:: The response metadata for the specified request, or null if none is available.

Overview

Package

Class

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Did this page help you?

com.amazonaws.services.simpleworkflow Class AmazonSimpleWorkflowClient

AmazonSimpleWorkflowClient

AmazonSimpleWorkflowClient

AmazonSimpleWorkflowClient

AmazonSimpleWorkflowClient

AmazonSimpleWorkflowClient

AmazonSimpleWorkflowClient

deprecateWorkflowType

deprecateDomain

registerWorkflowType

listWorkflowTypes

startWorkflowExecution

signalWorkflowExecution

listDomains

requestCancelWorkflowExecution

describeWorkflowType

deprecateActivityType

countClosedWorkflowExecutions

countPendingActivityTasks

respondActivityTaskCanceled

respondDecisionTaskCompleted

respondActivityTaskCompleted

pollForActivityTask

countOpenWorkflowExecutions

describeActivityType

listOpenWorkflowExecutions

getWorkflowExecutionHistory

registerDomain

registerActivityType

listClosedWorkflowExecutions

recordActivityTaskHeartbeat

pollForDecisionTask

listActivityTypes

describeDomain

respondActivityTaskFailed

countPendingDecisionTasks

terminateWorkflowExecution

describeWorkflowExecution

getCachedResponseMetadata

com.amazonaws.services.simpleworkflow
Class AmazonSimpleWorkflowClient