public class AmazonSimpleWorkflowClient extends AmazonWebServiceClient implements AmazonSimpleWorkflow
Amazon Simple Workflow Service
The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to coordinate work across distributed components. In Amazon SWF, a task represents a logical unit of work that is performed by a component of your workflow. Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and concurrency in accordance with the logical flow of the application.
Amazon SWF gives you full control over implementing tasks and coordinating them without worrying about underlying complexities such as tracking their progress and maintaining their state.
This documentation serves as reference only. For a broader overview of the Amazon SWF programming model, see the Amazon SWF Developer Guide .
| Modifier and Type | Field and Description | 
|---|---|
| protected List<com.amazonaws.transform.JsonErrorUnmarshaller> | jsonErrorUnmarshallersList of exception unmarshallers for all AmazonSimpleWorkflow exceptions. | 
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset| Constructor and Description | 
|---|
| 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(AWSCredentialsProvider awsCredentialsProvider,
                          ClientConfiguration clientConfiguration,
                          RequestMetricCollector requestMetricCollector)Constructs a new client to invoke service methods on
 AmazonSimpleWorkflow using the specified AWS account credentials
 provider, client configuration options and request metric collector. | 
| AmazonSimpleWorkflowClient(ClientConfiguration clientConfiguration)Constructs a new client to invoke service methods on
 AmazonSimpleWorkflow. | 
| Modifier and Type | Method and Description | 
|---|---|
| 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  taskTokenis
 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  WorkflowExecutionCancelRequestedevent 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  taskTokenwas successfully canceled. | 
| void | respondActivityTaskCompleted(RespondActivityTaskCompletedRequest respondActivityTaskCompletedRequest)
 Used by workers to tell the service that the ActivityTask identified
 by the  taskTokencompleted successfully with aresult(if provided). | 
| void | respondActivityTaskFailed(RespondActivityTaskFailedRequest respondActivityTaskFailedRequest)
 Used by workers to tell the service that the ActivityTask identified
 by the  taskTokenhas failed withreason(if
 specified). | 
| void | respondDecisionTaskCompleted(RespondDecisionTaskCompletedRequest respondDecisionTaskCompletedRequest)
 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. | 
| void | setEndpoint(String endpoint,
           String serviceName,
           String regionId)An internal method that is not expected to be normally
 called except for AWS internal development purposes. | 
| void | signalWorkflowExecution(SignalWorkflowExecutionRequest signalWorkflowExecutionRequest)
 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 startWorkflowExecutionRequest)
 Starts an execution of the workflow type in the specified domain
 using the provided  workflowIdand input data. | 
| void | terminateWorkflowExecution(TerminateWorkflowExecutionRequest terminateWorkflowExecutionRequest)
 Records a  WorkflowExecutionTerminatedevent and forces
 closure of the workflow execution identified by the given domain,
 runId, and workflowId. | 
addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetRegion, shutdownprotected List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers
public AmazonSimpleWorkflowClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChainpublic AmazonSimpleWorkflowClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this
                       client connects to AmazonSimpleWorkflow
                       (ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChainpublic AmazonSimpleWorkflowClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use
                       when authenticating with AWS services.public AmazonSimpleWorkflowClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).public AmazonSimpleWorkflowClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials
            to authenticate requests with AWS services.public AmazonSimpleWorkflowClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).public AmazonSimpleWorkflowClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).requestMetricCollector - optional request metric collectorpublic void deprecateWorkflowType(DeprecateWorkflowTypeRequest deprecateWorkflowTypeRequest)
Deprecates the specified workflow type . After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated will continue to run. A deprecated workflow type may still be used when calling visibility actions.
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:
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 AmazonSimpleWorkflowdeprecateWorkflowTypeRequest - Container for the necessary
           parameters to execute the DeprecateWorkflowType service method on
           AmazonSimpleWorkflow.TypeDeprecatedExceptionOperationNotPermittedExceptionUnknownResourceExceptionAmazonClientException - 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.public void deprecateDomain(DeprecateDomainRequest deprecateDomainRequest)
Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain. Executions that were started before the domain was deprecated will continue to run.
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:
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 AmazonSimpleWorkflowdeprecateDomainRequest - Container for the necessary parameters
           to execute the DeprecateDomain service method on AmazonSimpleWorkflow.DomainDeprecatedExceptionOperationNotPermittedExceptionUnknownResourceExceptionAmazonClientException - 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.public void registerWorkflowType(RegisterWorkflowTypeRequest registerWorkflowTypeRequest)
Registers a new workflow type and its configuration settings in the specified domain.
The retention period for the workflow history is set by the RegisterDomain action.
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:
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 AmazonSimpleWorkflowregisterWorkflowTypeRequest - Container for the necessary
           parameters to execute the RegisterWorkflowType service method on
           AmazonSimpleWorkflow.OperationNotPermittedExceptionUnknownResourceExceptionTypeAlreadyExistsExceptionLimitExceededExceptionAmazonClientException - 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.public WorkflowTypeInfos listWorkflowTypes(ListWorkflowTypesRequest listWorkflowTypesRequest)
Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 AmazonSimpleWorkflowlistWorkflowTypesRequest - Container for the necessary parameters
           to execute the ListWorkflowTypes service method on
           AmazonSimpleWorkflow.OperationNotPermittedExceptionUnknownResourceExceptionAmazonClientException - 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.public Run startWorkflowExecution(StartWorkflowExecutionRequest startWorkflowExecutionRequest)
 Starts an execution of the workflow type in the specified domain
 using the provided workflowId and input data.
 
This action returns the newly started workflow execution.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 AmazonSimpleWorkflowstartWorkflowExecutionRequest - Container for the necessary
           parameters to execute the StartWorkflowExecution service method on
           AmazonSimpleWorkflow.TypeDeprecatedExceptionOperationNotPermittedExceptionDefaultUndefinedExceptionUnknownResourceExceptionWorkflowExecutionAlreadyStartedExceptionLimitExceededExceptionAmazonClientException - 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.public 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. 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:
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 AmazonSimpleWorkflowsignalWorkflowExecutionRequest - Container for the necessary
           parameters to execute the SignalWorkflowExecution service method on
           AmazonSimpleWorkflow.OperationNotPermittedExceptionUnknownResourceExceptionAmazonClientException - 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.public DomainInfos listDomains(ListDomainsRequest listDomainsRequest)
Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
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:
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 AmazonSimpleWorkflowlistDomainsRequest - Container for the necessary parameters to
           execute the ListDomains service method on AmazonSimpleWorkflow.OperationNotPermittedExceptionAmazonClientException - 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.public void requestCancelWorkflowExecution(RequestCancelWorkflowExecutionRequest requestCancelWorkflowExecutionRequest)
 Records a WorkflowExecutionCancelRequested event in the
 currently running workflow execution identified by the given domain,
 workflowId, and runId. This logically requests the cancellation of the
 workflow execution as a whole. It is up to the decider to take
 appropriate actions when it receives an execution history with this
 event.
 
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:
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 AmazonSimpleWorkflowrequestCancelWorkflowExecutionRequest - Container for the
           necessary parameters to execute the RequestCancelWorkflowExecution
           service method on AmazonSimpleWorkflow.OperationNotPermittedExceptionUnknownResourceExceptionAmazonClientException - 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.public WorkflowTypeDetail describeWorkflowType(DescribeWorkflowTypeRequest describeWorkflowTypeRequest)
Returns information about the specified workflow type . This includes configuration settings specified when the type was registered and other information such as creation date, current status, etc.
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 AmazonSimpleWorkflowdescribeWorkflowTypeRequest - Container for the necessary
           parameters to execute the DescribeWorkflowType service method on
           AmazonSimpleWorkflow.OperationNotPermittedExceptionUnknownResourceExceptionAmazonClientException - 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.public void deprecateActivityType(DeprecateActivityTypeRequest deprecateActivityTypeRequest)
Deprecates the specified activity type . After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type that were scheduled before the type was deprecated will continue to run.
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:
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 AmazonSimpleWorkflowdeprecateActivityTypeRequest - Container for the necessary
           parameters to execute the DeprecateActivityType service method on
           AmazonSimpleWorkflow.TypeDeprecatedExceptionOperationNotPermittedExceptionUnknownResourceExceptionAmazonClientException - 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.public WorkflowExecutionCount countClosedWorkflowExecutions(CountClosedWorkflowExecutionsRequest countClosedWorkflowExecutionsRequest)
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:
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 AmazonSimpleWorkflowcountClosedWorkflowExecutionsRequest - Container for the
           necessary parameters to execute the CountClosedWorkflowExecutions
           service method on AmazonSimpleWorkflow.OperationNotPermittedExceptionUnknownResourceExceptionAmazonClientException - 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.public PendingTaskCount countPendingActivityTasks(CountPendingActivityTasksRequest countPendingActivityTasksRequest)
Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 will be returned.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 AmazonSimpleWorkflowcountPendingActivityTasksRequest - Container for the necessary
           parameters to execute the CountPendingActivityTasks service method on
           AmazonSimpleWorkflow.OperationNotPermittedExceptionUnknownResourceExceptionAmazonClientException - 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.public void respondActivityTaskCanceled(RespondActivityTaskCanceledRequest respondActivityTaskCanceledRequest)
 Used by workers to tell the service that the ActivityTask identified
 by the taskToken was successfully canceled. Additional
 details can be optionally provided using the
 details argument.
 
 These 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:
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 AmazonSimpleWorkflowrespondActivityTaskCanceledRequest - Container for the necessary
           parameters to execute the RespondActivityTaskCanceled service method
           on AmazonSimpleWorkflow.OperationNotPermittedExceptionUnknownResourceExceptionAmazonClientException - 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.public void respondDecisionTaskCompleted(RespondDecisionTaskCompletedRequest respondDecisionTaskCompletedRequest)
 Used by deciders to tell the service that the DecisionTask identified
 by the taskToken has successfully completed. The
 decisions argument specifies the list of decisions made
 while processing the task.
 
 A 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 AmazonSimpleWorkflowrespondDecisionTaskCompletedRequest - Container for the necessary
           parameters to execute the RespondDecisionTaskCompleted service method
           on AmazonSimpleWorkflow.OperationNotPermittedExceptionUnknownResourceExceptionAmazonClientException - 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.public 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). 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.
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 AmazonSimpleWorkflowrespondActivityTaskCompletedRequest - Container for the necessary
           parameters to execute the RespondActivityTaskCompleted service method
           on AmazonSimpleWorkflow.OperationNotPermittedExceptionUnknownResourceExceptionAmazonClientException - 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.public ActivityTask pollForActivityTask(PollForActivityTaskRequest pollForActivityTaskRequest)
 Used by workers to get an ActivityTask from the specified activity
 taskList . This initiates a long poll, where the service
 holds the HTTP connection open and responds as soon as a task becomes
 available. The maximum time the service holds on to the request before
 responding is 60 seconds. If no task is available within 60 seconds,
 the poll will return an empty result. An empty result, in this
 context, means that an ActivityTask is returned, but that the value of
 taskToken is an empty string. If a task is returned, the worker should
 use its type to identify and process it correctly.
 
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:
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 AmazonSimpleWorkflowpollForActivityTaskRequest - Container for the necessary
           parameters to execute the PollForActivityTask service method on
           AmazonSimpleWorkflow.OperationNotPermittedExceptionUnknownResourceExceptionLimitExceededExceptionAmazonClientException - 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.public WorkflowExecutionCount countOpenWorkflowExecutions(CountOpenWorkflowExecutionsRequest countOpenWorkflowExecutionsRequest)
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:
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 AmazonSimpleWorkflowcountOpenWorkflowExecutionsRequest - Container for the necessary
           parameters to execute the CountOpenWorkflowExecutions service method
           on AmazonSimpleWorkflow.OperationNotPermittedExceptionUnknownResourceExceptionAmazonClientException - 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.public ActivityTypeDetail describeActivityType(DescribeActivityTypeRequest describeActivityTypeRequest)
Returns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 AmazonSimpleWorkflowdescribeActivityTypeRequest - Container for the necessary
           parameters to execute the DescribeActivityType service method on
           AmazonSimpleWorkflow.OperationNotPermittedExceptionUnknownResourceExceptionAmazonClientException - 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.public WorkflowExecutionInfos listOpenWorkflowExecutions(ListOpenWorkflowExecutionsRequest listOpenWorkflowExecutionsRequest)
Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
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:
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 AmazonSimpleWorkflowlistOpenWorkflowExecutionsRequest - Container for the necessary
           parameters to execute the ListOpenWorkflowExecutions service method on
           AmazonSimpleWorkflow.OperationNotPermittedExceptionUnknownResourceExceptionAmazonClientException - 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.public History getWorkflowExecutionHistory(GetWorkflowExecutionHistoryRequest getWorkflowExecutionHistoryRequest)
 Returns the history of the specified workflow execution. The results
 may be split into multiple pages. To retrieve subsequent pages, make
 the call again using the nextPageToken returned by the
 initial call.
 
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:
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 AmazonSimpleWorkflowgetWorkflowExecutionHistoryRequest - Container for the necessary
           parameters to execute the GetWorkflowExecutionHistory service method
           on AmazonSimpleWorkflow.OperationNotPermittedExceptionUnknownResourceExceptionAmazonClientException - 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.public void registerDomain(RegisterDomainRequest registerDomainRequest)
Registers 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 AmazonSimpleWorkflowregisterDomainRequest - Container for the necessary parameters to
           execute the RegisterDomain service method on AmazonSimpleWorkflow.DomainAlreadyExistsExceptionOperationNotPermittedExceptionLimitExceededExceptionAmazonClientException - 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.public void registerActivityType(RegisterActivityTypeRequest registerActivityTypeRequest)
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:
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 AmazonSimpleWorkflowregisterActivityTypeRequest - Container for the necessary
           parameters to execute the RegisterActivityType service method on
           AmazonSimpleWorkflow.OperationNotPermittedExceptionUnknownResourceExceptionTypeAlreadyExistsExceptionLimitExceededExceptionAmazonClientException - 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.public WorkflowExecutionInfos listClosedWorkflowExecutions(ListClosedWorkflowExecutionsRequest listClosedWorkflowExecutionsRequest)
Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
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:
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 AmazonSimpleWorkflowlistClosedWorkflowExecutionsRequest - Container for the necessary
           parameters to execute the ListClosedWorkflowExecutions service method
           on AmazonSimpleWorkflow.OperationNotPermittedExceptionUnknownResourceExceptionAmazonClientException - 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.public 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. 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:
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 AmazonSimpleWorkflowrecordActivityTaskHeartbeatRequest - Container for the necessary
           parameters to execute the RecordActivityTaskHeartbeat service method
           on AmazonSimpleWorkflow.OperationNotPermittedExceptionUnknownResourceExceptionAmazonClientException - 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.public DecisionTask pollForDecisionTask(PollForDecisionTaskRequest pollForDecisionTaskRequest)
 Used by deciders to get a DecisionTask from the specified decision
 taskList . A decision task may be returned for any open
 workflow execution that is using the specified task list. The task
 includes a paginated view of the history of the workflow execution.
 The decider should use the workflow type and the history to determine
 how to properly handle the task.
 
This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned, but that the value of 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:
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 AmazonSimpleWorkflowpollForDecisionTaskRequest - Container for the necessary
           parameters to execute the PollForDecisionTask service method on
           AmazonSimpleWorkflow.OperationNotPermittedExceptionUnknownResourceExceptionLimitExceededExceptionAmazonClientException - 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.public ActivityTypeInfos listActivityTypes(ListActivityTypesRequest listActivityTypesRequest)
 Returns information about all activities registered in the specified
 domain that match the specified name and registration status. The
 result includes information like creation date, current status of the
 activity, etc. The results may be split into multiple pages. To
 retrieve subsequent pages, make the call again using the
 nextPageToken returned by the initial call.
 
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 AmazonSimpleWorkflowlistActivityTypesRequest - Container for the necessary parameters
           to execute the ListActivityTypes service method on
           AmazonSimpleWorkflow.OperationNotPermittedExceptionUnknownResourceExceptionAmazonClientException - 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.public DomainDetail describeDomain(DescribeDomainRequest describeDomainRequest)
Returns information about the specified domain, including description and status.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 AmazonSimpleWorkflowdescribeDomainRequest - Container for the necessary parameters to
           execute the DescribeDomain service method on AmazonSimpleWorkflow.OperationNotPermittedExceptionUnknownResourceExceptionAmazonClientException - 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.public void respondActivityTaskFailed(RespondActivityTaskFailedRequest respondActivityTaskFailedRequest)
 Used by workers to tell the service that the ActivityTask identified
 by the taskToken has failed with reason (if
 specified). The reason and details appear in
 the ActivityTaskFailed event added to the workflow
 history.
 
A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out .
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 AmazonSimpleWorkflowrespondActivityTaskFailedRequest - Container for the necessary
           parameters to execute the RespondActivityTaskFailed service method on
           AmazonSimpleWorkflow.OperationNotPermittedExceptionUnknownResourceExceptionAmazonClientException - 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.public PendingTaskCount countPendingDecisionTasks(CountPendingDecisionTasksRequest countPendingDecisionTasksRequest)
Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then 0 will be returned.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 AmazonSimpleWorkflowcountPendingDecisionTasksRequest - Container for the necessary
           parameters to execute the CountPendingDecisionTasks service method on
           AmazonSimpleWorkflow.OperationNotPermittedExceptionUnknownResourceExceptionAmazonClientException - 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.public void terminateWorkflowExecution(TerminateWorkflowExecutionRequest terminateWorkflowExecutionRequest)
 Records a WorkflowExecutionTerminated event and forces
 closure of the workflow execution identified by the given domain,
 runId, and workflowId. The child policy, registered with the workflow
 type or specified when starting this execution, is applied to any open
 child workflow executions of this workflow execution.
 
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:
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 AmazonSimpleWorkflowterminateWorkflowExecutionRequest - Container for the necessary
           parameters to execute the TerminateWorkflowExecution service method on
           AmazonSimpleWorkflow.OperationNotPermittedExceptionUnknownResourceExceptionAmazonClientException - 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.public WorkflowExecutionDetail describeWorkflowExecution(DescribeWorkflowExecutionRequest describeWorkflowExecutionRequest)
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:
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 AmazonSimpleWorkflowdescribeWorkflowExecutionRequest - Container for the necessary
           parameters to execute the DescribeWorkflowExecution service method on
           AmazonSimpleWorkflow.OperationNotPermittedExceptionUnknownResourceExceptionAmazonClientException - 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.public void setEndpoint(String endpoint)
AmazonWebServiceClientThis method is not threadsafe. Endpoints 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.
 Callers can pass in just the endpoint (ex: "ec2.amazonaws.com") or a full
 URL, including the protocol (ex: "https://ec2.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
setEndpoint in interface AmazonSimpleWorkflowsetEndpoint in class AmazonWebServiceClientendpoint - The endpoint (ex: "ec2.amazonaws.com") or a full URL,
            including the protocol (ex: "https://ec2.amazonaws.com") of
            the region specific AWS endpoint this client will communicate
            with.public void setEndpoint(String endpoint, String serviceName, String regionId) throws IllegalArgumentException
AmazonWebServiceClientOverrides the default endpoint for this client ("http://dynamodb.us-east-1.amazonaws.com/") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests. In almost all cases, this region ID and service name are automatically determined from the endpoint, and callers should use the simpler one-argument form of setEndpoint instead of this method.
 Callers can pass in just the endpoint (ex:
 "dynamodb.us-east-1.amazonaws.com/") or a full URL, including the
 protocol (ex: "http://dynamodb.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
setEndpoint in class AmazonWebServiceClientendpoint - The endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a
            full URL, including the protocol (ex:
            "http://dynamodb.us-east-1.amazonaws.com/") of the region
            specific AWS endpoint this client will communicate with.serviceName - This parameter is ignored.regionId - The ID of the region in which this service resides AND the
            overriding region for signing purposes.IllegalArgumentException - If any problems are detected with the specified endpoint.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata in interface AmazonSimpleWorkflowrequest - The originally executed requestCopyright © 2015. All rights reserved.