public class AbstractAmazonSimpleWorkflow extends Object implements AmazonSimpleWorkflow
AmazonSimpleWorkflow. Convenient method
 forms pass through to the corresponding overload that takes a request object,
 which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description | 
|---|---|
| WorkflowExecutionCount | countClosedWorkflowExecutions(CountClosedWorkflowExecutionsRequest request)
 Returns the number of closed workflow executions within the given domain
 that meet the specified filtering criteria. | 
| WorkflowExecutionCount | countOpenWorkflowExecutions(CountOpenWorkflowExecutionsRequest request)
 Returns the number of open workflow executions within the given domain
 that meet the specified filtering criteria. | 
| PendingTaskCount | countPendingActivityTasks(CountPendingActivityTasksRequest request)
 Returns the estimated number of activity tasks in the specified task
 list. | 
| PendingTaskCount | countPendingDecisionTasks(CountPendingDecisionTasksRequest request)
 Returns the estimated number of decision tasks in the specified task
 list. | 
| void | deprecateActivityType(DeprecateActivityTypeRequest request)
 Deprecates the specified activity type. | 
| void | deprecateDomain(DeprecateDomainRequest request)
 Deprecates the specified domain. | 
| void | deprecateWorkflowType(DeprecateWorkflowTypeRequest request)
 Deprecates the specified workflow type. | 
| ActivityTypeDetail | describeActivityType(DescribeActivityTypeRequest request)
 Returns information about the specified activity type. | 
| DomainDetail | describeDomain(DescribeDomainRequest request)
 Returns information about the specified domain, including description and
 status. | 
| WorkflowExecutionDetail | describeWorkflowExecution(DescribeWorkflowExecutionRequest request)
 Returns information about the specified workflow execution including its
 type and some statistics. | 
| WorkflowTypeDetail | describeWorkflowType(DescribeWorkflowTypeRequest request)
 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 request)
 Returns the history of the specified workflow execution. | 
| ActivityTypeInfos | listActivityTypes(ListActivityTypesRequest request)
 Returns information about all activities registered in the specified
 domain that match the specified name and registration status. | 
| WorkflowExecutionInfos | listClosedWorkflowExecutions(ListClosedWorkflowExecutionsRequest request)
 Returns a list of closed workflow executions in the specified domain that
 meet the filtering criteria. | 
| DomainInfos | listDomains(ListDomainsRequest request)
 Returns the list of domains registered in the account. | 
| WorkflowExecutionInfos | listOpenWorkflowExecutions(ListOpenWorkflowExecutionsRequest request)
 Returns a list of open workflow executions in the specified domain that
 meet the filtering criteria. | 
| WorkflowTypeInfos | listWorkflowTypes(ListWorkflowTypesRequest request)
 Returns information about workflow types in the specified domain. | 
| ActivityTask | pollForActivityTask(PollForActivityTaskRequest request)
 Used by workers to get an ActivityTask from the specified activity
  taskList. | 
| DecisionTask | pollForDecisionTask(PollForDecisionTaskRequest request)
 Used by deciders to get a DecisionTask from the specified decision
  taskList. | 
| ActivityTaskStatus | recordActivityTaskHeartbeat(RecordActivityTaskHeartbeatRequest request)
 Used by activity workers to report to the service that the
 ActivityTask represented by the specified  taskTokenis still making progress. | 
| void | registerActivityType(RegisterActivityTypeRequest request)
 Registers a new activity type along with its configuration
 settings in the specified domain. | 
| void | registerDomain(RegisterDomainRequest request)
 Registers a new domain. | 
| void | registerWorkflowType(RegisterWorkflowTypeRequest request)
 Registers a new workflow type and its configuration settings in
 the specified domain. | 
| void | requestCancelWorkflowExecution(RequestCancelWorkflowExecutionRequest request)
 Records a  WorkflowExecutionCancelRequestedevent in the
 currently running workflow execution identified by the given domain,
 workflowId, and runId. | 
| void | respondActivityTaskCanceled(RespondActivityTaskCanceledRequest request)
 Used by workers to tell the service that the ActivityTask
 identified by the  taskTokenwas successfully canceled. | 
| void | respondActivityTaskCompleted(RespondActivityTaskCompletedRequest request)
 Used by workers to tell the service that the ActivityTask
 identified by the  taskTokencompleted successfully with aresult(if provided). | 
| void | respondActivityTaskFailed(RespondActivityTaskFailedRequest request)
 Used by workers to tell the service that the ActivityTask
 identified by the  taskTokenhas failed withreason(if specified). | 
| void | respondDecisionTaskCompleted(RespondDecisionTaskCompletedRequest request)
 Used by deciders to tell the service that the DecisionTask
 identified by the  taskTokenhas successfully completed. | 
| void | setEndpoint(String endpoint)Overrides the default endpoint for this client
 ("swf.us-east-1.amazonaws.com"). | 
| void | setRegion(Region region)An alternative to  AmazonSimpleWorkflow.setEndpoint(String), sets
 the regional endpoint for this client's service calls. | 
| void | shutdown()Shuts down this client object, releasing any resources that might be held
 open. | 
| void | signalWorkflowExecution(SignalWorkflowExecutionRequest request)
 Records a  WorkflowExecutionSignaledevent 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 request)
 Starts an execution of the workflow type in the specified domain using
 the provided  workflowIdand input data. | 
| void | terminateWorkflowExecution(TerminateWorkflowExecutionRequest request)
 Records a  WorkflowExecutionTerminatedevent and forces
 closure of the workflow execution identified by the given domain, runId,
 and workflowId. | 
public void setEndpoint(String endpoint)
AmazonSimpleWorkflow
 Callers can pass in just the endpoint (ex: "swf.us-east-1.amazonaws.com")
 or a full URL, including the protocol (ex:
 "swf.us-east-1.amazonaws.com"). If the protocol is not specified here,
 the default protocol from this client's ClientConfiguration will
 be used, which by default is HTTPS.
 
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint in interface AmazonSimpleWorkflowendpoint - The endpoint (ex: "swf.us-east-1.amazonaws.com") or a full URL,
        including the protocol (ex: "swf.us-east-1.amazonaws.com") of the
        region specific AWS endpoint this client will communicate with.public void setRegion(Region region)
AmazonSimpleWorkflowAmazonSimpleWorkflow.setEndpoint(String), sets
 the regional endpoint for this client's service calls. Callers can use
 this method to control which AWS region they want to work with.
 
 By default, all service endpoints in all regions use the https protocol.
 To use http instead, specify it in the ClientConfiguration
 supplied at construction.
 
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion in interface AmazonSimpleWorkflowregion - The region this client will communicate with. See
        Region.getRegion(com.amazonaws.regions.Regions) for
        accessing a given region. Must not be null and must be a region
        where the service is available.Region.getRegion(com.amazonaws.regions.Regions), 
Region.createClient(Class,
      com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), 
Region.isServiceSupported(String)public WorkflowExecutionCount countClosedWorkflowExecutions(CountClosedWorkflowExecutionsRequest request)
AmazonSimpleWorkflowReturns the number of closed workflow executions within the given domain that meet the specified filtering criteria.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the
 action to only specified domains.Action element to allow or deny permission to
 call this action.Condition
 element with the appropriate keys.
 tagFilter.tag: String constraint. The key is
 swf:tagFilter.tag.typeFilter.name: String constraint. The key is
 swf:typeFilter.name.typeFilter.version: String constraint. The key is
 swf:typeFilter.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
countClosedWorkflowExecutions in interface AmazonSimpleWorkflowpublic WorkflowExecutionCount countOpenWorkflowExecutions(CountOpenWorkflowExecutionsRequest request)
AmazonSimpleWorkflowReturns the number of open workflow executions within the given domain that meet the specified filtering criteria.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the
 action to only specified domains.Action element to allow or deny permission to
 call this action.Condition
 element with the appropriate keys.
 tagFilter.tag: String constraint. The key is
 swf:tagFilter.tag.typeFilter.name: String constraint. The key is
 swf:typeFilter.name.typeFilter.version: String constraint. The key is
 swf:typeFilter.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
countOpenWorkflowExecutions in interface AmazonSimpleWorkflowpublic PendingTaskCount countPendingActivityTasks(CountPendingActivityTasksRequest request)
AmazonSimpleWorkflowReturns 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:
Resource element with the domain name to limit the
 action to only specified domains.Action element to allow or deny permission to
 call this action.taskList.name parameter by using a
 Condition element with the swf:taskList.name key to
 allow the action to access only certain task lists.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
countPendingActivityTasks in interface AmazonSimpleWorkflowpublic PendingTaskCount countPendingDecisionTasks(CountPendingDecisionTasksRequest request)
AmazonSimpleWorkflowReturns 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:
Resource element with the domain name to limit the
 action to only specified domains.Action element to allow or deny permission to
 call this action.taskList.name parameter by using a
 Condition element with the swf:taskList.name key to
 allow the action to access only certain task lists.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
countPendingDecisionTasks in interface AmazonSimpleWorkflowpublic void deprecateActivityType(DeprecateActivityTypeRequest request)
AmazonSimpleWorkflowDeprecates the specified activity type. After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type that were scheduled before the type was deprecated will continue to run.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the
 action to only specified domains.Action element to allow or deny permission to
 call this action.Condition
 element with the appropriate keys.
 activityType.name: String constraint. The key is
 swf:activityType.name.activityType.version: String constraint. The key is
 swf:activityType.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
deprecateActivityType in interface AmazonSimpleWorkflowpublic void deprecateDomain(DeprecateDomainRequest request)
AmazonSimpleWorkflowDeprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain. Executions that were started before the domain was deprecated will continue to run.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the
 action to only specified domains.Action element to allow or deny permission to
 call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
deprecateDomain in interface AmazonSimpleWorkflowpublic void deprecateWorkflowType(DeprecateWorkflowTypeRequest request)
AmazonSimpleWorkflowDeprecates the specified workflow type. After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated will continue to run. A deprecated workflow type may still be used when calling visibility actions.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the
 action to only specified domains.Action element to allow or deny permission to
 call this action.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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
deprecateWorkflowType in interface AmazonSimpleWorkflowpublic ActivityTypeDetail describeActivityType(DescribeActivityTypeRequest request)
AmazonSimpleWorkflowReturns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the
 action to only specified domains.Action element to allow or deny permission to
 call this action.Condition
 element with the appropriate keys.
 activityType.name: String constraint. The key is
 swf:activityType.name.activityType.version: String constraint. The key is
 swf:activityType.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
describeActivityType in interface AmazonSimpleWorkflowpublic DomainDetail describeDomain(DescribeDomainRequest request)
AmazonSimpleWorkflowReturns 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:
Resource element with the domain name to limit the
 action to only specified domains.Action element to allow or deny permission to
 call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
describeDomain in interface AmazonSimpleWorkflowpublic WorkflowExecutionDetail describeWorkflowExecution(DescribeWorkflowExecutionRequest request)
AmazonSimpleWorkflowReturns information about the specified workflow execution including its type and some statistics.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the
 action to only specified domains.Action element to allow or deny permission to
 call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
describeWorkflowExecution in interface AmazonSimpleWorkflowpublic WorkflowTypeDetail describeWorkflowType(DescribeWorkflowTypeRequest request)
AmazonSimpleWorkflowReturns information about the specified workflow type. This includes configuration settings specified when the type was registered and other information such as creation date, current status, and so on.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the
 action to only specified domains.Action element to allow or deny permission to
 call this action.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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
describeWorkflowType in interface AmazonSimpleWorkflowpublic History getWorkflowExecutionHistory(GetWorkflowExecutionHistoryRequest request)
AmazonSimpleWorkflow
 Returns the history of the specified workflow execution. The results may
 be split into multiple pages. To retrieve subsequent pages, make the call
 again using the nextPageToken returned by the initial call.
 
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the
 action to only specified domains.Action element to allow or deny permission to
 call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
getWorkflowExecutionHistory in interface AmazonSimpleWorkflowpublic ActivityTypeInfos listActivityTypes(ListActivityTypesRequest request)
AmazonSimpleWorkflow
 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:
Resource element with the domain name to limit the
 action to only specified domains.Action element to allow or deny permission to
 call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
listActivityTypes in interface AmazonSimpleWorkflowpublic WorkflowExecutionInfos listClosedWorkflowExecutions(ListClosedWorkflowExecutionsRequest request)
AmazonSimpleWorkflowReturns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the
 action to only specified domains.Action element to allow or deny permission to
 call this action.Condition
 element with the appropriate keys.
 tagFilter.tag: String constraint. The key is
 swf:tagFilter.tag.typeFilter.name: String constraint. The key is
 swf:typeFilter.name.typeFilter.version: String constraint. The key is
 swf:typeFilter.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
listClosedWorkflowExecutions in interface AmazonSimpleWorkflowpublic DomainInfos listDomains(ListDomainsRequest request)
AmazonSimpleWorkflowReturns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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.Action element to allow or deny permission to
 call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
listDomains in interface AmazonSimpleWorkflowpublic WorkflowExecutionInfos listOpenWorkflowExecutions(ListOpenWorkflowExecutionsRequest request)
AmazonSimpleWorkflowReturns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the
 action to only specified domains.Action element to allow or deny permission to
 call this action.Condition
 element with the appropriate keys.
 tagFilter.tag: String constraint. The key is
 swf:tagFilter.tag.typeFilter.name: String constraint. The key is
 swf:typeFilter.name.typeFilter.version: String constraint. The key is
 swf:typeFilter.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
listOpenWorkflowExecutions in interface AmazonSimpleWorkflowpublic WorkflowTypeInfos listWorkflowTypes(ListWorkflowTypesRequest request)
AmazonSimpleWorkflowReturns 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:
Resource element with the domain name to limit the
 action to only specified domains.Action element to allow or deny permission to
 call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
listWorkflowTypes in interface AmazonSimpleWorkflowpublic ActivityTask pollForActivityTask(PollForActivityTaskRequest request)
AmazonSimpleWorkflow
 Used by workers to get an ActivityTask from the specified activity
 taskList. This initiates a long poll, where the service
 holds the HTTP connection open and responds as soon as a task becomes
 available. The maximum time the service holds on to the request before
 responding is 60 seconds. If no task is available within 60 seconds, the
 poll will return an empty result. An empty result, in this context, means
 that an ActivityTask is returned, but that the value of taskToken is an
 empty string. If a task is returned, the worker should use its type to
 identify and process it correctly.
 
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the
 action to only specified domains.Action element to allow or deny permission to
 call this action.taskList.name parameter by using a
 Condition element with the swf:taskList.name key to
 allow the action to access only certain task lists.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
pollForActivityTask in interface AmazonSimpleWorkflowpublic DecisionTask pollForDecisionTask(PollForDecisionTaskRequest request)
AmazonSimpleWorkflow
 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.
 
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:
Resource element with the domain name to limit the
 action to only specified domains.Action element to allow or deny permission to
 call this action.taskList.name parameter by using a
 Condition element with the swf:taskList.name key to
 allow the action to access only certain task lists.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
pollForDecisionTask in interface AmazonSimpleWorkflowpublic ActivityTaskStatus recordActivityTaskHeartbeat(RecordActivityTaskHeartbeatRequest request)
AmazonSimpleWorkflow
 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.
 
taskStartToCloseTimeout of an activity type is the
 maximum duration of an activity task, regardless of the number of
 RecordActivityTaskHeartbeat requests received. The
 taskStartToCloseTimeout is also specified in
 RegisterActivityType.cancelRequested flag returns true, a
 cancellation is being attempted. If the worker can cancel the activity,
 it should respond with RespondActivityTaskCanceled. Otherwise, it
 should ignore the cancellation request.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the
 action to only specified domains.Action element to allow or deny permission to
 call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
recordActivityTaskHeartbeat in interface AmazonSimpleWorkflowpublic void registerActivityType(RegisterActivityTypeRequest request)
AmazonSimpleWorkflowRegisters a new activity type along with its configuration settings in the specified domain.
TypeAlreadyExists fault is returned if the type
 already exists in the domain. You cannot change any configuration
 settings of the type after its registration, and it must be registered as
 a new version.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the
 action to only specified domains.Action element to allow or deny permission to
 call this action.Condition
 element with the appropriate keys.
 defaultTaskList.name: String constraint. The key is
 swf:defaultTaskList.name.name: String constraint. The key is
 swf:name.version: String constraint. The key is
 swf:version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
registerActivityType in interface AmazonSimpleWorkflowpublic void registerDomain(RegisterDomainRequest request)
AmazonSimpleWorkflowRegisters a new domain.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Action element to allow or deny permission to
 call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
registerDomain in interface AmazonSimpleWorkflowpublic void registerWorkflowType(RegisterWorkflowTypeRequest request)
AmazonSimpleWorkflowRegisters a new workflow type and its configuration settings in the specified domain.
The retention period for the workflow history is set by the RegisterDomain action.
TypeAlreadyExists fault is returned. You cannot change the
 configuration settings of a workflow type once it is registered and it
 must be registered as a new version.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the
 action to only specified domains.Action element to allow or deny permission to
 call this action.Condition
 element with the appropriate keys.
 defaultTaskList.name: String constraint. The key is
 swf:defaultTaskList.name.name: String constraint. The key is
 swf:name.version: String constraint. The key is
 swf:version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
registerWorkflowType in interface AmazonSimpleWorkflowpublic void requestCancelWorkflowExecution(RequestCancelWorkflowExecutionRequest request)
AmazonSimpleWorkflow
 Records a WorkflowExecutionCancelRequested event in the
 currently running workflow execution identified by the given domain,
 workflowId, and runId. This logically requests the cancellation of the
 workflow execution as a whole. It is up to the decider to take
 appropriate actions when it receives an execution history with this
 event.
 
WorkflowExecutionCancelRequested event is recorded in the
 history of the current open workflow execution with the specified
 workflowId in the domain.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the
 action to only specified domains.Action element to allow or deny permission to
 call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
requestCancelWorkflowExecution in interface AmazonSimpleWorkflowpublic void respondActivityTaskCanceled(RespondActivityTaskCanceledRequest request)
AmazonSimpleWorkflow
 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.
 
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:
Resource element with the domain name to limit the
 action to only specified domains.Action element to allow or deny permission to
 call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
respondActivityTaskCanceled in interface AmazonSimpleWorkflowpublic void respondActivityTaskCompleted(RespondActivityTaskCompletedRequest request)
AmazonSimpleWorkflow
 Used by workers to tell the service that the ActivityTask
 identified by the taskToken completed successfully with a
 result (if provided). The result appears in the
 ActivityTaskCompleted event in the workflow history.
 
canceled flag returned by
 RecordActivityTaskHeartbeat, it should cancel the task, clean up
 and then call RespondActivityTaskCanceled.A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the
 action to only specified domains.Action element to allow or deny permission to
 call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
respondActivityTaskCompleted in interface AmazonSimpleWorkflowpublic void respondActivityTaskFailed(RespondActivityTaskFailedRequest request)
AmazonSimpleWorkflow
 Used by workers to tell the service that the ActivityTask
 identified by the taskToken has failed with
 reason (if specified). The reason and
 details appear in the ActivityTaskFailed event
 added to the workflow history.
 
A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the
 action to only specified domains.Action element to allow or deny permission to
 call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
respondActivityTaskFailed in interface AmazonSimpleWorkflowpublic void respondDecisionTaskCompleted(RespondDecisionTaskCompletedRequest request)
AmazonSimpleWorkflow
 Used by deciders to tell the service that the DecisionTask
 identified by the taskToken has successfully completed. The
 decisions argument specifies the list of decisions made
 while processing the task.
 
 A DecisionTaskCompleted event is added to the workflow
 history. The executionContext specified is attached to the
 event in the workflow execution history.
 
Access Control
 If an IAM policy grants permission to use
 RespondDecisionTaskCompleted, it can express permissions for
 the list of decisions in the decisions parameter. Each of
 the decisions has one or more parameters, much like a regular API call.
 To allow for policies to be as readable as possible, you can express
 permissions on decisions as if they were actual API calls, including
 applying conditions to some parameters. For more information, see Using IAM to Manage Access to Amazon SWF Workflows.
 
respondDecisionTaskCompleted in interface AmazonSimpleWorkflowpublic void signalWorkflowExecution(SignalWorkflowExecutionRequest request)
AmazonSimpleWorkflow
 Records a WorkflowExecutionSignaled event in the workflow
 execution history and creates a decision task for the workflow execution
 identified by the given domain, workflowId and runId. The event is
 recorded with the specified user defined signalName and input (if
 provided).
 
WorkflowExecutionSignaled event is recorded in the history
 of the current open workflow with the matching workflowId in the
 domain.UnknownResource.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the
 action to only specified domains.Action element to allow or deny permission to
 call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
signalWorkflowExecution in interface AmazonSimpleWorkflowpublic Run startWorkflowExecution(StartWorkflowExecutionRequest request)
AmazonSimpleWorkflow
 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:
Resource element with the domain name to limit the
 action to only specified domains.Action element to allow or deny permission to
 call this action.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.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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
startWorkflowExecution in interface AmazonSimpleWorkflowpublic void terminateWorkflowExecution(TerminateWorkflowExecutionRequest request)
AmazonSimpleWorkflow
 Records a WorkflowExecutionTerminated event and forces
 closure of the workflow execution identified by the given domain, runId,
 and workflowId. The child policy, registered with the workflow type or
 specified when starting this execution, is applied to any open child
 workflow executions of this workflow execution.
 
WorkflowExecutionTerminated event is recorded in
 the history of the current open workflow with the matching workflowId in
 the domain.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the
 action to only specified domains.Action element to allow or deny permission to
 call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
terminateWorkflowExecution in interface AmazonSimpleWorkflowpublic void shutdown()
AmazonSimpleWorkflowshutdown in interface AmazonSimpleWorkflowpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonSimpleWorkflowResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AmazonSimpleWorkflowrequest - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.