public interface AmazonSimpleWorkflowAsync extends AmazonSimpleWorkflow
The Amazon Simple Workflow Service API Reference is intended for programmers who need detailed information about the Amazon SWF actions and data types.
For an broader overview of the Amazon SWF programming model, please go to the Amazon SWF Developer Guide .
This section provides an overview of Amazon SWF actions.
Action Categories
The Amazon SWF actions can be grouped into the following major categories.
Actions related to Activities
Actions related to Deciders
Actions related to Workflow Executions
Actions related to Administration
Actions related to Visibility
Actions related to Activities
The following are actions that are performed by activity workers:
PollForActivityTask
RespondActivityTaskCompleted
RespondActivityTaskFailed
RespondActivityTaskCanceled
RecordActivityTaskHeartbeat
Activity workers use the PollForActivityTask to get new activity tasks. After a worker receives an activity task from Amazon SWF, it performs the task and responds using RespondActivityTaskCompleted if successful or RespondActivityTaskFailed if unsuccessful.
Actions related to Deciders
The following are actions that are performed by deciders:
PollForDecisionTask
RespondDecisionTaskCompleted
Deciders use PollForDecisionTask to get decision tasks. After a decider receives a decision task from Amazon SWF, it examines its workflow execution history and decides what to do next. It calls RespondDecisionTaskCompletedto complete the decision task and provide zero or more next decisions.
Actions related to Workflow Executions
The following actions operate on a workflow execution:
RequestCancelWorkflowExecution
StartWorkflowExecution
SignalWorkflowExecution
TerminateWorkflowExecution
Actions related to Administration
Although you can perform administrative tasks from the Amazon SWF console, you can use the actions in this section to automate functions or build your own administrative tools.
Activity Management
RegisterActivityType
DeprecateActivityType
Workflow Management
RegisterWorkflowType
DeprecateWorkflowType
Domain Management
RegisterDomain
DeprecateDomain
Workflow Execution Management
RequestCancelWorkflowExecution
TerminateWorkflowExecution
Visibility Actions
Although you can perform visibility actions from the Amazon SWF console, you can use the actions in this section to build your own console or administrative tools.
Activity Visibility
ListActivityTypes
DescribeActivity
Workflow Visibility
ListWorkflowTypes
DescribeWorkflowType
Workflow Execution Visibility
DescribeWorkflowExecution
ListOpenWorkflowExecutions
ListClosedWorkflowExecutions
CountOpenWorkflowExecutions
CountClosedWorkflowExecutions
GetWorkflowExecutionHistory
Domain Visibility
ListDomains
DescribeDomain
Task List Visibility
CountPendingActivityTasks
CountPendingDecisionTasks
| Modifier and Type | Method and Description |
|---|---|
Future<WorkflowExecutionCount> |
countClosedWorkflowExecutionsAsync(CountClosedWorkflowExecutionsRequest countClosedWorkflowExecutionsRequest)
Returns the number of closed workflow executions within the given
domain that meet the specified filtering criteria.
|
Future<WorkflowExecutionCount> |
countClosedWorkflowExecutionsAsync(CountClosedWorkflowExecutionsRequest countClosedWorkflowExecutionsRequest,
AsyncHandler<CountClosedWorkflowExecutionsRequest,WorkflowExecutionCount> asyncHandler)
Returns the number of closed workflow executions within the given
domain that meet the specified filtering criteria.
|
Future<WorkflowExecutionCount> |
countOpenWorkflowExecutionsAsync(CountOpenWorkflowExecutionsRequest countOpenWorkflowExecutionsRequest)
Returns the number of open workflow executions within the given
domain that meet the specified filtering criteria.
|
Future<WorkflowExecutionCount> |
countOpenWorkflowExecutionsAsync(CountOpenWorkflowExecutionsRequest countOpenWorkflowExecutionsRequest,
AsyncHandler<CountOpenWorkflowExecutionsRequest,WorkflowExecutionCount> asyncHandler)
Returns the number of open workflow executions within the given
domain that meet the specified filtering criteria.
|
Future<PendingTaskCount> |
countPendingActivityTasksAsync(CountPendingActivityTasksRequest countPendingActivityTasksRequest)
Returns the estimated number of activity tasks in the specified task
list.
|
Future<PendingTaskCount> |
countPendingActivityTasksAsync(CountPendingActivityTasksRequest countPendingActivityTasksRequest,
AsyncHandler<CountPendingActivityTasksRequest,PendingTaskCount> asyncHandler)
Returns the estimated number of activity tasks in the specified task
list.
|
Future<PendingTaskCount> |
countPendingDecisionTasksAsync(CountPendingDecisionTasksRequest countPendingDecisionTasksRequest)
Returns the estimated number of decision tasks in the specified task
list.
|
Future<PendingTaskCount> |
countPendingDecisionTasksAsync(CountPendingDecisionTasksRequest countPendingDecisionTasksRequest,
AsyncHandler<CountPendingDecisionTasksRequest,PendingTaskCount> asyncHandler)
Returns the estimated number of decision tasks in the specified task
list.
|
Future<Void> |
deprecateActivityTypeAsync(DeprecateActivityTypeRequest deprecateActivityTypeRequest)
Deprecates the specified activity type .
|
Future<Void> |
deprecateActivityTypeAsync(DeprecateActivityTypeRequest deprecateActivityTypeRequest,
AsyncHandler<DeprecateActivityTypeRequest,Void> asyncHandler)
Deprecates the specified activity type .
|
Future<Void> |
deprecateDomainAsync(DeprecateDomainRequest deprecateDomainRequest)
Deprecates the specified domain.
|
Future<Void> |
deprecateDomainAsync(DeprecateDomainRequest deprecateDomainRequest,
AsyncHandler<DeprecateDomainRequest,Void> asyncHandler)
Deprecates the specified domain.
|
Future<Void> |
deprecateWorkflowTypeAsync(DeprecateWorkflowTypeRequest deprecateWorkflowTypeRequest)
Deprecates the specified workflow type .
|
Future<Void> |
deprecateWorkflowTypeAsync(DeprecateWorkflowTypeRequest deprecateWorkflowTypeRequest,
AsyncHandler<DeprecateWorkflowTypeRequest,Void> asyncHandler)
Deprecates the specified workflow type .
|
Future<ActivityTypeDetail> |
describeActivityTypeAsync(DescribeActivityTypeRequest describeActivityTypeRequest)
Returns information about the specified activity type.
|
Future<ActivityTypeDetail> |
describeActivityTypeAsync(DescribeActivityTypeRequest describeActivityTypeRequest,
AsyncHandler<DescribeActivityTypeRequest,ActivityTypeDetail> asyncHandler)
Returns information about the specified activity type.
|
Future<DomainDetail> |
describeDomainAsync(DescribeDomainRequest describeDomainRequest)
Returns information about the specified domain including description
and status.
|
Future<DomainDetail> |
describeDomainAsync(DescribeDomainRequest describeDomainRequest,
AsyncHandler<DescribeDomainRequest,DomainDetail> asyncHandler)
Returns information about the specified domain including description
and status.
|
Future<WorkflowExecutionDetail> |
describeWorkflowExecutionAsync(DescribeWorkflowExecutionRequest describeWorkflowExecutionRequest)
Returns information about the specified workflow execution including
its type and some statistics.
|
Future<WorkflowExecutionDetail> |
describeWorkflowExecutionAsync(DescribeWorkflowExecutionRequest describeWorkflowExecutionRequest,
AsyncHandler<DescribeWorkflowExecutionRequest,WorkflowExecutionDetail> asyncHandler)
Returns information about the specified workflow execution including
its type and some statistics.
|
Future<WorkflowTypeDetail> |
describeWorkflowTypeAsync(DescribeWorkflowTypeRequest describeWorkflowTypeRequest)
Returns information about the specified workflow type .
|
Future<WorkflowTypeDetail> |
describeWorkflowTypeAsync(DescribeWorkflowTypeRequest describeWorkflowTypeRequest,
AsyncHandler<DescribeWorkflowTypeRequest,WorkflowTypeDetail> asyncHandler)
Returns information about the specified workflow type .
|
Future<History> |
getWorkflowExecutionHistoryAsync(GetWorkflowExecutionHistoryRequest getWorkflowExecutionHistoryRequest)
Returns the history of the specified workflow execution.
|
Future<History> |
getWorkflowExecutionHistoryAsync(GetWorkflowExecutionHistoryRequest getWorkflowExecutionHistoryRequest,
AsyncHandler<GetWorkflowExecutionHistoryRequest,History> asyncHandler)
Returns the history of the specified workflow execution.
|
Future<ActivityTypeInfos> |
listActivityTypesAsync(ListActivityTypesRequest listActivityTypesRequest)
Returns information about all activities registered in the specified
domain that match the specified name and registration status.
|
Future<ActivityTypeInfos> |
listActivityTypesAsync(ListActivityTypesRequest listActivityTypesRequest,
AsyncHandler<ListActivityTypesRequest,ActivityTypeInfos> asyncHandler)
Returns information about all activities registered in the specified
domain that match the specified name and registration status.
|
Future<WorkflowExecutionInfos> |
listClosedWorkflowExecutionsAsync(ListClosedWorkflowExecutionsRequest listClosedWorkflowExecutionsRequest)
Returns a list of closed workflow executions in the specified domain
that meet the filtering criteria.
|
Future<WorkflowExecutionInfos> |
listClosedWorkflowExecutionsAsync(ListClosedWorkflowExecutionsRequest listClosedWorkflowExecutionsRequest,
AsyncHandler<ListClosedWorkflowExecutionsRequest,WorkflowExecutionInfos> asyncHandler)
Returns a list of closed workflow executions in the specified domain
that meet the filtering criteria.
|
Future<DomainInfos> |
listDomainsAsync(ListDomainsRequest listDomainsRequest)
Returns the list of domains registered in the account.
|
Future<DomainInfos> |
listDomainsAsync(ListDomainsRequest listDomainsRequest,
AsyncHandler<ListDomainsRequest,DomainInfos> asyncHandler)
Returns the list of domains registered in the account.
|
Future<WorkflowExecutionInfos> |
listOpenWorkflowExecutionsAsync(ListOpenWorkflowExecutionsRequest listOpenWorkflowExecutionsRequest)
Returns a list of open workflow executions in the specified domain
that meet the filtering criteria.
|
Future<WorkflowExecutionInfos> |
listOpenWorkflowExecutionsAsync(ListOpenWorkflowExecutionsRequest listOpenWorkflowExecutionsRequest,
AsyncHandler<ListOpenWorkflowExecutionsRequest,WorkflowExecutionInfos> asyncHandler)
Returns a list of open workflow executions in the specified domain
that meet the filtering criteria.
|
Future<WorkflowTypeInfos> |
listWorkflowTypesAsync(ListWorkflowTypesRequest listWorkflowTypesRequest)
Returns information about workflow types in the specified domain.
|
Future<WorkflowTypeInfos> |
listWorkflowTypesAsync(ListWorkflowTypesRequest listWorkflowTypesRequest,
AsyncHandler<ListWorkflowTypesRequest,WorkflowTypeInfos> asyncHandler)
Returns information about workflow types in the specified domain.
|
Future<ActivityTask> |
pollForActivityTaskAsync(PollForActivityTaskRequest pollForActivityTaskRequest)
Used by workers to get an ActivityTask from the specified activity
taskList . |
Future<ActivityTask> |
pollForActivityTaskAsync(PollForActivityTaskRequest pollForActivityTaskRequest,
AsyncHandler<PollForActivityTaskRequest,ActivityTask> asyncHandler)
Used by workers to get an ActivityTask from the specified activity
taskList . |
Future<DecisionTask> |
pollForDecisionTaskAsync(PollForDecisionTaskRequest pollForDecisionTaskRequest)
Used by deciders to get a DecisionTask from the specified decision
taskList . |
Future<DecisionTask> |
pollForDecisionTaskAsync(PollForDecisionTaskRequest pollForDecisionTaskRequest,
AsyncHandler<PollForDecisionTaskRequest,DecisionTask> asyncHandler)
Used by deciders to get a DecisionTask from the specified decision
taskList . |
Future<ActivityTaskStatus> |
recordActivityTaskHeartbeatAsync(RecordActivityTaskHeartbeatRequest recordActivityTaskHeartbeatRequest)
Used by activity workers to report to the service that the
ActivityTask represented by the specified
taskToken is
still making progress. |
Future<ActivityTaskStatus> |
recordActivityTaskHeartbeatAsync(RecordActivityTaskHeartbeatRequest recordActivityTaskHeartbeatRequest,
AsyncHandler<RecordActivityTaskHeartbeatRequest,ActivityTaskStatus> asyncHandler)
Used by activity workers to report to the service that the
ActivityTask represented by the specified
taskToken is
still making progress. |
Future<Void> |
registerActivityTypeAsync(RegisterActivityTypeRequest registerActivityTypeRequest)
Registers a new activity type along with its configuration
settings in the specified domain.
|
Future<Void> |
registerActivityTypeAsync(RegisterActivityTypeRequest registerActivityTypeRequest,
AsyncHandler<RegisterActivityTypeRequest,Void> asyncHandler)
Registers a new activity type along with its configuration
settings in the specified domain.
|
Future<Void> |
registerDomainAsync(RegisterDomainRequest registerDomainRequest)
Registers a new domain.
|
Future<Void> |
registerDomainAsync(RegisterDomainRequest registerDomainRequest,
AsyncHandler<RegisterDomainRequest,Void> asyncHandler)
Registers a new domain.
|
Future<Void> |
registerWorkflowTypeAsync(RegisterWorkflowTypeRequest registerWorkflowTypeRequest)
Registers a new workflow type and its configuration settings
in the specified domain.
|
Future<Void> |
registerWorkflowTypeAsync(RegisterWorkflowTypeRequest registerWorkflowTypeRequest,
AsyncHandler<RegisterWorkflowTypeRequest,Void> asyncHandler)
Registers a new workflow type and its configuration settings
in the specified domain.
|
Future<Void> |
requestCancelWorkflowExecutionAsync(RequestCancelWorkflowExecutionRequest requestCancelWorkflowExecutionRequest)
Records a
WorkflowExecutionCancelRequested event in the
currently running workflow execution identified by the given domain,
workflowId, and runId. |
Future<Void> |
requestCancelWorkflowExecutionAsync(RequestCancelWorkflowExecutionRequest requestCancelWorkflowExecutionRequest,
AsyncHandler<RequestCancelWorkflowExecutionRequest,Void> asyncHandler)
Records a
WorkflowExecutionCancelRequested event in the
currently running workflow execution identified by the given domain,
workflowId, and runId. |
Future<Void> |
respondActivityTaskCanceledAsync(RespondActivityTaskCanceledRequest respondActivityTaskCanceledRequest)
Used by workers to tell the service that the ActivityTask identified
by the
taskToken was successfully canceled. |
Future<Void> |
respondActivityTaskCanceledAsync(RespondActivityTaskCanceledRequest respondActivityTaskCanceledRequest,
AsyncHandler<RespondActivityTaskCanceledRequest,Void> asyncHandler)
Used by workers to tell the service that the ActivityTask identified
by the
taskToken was successfully canceled. |
Future<Void> |
respondActivityTaskCompletedAsync(RespondActivityTaskCompletedRequest respondActivityTaskCompletedRequest)
Used by workers to tell the service that the ActivityTask identified
by the
taskToken completed successfully with a
result (if provided). |
Future<Void> |
respondActivityTaskCompletedAsync(RespondActivityTaskCompletedRequest respondActivityTaskCompletedRequest,
AsyncHandler<RespondActivityTaskCompletedRequest,Void> asyncHandler)
Used by workers to tell the service that the ActivityTask identified
by the
taskToken completed successfully with a
result (if provided). |
Future<Void> |
respondActivityTaskFailedAsync(RespondActivityTaskFailedRequest respondActivityTaskFailedRequest)
Used by workers to tell the service that the ActivityTask identified
by the
taskToken has failed with reason (if
specified). |
Future<Void> |
respondActivityTaskFailedAsync(RespondActivityTaskFailedRequest respondActivityTaskFailedRequest,
AsyncHandler<RespondActivityTaskFailedRequest,Void> asyncHandler)
Used by workers to tell the service that the ActivityTask identified
by the
taskToken has failed with reason (if
specified). |
Future<Void> |
respondDecisionTaskCompletedAsync(RespondDecisionTaskCompletedRequest respondDecisionTaskCompletedRequest)
Used by deciders to tell the service that the DecisionTask identified
by the
taskToken has successfully completed. |
Future<Void> |
respondDecisionTaskCompletedAsync(RespondDecisionTaskCompletedRequest respondDecisionTaskCompletedRequest,
AsyncHandler<RespondDecisionTaskCompletedRequest,Void> asyncHandler)
Used by deciders to tell the service that the DecisionTask identified
by the
taskToken has successfully completed. |
Future<Void> |
signalWorkflowExecutionAsync(SignalWorkflowExecutionRequest signalWorkflowExecutionRequest)
Records a
WorkflowExecutionSignaled event in the
workflow execution history and creates a decision task for the
workflow execution identified by the given domain, workflowId and
runId. |
Future<Void> |
signalWorkflowExecutionAsync(SignalWorkflowExecutionRequest signalWorkflowExecutionRequest,
AsyncHandler<SignalWorkflowExecutionRequest,Void> asyncHandler)
Records a
WorkflowExecutionSignaled event in the
workflow execution history and creates a decision task for the
workflow execution identified by the given domain, workflowId and
runId. |
Future<Run> |
startWorkflowExecutionAsync(StartWorkflowExecutionRequest startWorkflowExecutionRequest)
Starts an execution of the workflow type in the specified domain
using the provided
workflowId and input data. |
Future<Run> |
startWorkflowExecutionAsync(StartWorkflowExecutionRequest startWorkflowExecutionRequest,
AsyncHandler<StartWorkflowExecutionRequest,Run> asyncHandler)
Starts an execution of the workflow type in the specified domain
using the provided
workflowId and input data. |
Future<Void> |
terminateWorkflowExecutionAsync(TerminateWorkflowExecutionRequest terminateWorkflowExecutionRequest)
Records a
WorkflowExecutionTerminated event and forces
closure of the workflow execution identified by the given domain,
runId, and workflowId. |
Future<Void> |
terminateWorkflowExecutionAsync(TerminateWorkflowExecutionRequest terminateWorkflowExecutionRequest,
AsyncHandler<TerminateWorkflowExecutionRequest,Void> asyncHandler)
Records a
WorkflowExecutionTerminated event and forces
closure of the workflow execution identified by the given domain,
runId, and workflowId. |
countClosedWorkflowExecutions, countOpenWorkflowExecutions, countPendingActivityTasks, countPendingDecisionTasks, deprecateActivityType, deprecateDomain, deprecateWorkflowType, describeActivityType, describeDomain, describeWorkflowExecution, describeWorkflowType, getCachedResponseMetadata, getWorkflowExecutionHistory, listActivityTypes, listClosedWorkflowExecutions, listDomains, listOpenWorkflowExecutions, listWorkflowTypes, pollForActivityTask, pollForDecisionTask, recordActivityTaskHeartbeat, registerActivityType, registerDomain, registerWorkflowType, requestCancelWorkflowExecution, respondActivityTaskCanceled, respondActivityTaskCompleted, respondActivityTaskFailed, respondDecisionTaskCompleted, setEndpoint, setRegion, shutdown, signalWorkflowExecution, startWorkflowExecution, terminateWorkflowExecutionFuture<Void> deprecateWorkflowTypeAsync(DeprecateWorkflowTypeRequest deprecateWorkflowTypeRequest) throws AmazonServiceException, AmazonClientException
Deprecates the specified workflow type . After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated will continue to run. A deprecated workflow type may still be used when calling visibility actions.
NOTE: This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
deprecateWorkflowTypeRequest - Container for the necessary
parameters to execute the DeprecateWorkflowType operation on
AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<Void> deprecateWorkflowTypeAsync(DeprecateWorkflowTypeRequest deprecateWorkflowTypeRequest, AsyncHandler<DeprecateWorkflowTypeRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Deprecates the specified workflow type . After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated will continue to run. A deprecated workflow type may still be used when calling visibility actions.
NOTE: This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
deprecateWorkflowTypeRequest - Container for the necessary
parameters to execute the DeprecateWorkflowType operation on
AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<Void> deprecateDomainAsync(DeprecateDomainRequest deprecateDomainRequest) throws AmazonServiceException, AmazonClientException
Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain. Executions that were started before the domain was deprecated will continue to run.
NOTE: This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
deprecateDomainRequest - Container for the necessary parameters
to execute the DeprecateDomain operation on AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<Void> deprecateDomainAsync(DeprecateDomainRequest deprecateDomainRequest, AsyncHandler<DeprecateDomainRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain. Executions that were started before the domain was deprecated will continue to run.
NOTE: This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
deprecateDomainRequest - Container for the necessary parameters
to execute the DeprecateDomain operation on AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<Void> registerWorkflowTypeAsync(RegisterWorkflowTypeRequest registerWorkflowTypeRequest) throws AmazonServiceException, AmazonClientException
Registers a new workflow type and its configuration settings in the specified domain.
The retention period for the workflow history is set by the RegisterDomain action.
IMPORTANT: If the type already exists, then a TypeAlreadyExists fault is returned. You cannot change the configuration settings of a workflow type once it is registered and it must be registered as a new version.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 : 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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
registerWorkflowTypeRequest - Container for the necessary
parameters to execute the RegisterWorkflowType operation on
AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<Void> registerWorkflowTypeAsync(RegisterWorkflowTypeRequest registerWorkflowTypeRequest, AsyncHandler<RegisterWorkflowTypeRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Registers a new workflow type and its configuration settings in the specified domain.
The retention period for the workflow history is set by the RegisterDomain action.
IMPORTANT: If the type already exists, then a TypeAlreadyExists fault is returned. You cannot change the configuration settings of a workflow type once it is registered and it must be registered as a new version.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 : 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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
registerWorkflowTypeRequest - Container for the necessary
parameters to execute the RegisterWorkflowType operation on
AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<WorkflowTypeInfos> listWorkflowTypesAsync(ListWorkflowTypesRequest listWorkflowTypesRequest) throws AmazonServiceException, AmazonClientException
Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly.
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
listWorkflowTypesRequest - Container for the necessary parameters
to execute the ListWorkflowTypes operation on AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<WorkflowTypeInfos> listWorkflowTypesAsync(ListWorkflowTypesRequest listWorkflowTypesRequest, AsyncHandler<ListWorkflowTypesRequest,WorkflowTypeInfos> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
listWorkflowTypesRequest - Container for the necessary parameters
to execute the ListWorkflowTypes operation on AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<Run> startWorkflowExecutionAsync(StartWorkflowExecutionRequest startWorkflowExecutionRequest) throws AmazonServiceException, AmazonClientException
Starts an execution of the workflow type in the specified domain
using the provided workflowId and input data.
This action returns the newly started workflow execution.
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 .name : String constraint. The key is
swf:workflowType.name .version : String constraint. The key is
swf:workflowType.version .
If the caller does not have sufficient permissions to invoke the
action, or the parameter values fall outside the specified
constraints, the action fails by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
startWorkflowExecutionRequest - Container for the necessary
parameters to execute the StartWorkflowExecution operation on
AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<Run> startWorkflowExecutionAsync(StartWorkflowExecutionRequest startWorkflowExecutionRequest, AsyncHandler<StartWorkflowExecutionRequest,Run> asyncHandler) throws AmazonServiceException, AmazonClientException
Starts an execution of the workflow type in the specified domain
using the provided workflowId and input data.
This action returns the newly started workflow execution.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 .name : String constraint. The key is
swf:workflowType.name .version : String constraint. The key is
swf:workflowType.version .
If the caller does not have sufficient permissions to invoke the
action, or the parameter values fall outside the specified
constraints, the action fails by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
startWorkflowExecutionRequest - Container for the necessary
parameters to execute the StartWorkflowExecution operation on
AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<Void> signalWorkflowExecutionAsync(SignalWorkflowExecutionRequest signalWorkflowExecutionRequest) throws AmazonServiceException, AmazonClientException
Records a WorkflowExecutionSignaled event in the
workflow execution history and creates a decision task for the
workflow execution identified by the given domain, workflowId and
runId. The event is recorded with the specified user defined
signalName and input (if provided).
NOTE: If a runId is not specified, then the WorkflowExecutionSignaled event is recorded in the history of the current open workflow with the matching workflowId in the domain.
NOTE: If the specified workflow execution is not open, this method fails with UnknownResource.
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
signalWorkflowExecutionRequest - Container for the necessary
parameters to execute the SignalWorkflowExecution operation on
AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<Void> signalWorkflowExecutionAsync(SignalWorkflowExecutionRequest signalWorkflowExecutionRequest, AsyncHandler<SignalWorkflowExecutionRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Records a WorkflowExecutionSignaled event in the
workflow execution history and creates a decision task for the
workflow execution identified by the given domain, workflowId and
runId. The event is recorded with the specified user defined
signalName and input (if provided).
NOTE: If a runId is not specified, then the WorkflowExecutionSignaled event is recorded in the history of the current open workflow with the matching workflowId in the domain.
NOTE: If the specified workflow execution is not open, this method fails with UnknownResource.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
signalWorkflowExecutionRequest - Container for the necessary
parameters to execute the SignalWorkflowExecution operation on
AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<DomainInfos> listDomainsAsync(ListDomainsRequest listDomainsRequest) throws AmazonServiceException, AmazonClientException
Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
NOTE: This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
listDomainsRequest - Container for the necessary parameters to
execute the ListDomains operation on AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<DomainInfos> listDomainsAsync(ListDomainsRequest listDomainsRequest, AsyncHandler<ListDomainsRequest,DomainInfos> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
NOTE: This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
listDomainsRequest - Container for the necessary parameters to
execute the ListDomains operation on AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<Void> requestCancelWorkflowExecutionAsync(RequestCancelWorkflowExecutionRequest requestCancelWorkflowExecutionRequest) throws AmazonServiceException, AmazonClientException
Records a WorkflowExecutionCancelRequested event in the
currently running workflow execution identified by the given domain,
workflowId, and runId. This logically requests the cancellation of the
workflow execution as a whole. It is up to the decider to take
appropriate actions when it receives an execution history with this
event.
NOTE: If the runId is not specified, the WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the specified workflowId in the domain.
NOTE: Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of TerminateWorkflowExecution when possible.
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
requestCancelWorkflowExecutionRequest - Container for the
necessary parameters to execute the RequestCancelWorkflowExecution
operation on AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<Void> requestCancelWorkflowExecutionAsync(RequestCancelWorkflowExecutionRequest requestCancelWorkflowExecutionRequest, AsyncHandler<RequestCancelWorkflowExecutionRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Records a WorkflowExecutionCancelRequested event in the
currently running workflow execution identified by the given domain,
workflowId, and runId. This logically requests the cancellation of the
workflow execution as a whole. It is up to the decider to take
appropriate actions when it receives an execution history with this
event.
NOTE: If the runId is not specified, the WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the specified workflowId in the domain.
NOTE: Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of TerminateWorkflowExecution when possible.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
requestCancelWorkflowExecutionRequest - Container for the
necessary parameters to execute the RequestCancelWorkflowExecution
operation on AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<WorkflowTypeDetail> describeWorkflowTypeAsync(DescribeWorkflowTypeRequest describeWorkflowTypeRequest) throws AmazonServiceException, AmazonClientException
Returns information about the specified workflow type . This includes configuration settings specified when the type was registered and other information such as creation date, current status, etc.
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
describeWorkflowTypeRequest - Container for the necessary
parameters to execute the DescribeWorkflowType operation on
AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<WorkflowTypeDetail> describeWorkflowTypeAsync(DescribeWorkflowTypeRequest describeWorkflowTypeRequest, AsyncHandler<DescribeWorkflowTypeRequest,WorkflowTypeDetail> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns information about the specified workflow type . This includes configuration settings specified when the type was registered and other information such as creation date, current status, etc.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
describeWorkflowTypeRequest - Container for the necessary
parameters to execute the DescribeWorkflowType operation on
AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<Void> deprecateActivityTypeAsync(DeprecateActivityTypeRequest deprecateActivityTypeRequest) throws AmazonServiceException, AmazonClientException
Deprecates the specified activity type . After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type that were scheduled before the type was deprecated will continue to run.
NOTE: This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
deprecateActivityTypeRequest - Container for the necessary
parameters to execute the DeprecateActivityType operation on
AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<Void> deprecateActivityTypeAsync(DeprecateActivityTypeRequest deprecateActivityTypeRequest, AsyncHandler<DeprecateActivityTypeRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Deprecates the specified activity type . After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type that were scheduled before the type was deprecated will continue to run.
NOTE: This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
deprecateActivityTypeRequest - Container for the necessary
parameters to execute the DeprecateActivityType operation on
AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<WorkflowExecutionCount> countClosedWorkflowExecutionsAsync(CountClosedWorkflowExecutionsRequest countClosedWorkflowExecutionsRequest) throws AmazonServiceException, AmazonClientException
Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.
NOTE: This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
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.
tag : String constraint. The key is
swf:tagFilter.tag .typeFilter.name : String constraint. String
constraint. The key is swf:typeFilter.name .typeFilter.version : String constraint. String
constraint. The key is swf:typeFilter.version .
If the caller does not have sufficient permissions to invoke the
action, or the parameter values fall outside the specified
constraints, the action fails by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
countClosedWorkflowExecutionsRequest - Container for the
necessary parameters to execute the CountClosedWorkflowExecutions
operation on AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<WorkflowExecutionCount> countClosedWorkflowExecutionsAsync(CountClosedWorkflowExecutionsRequest countClosedWorkflowExecutionsRequest, AsyncHandler<CountClosedWorkflowExecutionsRequest,WorkflowExecutionCount> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.
NOTE: This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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.
tag : String constraint. The key is
swf:tagFilter.tag .typeFilter.name : String constraint. String
constraint. The key is swf:typeFilter.name .typeFilter.version : String constraint. String
constraint. The key is swf:typeFilter.version .
If the caller does not have sufficient permissions to invoke the
action, or the parameter values fall outside the specified
constraints, the action fails by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
countClosedWorkflowExecutionsRequest - Container for the
necessary parameters to execute the CountClosedWorkflowExecutions
operation on AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<PendingTaskCount> countPendingActivityTasksAsync(CountPendingActivityTasksRequest countPendingActivityTasksRequest) throws AmazonServiceException, AmazonClientException
Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 will be returned.
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.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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
countPendingActivityTasksRequest - Container for the necessary
parameters to execute the CountPendingActivityTasks operation on
AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<PendingTaskCount> countPendingActivityTasksAsync(CountPendingActivityTasksRequest countPendingActivityTasksRequest, AsyncHandler<CountPendingActivityTasksRequest,PendingTaskCount> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 will be returned.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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.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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
countPendingActivityTasksRequest - Container for the necessary
parameters to execute the CountPendingActivityTasks operation on
AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<Void> respondActivityTaskCanceledAsync(RespondActivityTaskCanceledRequest respondActivityTaskCanceledRequest) throws AmazonServiceException, AmazonClientException
Used by workers to tell the service that the ActivityTask identified
by the taskToken was successfully canceled. Additional
details can be optionally provided using the
details argument.
These details (if provided) appear in the
ActivityTaskCanceled event added to the workflow history.
IMPORTANT: Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns true and if the activity can be safely undone or abandoned.
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
respondActivityTaskCanceledRequest - Container for the necessary
parameters to execute the RespondActivityTaskCanceled operation on
AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<Void> respondActivityTaskCanceledAsync(RespondActivityTaskCanceledRequest respondActivityTaskCanceledRequest, AsyncHandler<RespondActivityTaskCanceledRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Used by workers to tell the service that the ActivityTask identified
by the taskToken was successfully canceled. Additional
details can be optionally provided using the
details argument.
These details (if provided) appear in the
ActivityTaskCanceled event added to the workflow history.
IMPORTANT: Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns true and if the activity can be safely undone or abandoned.
A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out .
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
respondActivityTaskCanceledRequest - Container for the necessary
parameters to execute the RespondActivityTaskCanceled operation on
AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<Void> respondDecisionTaskCompletedAsync(RespondDecisionTaskCompletedRequest respondDecisionTaskCompletedRequest) throws AmazonServiceException, AmazonClientException
Used by deciders to tell the service that the DecisionTask identified
by the taskToken has successfully completed. The
decisions argument specifies the list of decisions made
while processing the task.
A
DecisionTaskCompleted event is added
to the workflow history. The executionContext specified
is attached to the event in the workflow execution history.
Access Control
If an IAM policy grants permission to use
RespondDecisionTaskCompleted , it can express permissions
for the list of decisions in the decisions parameter in
the same way as for the regular API. This approach maintains a uniform
conceptual model and helps keep policies readable. For more
information, see
Using IAM to Manage Access to Amazon SWF Workflows
.
respondDecisionTaskCompletedRequest - Container for the necessary
parameters to execute the RespondDecisionTaskCompleted operation on
AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<Void> respondDecisionTaskCompletedAsync(RespondDecisionTaskCompletedRequest respondDecisionTaskCompletedRequest, AsyncHandler<RespondDecisionTaskCompletedRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Used by deciders to tell the service that the DecisionTask identified
by the taskToken has successfully completed. The
decisions argument specifies the list of decisions made
while processing the task.
A
DecisionTaskCompleted event is added
to the workflow history. The executionContext specified
is attached to the event in the workflow execution history.
Access Control
If an IAM policy grants permission to use
RespondDecisionTaskCompleted , it can express permissions
for the list of decisions in the decisions parameter in
the same way as for the regular API. This approach maintains a uniform
conceptual model and helps keep policies readable. For more
information, see
Using IAM to Manage Access to Amazon SWF Workflows
.
respondDecisionTaskCompletedRequest - Container for the necessary
parameters to execute the RespondDecisionTaskCompleted operation on
AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<Void> respondActivityTaskCompletedAsync(RespondActivityTaskCompletedRequest respondActivityTaskCompletedRequest) throws AmazonServiceException, AmazonClientException
Used by workers to tell the service that the ActivityTask identified
by the taskToken completed successfully with a
result (if provided). The result appears in
the ActivityTaskCompleted event in the workflow history.
IMPORTANT: If the requested task does not complete successfully, use RespondActivityTaskFailed instead. If the worker finds that the task is canceled through the canceled flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call RespondActivityTaskCanceled.
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
respondActivityTaskCompletedRequest - Container for the necessary
parameters to execute the RespondActivityTaskCompleted operation on
AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<Void> respondActivityTaskCompletedAsync(RespondActivityTaskCompletedRequest respondActivityTaskCompletedRequest, AsyncHandler<RespondActivityTaskCompletedRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Used by workers to tell the service that the ActivityTask identified
by the taskToken completed successfully with a
result (if provided). The result appears in
the ActivityTaskCompleted event in the workflow history.
IMPORTANT: If the requested task does not complete successfully, use RespondActivityTaskFailed instead. If the worker finds that the task is canceled through the canceled flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call RespondActivityTaskCanceled.
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
respondActivityTaskCompletedRequest - Container for the necessary
parameters to execute the RespondActivityTaskCompleted operation on
AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<ActivityTask> pollForActivityTaskAsync(PollForActivityTaskRequest pollForActivityTaskRequest) throws AmazonServiceException, AmazonClientException
Used by workers to get an ActivityTask from the specified activity
taskList . This initiates a long poll, where the service
holds the HTTP connection open and responds as soon as a task becomes
available. The maximum time the service holds on to the request before
responding is 60 seconds. If no task is available within 60 seconds,
the poll will return an empty result. An empty result, in this
context, means that an ActivityTask is returned, but that the value of
taskToken is an empty string. If a task is returned, the worker should
use its type to identify and process it correctly.
IMPORTANT: Workers should set their client side socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may hold the poll request).
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.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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
pollForActivityTaskRequest - Container for the necessary
parameters to execute the PollForActivityTask operation on
AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<ActivityTask> pollForActivityTaskAsync(PollForActivityTaskRequest pollForActivityTaskRequest, AsyncHandler<PollForActivityTaskRequest,ActivityTask> asyncHandler) throws AmazonServiceException, AmazonClientException
Used by workers to get an ActivityTask from the specified activity
taskList . This initiates a long poll, where the service
holds the HTTP connection open and responds as soon as a task becomes
available. The maximum time the service holds on to the request before
responding is 60 seconds. If no task is available within 60 seconds,
the poll will return an empty result. An empty result, in this
context, means that an ActivityTask is returned, but that the value of
taskToken is an empty string. If a task is returned, the worker should
use its type to identify and process it correctly.
IMPORTANT: Workers should set their client side socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may hold the poll request).
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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.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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
pollForActivityTaskRequest - Container for the necessary
parameters to execute the PollForActivityTask operation on
AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<WorkflowExecutionCount> countOpenWorkflowExecutionsAsync(CountOpenWorkflowExecutionsRequest countOpenWorkflowExecutionsRequest) throws AmazonServiceException, AmazonClientException
Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.
NOTE: This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
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.
tag : String constraint. The key is
swf:tagFilter.tag .typeFilter.name : String constraint. String
constraint. The key is swf:typeFilter.name .typeFilter.version : String constraint. String
constraint. The key is swf:typeFilter.version .
If the caller does not have sufficient permissions to invoke the
action, or the parameter values fall outside the specified
constraints, the action fails by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
countOpenWorkflowExecutionsRequest - Container for the necessary
parameters to execute the CountOpenWorkflowExecutions operation on
AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<WorkflowExecutionCount> countOpenWorkflowExecutionsAsync(CountOpenWorkflowExecutionsRequest countOpenWorkflowExecutionsRequest, AsyncHandler<CountOpenWorkflowExecutionsRequest,WorkflowExecutionCount> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.
NOTE: This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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.
tag : String constraint. The key is
swf:tagFilter.tag .typeFilter.name : String constraint. String
constraint. The key is swf:typeFilter.name .typeFilter.version : String constraint. String
constraint. The key is swf:typeFilter.version .
If the caller does not have sufficient permissions to invoke the
action, or the parameter values fall outside the specified
constraints, the action fails by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
countOpenWorkflowExecutionsRequest - Container for the necessary
parameters to execute the CountOpenWorkflowExecutions operation on
AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<ActivityTypeDetail> describeActivityTypeAsync(DescribeActivityTypeRequest describeActivityTypeRequest) throws AmazonServiceException, AmazonClientException
Returns information about the specified activity type. This includes configuration settings provided at registration time as well as other general information about the type.
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
describeActivityTypeRequest - Container for the necessary
parameters to execute the DescribeActivityType operation on
AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<ActivityTypeDetail> describeActivityTypeAsync(DescribeActivityTypeRequest describeActivityTypeRequest, AsyncHandler<DescribeActivityTypeRequest,ActivityTypeDetail> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns information about the specified activity type. This includes configuration settings provided at registration time as well as other general information about the type.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
describeActivityTypeRequest - Container for the necessary
parameters to execute the DescribeActivityType operation on
AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<WorkflowExecutionInfos> listOpenWorkflowExecutionsAsync(ListOpenWorkflowExecutionsRequest listOpenWorkflowExecutionsRequest) throws AmazonServiceException, AmazonClientException
Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
NOTE: This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
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.
tag : String constraint. The key is
swf:tagFilter.tag .typeFilter.name : String constraint. String
constraint. The key is swf:typeFilter.name .typeFilter.version : String constraint. String
constraint. The key is swf:typeFilter.version .
If the caller does not have sufficient permissions to invoke the
action, or the parameter values fall outside the specified
constraints, the action fails by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
listOpenWorkflowExecutionsRequest - Container for the necessary
parameters to execute the ListOpenWorkflowExecutions operation on
AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<WorkflowExecutionInfos> listOpenWorkflowExecutionsAsync(ListOpenWorkflowExecutionsRequest listOpenWorkflowExecutionsRequest, AsyncHandler<ListOpenWorkflowExecutionsRequest,WorkflowExecutionInfos> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
NOTE: This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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.
tag : String constraint. The key is
swf:tagFilter.tag .typeFilter.name : String constraint. String
constraint. The key is swf:typeFilter.name .typeFilter.version : String constraint. String
constraint. The key is swf:typeFilter.version .
If the caller does not have sufficient permissions to invoke the
action, or the parameter values fall outside the specified
constraints, the action fails by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
listOpenWorkflowExecutionsRequest - Container for the necessary
parameters to execute the ListOpenWorkflowExecutions operation on
AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<History> getWorkflowExecutionHistoryAsync(GetWorkflowExecutionHistoryRequest getWorkflowExecutionHistoryRequest) throws AmazonServiceException, AmazonClientException
Returns the history of the specified workflow execution. The results
may be split into multiple pages. To retrieve subsequent pages, make
the call again using the nextPageToken returned by the
initial call.
NOTE: This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
getWorkflowExecutionHistoryRequest - Container for the necessary
parameters to execute the GetWorkflowExecutionHistory operation on
AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<History> getWorkflowExecutionHistoryAsync(GetWorkflowExecutionHistoryRequest getWorkflowExecutionHistoryRequest, AsyncHandler<GetWorkflowExecutionHistoryRequest,History> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns the history of the specified workflow execution. The results
may be split into multiple pages. To retrieve subsequent pages, make
the call again using the nextPageToken returned by the
initial call.
NOTE: This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
getWorkflowExecutionHistoryRequest - Container for the necessary
parameters to execute the GetWorkflowExecutionHistory operation on
AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<Void> registerDomainAsync(RegisterDomainRequest registerDomainRequest) throws AmazonServiceException, AmazonClientException
Registers a new domain.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
registerDomainRequest - Container for the necessary parameters to
execute the RegisterDomain operation on AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<Void> registerDomainAsync(RegisterDomainRequest registerDomainRequest, AsyncHandler<RegisterDomainRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Registers a new domain.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
registerDomainRequest - Container for the necessary parameters to
execute the RegisterDomain operation on AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<Void> registerActivityTypeAsync(RegisterActivityTypeRequest registerActivityTypeRequest) throws AmazonServiceException, AmazonClientException
Registers a new activity type along with its configuration settings in the specified domain.
IMPORTANT: A TypeAlreadyExists fault is returned if the type already exists in the domain. You cannot change any configuration settings of the type after its registration, and it must be registered as a new version.
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 : 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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
registerActivityTypeRequest - Container for the necessary
parameters to execute the RegisterActivityType operation on
AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<Void> registerActivityTypeAsync(RegisterActivityTypeRequest registerActivityTypeRequest, AsyncHandler<RegisterActivityTypeRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Registers a new activity type along with its configuration settings in the specified domain.
IMPORTANT: A TypeAlreadyExists fault is returned if the type already exists in the domain. You cannot change any configuration settings of the type after its registration, and it must be registered as a new version.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 : 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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
registerActivityTypeRequest - Container for the necessary
parameters to execute the RegisterActivityType operation on
AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<WorkflowExecutionInfos> listClosedWorkflowExecutionsAsync(ListClosedWorkflowExecutionsRequest listClosedWorkflowExecutionsRequest) throws AmazonServiceException, AmazonClientException
Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
NOTE: This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
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.
tag : String constraint. The key is
swf:tagFilter.tag .typeFilter.name : String constraint. String
constraint. The key is swf:typeFilter.name .typeFilter.version : String constraint. String
constraint. The key is swf:typeFilter.version .
If the caller does not have sufficient permissions to invoke the
action, or the parameter values fall outside the specified
constraints, the action fails by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
listClosedWorkflowExecutionsRequest - Container for the necessary
parameters to execute the ListClosedWorkflowExecutions operation on
AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<WorkflowExecutionInfos> listClosedWorkflowExecutionsAsync(ListClosedWorkflowExecutionsRequest listClosedWorkflowExecutionsRequest, AsyncHandler<ListClosedWorkflowExecutionsRequest,WorkflowExecutionInfos> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
NOTE: This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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.
tag : String constraint. The key is
swf:tagFilter.tag .typeFilter.name : String constraint. String
constraint. The key is swf:typeFilter.name .typeFilter.version : String constraint. String
constraint. The key is swf:typeFilter.version .
If the caller does not have sufficient permissions to invoke the
action, or the parameter values fall outside the specified
constraints, the action fails by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
listClosedWorkflowExecutionsRequest - Container for the necessary
parameters to execute the ListClosedWorkflowExecutions operation on
AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<ActivityTaskStatus> recordActivityTaskHeartbeatAsync(RecordActivityTaskHeartbeatRequest recordActivityTaskHeartbeatRequest) throws AmazonServiceException, AmazonClientException
Used by activity workers to report to the service that the
ActivityTask represented by the specified taskToken is
still making progress. The worker can also (optionally) specify
details of the progress, for example percent complete, using the
details parameter. This action can also be used by the
worker as a mechanism to check if cancellation is being requested for
the activity task. If a cancellation is being attempted for the
specified task, then the boolean cancelRequested flag
returned by the service is set to true .
This action resets the taskHeartbeatTimeout clock. The
taskHeartbeatTimeout is specified in
RegisterActivityType.
This action does not in itself create an event in the workflow
execution history. However, if the task times out, the workflow
execution history will contain a ActivityTaskTimedOut
event that contains the information from the last heartbeat generated
by the activity worker.
NOTE: The taskStartToCloseTimeout of an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. The taskStartToCloseTimeout is also specified in RegisterActivityType.
NOTE: This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted.
IMPORTANT: If the cancelRequested flag returns true, a cancellation is being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request.
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
recordActivityTaskHeartbeatRequest - Container for the necessary
parameters to execute the RecordActivityTaskHeartbeat operation on
AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<ActivityTaskStatus> recordActivityTaskHeartbeatAsync(RecordActivityTaskHeartbeatRequest recordActivityTaskHeartbeatRequest, AsyncHandler<RecordActivityTaskHeartbeatRequest,ActivityTaskStatus> asyncHandler) throws AmazonServiceException, AmazonClientException
Used by activity workers to report to the service that the
ActivityTask represented by the specified taskToken is
still making progress. The worker can also (optionally) specify
details of the progress, for example percent complete, using the
details parameter. This action can also be used by the
worker as a mechanism to check if cancellation is being requested for
the activity task. If a cancellation is being attempted for the
specified task, then the boolean cancelRequested flag
returned by the service is set to true .
This action resets the taskHeartbeatTimeout clock. The
taskHeartbeatTimeout is specified in
RegisterActivityType.
This action does not in itself create an event in the workflow
execution history. However, if the task times out, the workflow
execution history will contain a ActivityTaskTimedOut
event that contains the information from the last heartbeat generated
by the activity worker.
NOTE: The taskStartToCloseTimeout of an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. The taskStartToCloseTimeout is also specified in RegisterActivityType.
NOTE: This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted.
IMPORTANT: If the cancelRequested flag returns true, a cancellation is being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
recordActivityTaskHeartbeatRequest - Container for the necessary
parameters to execute the RecordActivityTaskHeartbeat operation on
AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<DecisionTask> pollForDecisionTaskAsync(PollForDecisionTaskRequest pollForDecisionTaskRequest) throws AmazonServiceException, AmazonClientException
Used by deciders to get a DecisionTask from the specified decision
taskList . A decision task may be returned for any open
workflow execution that is using the specified task list. The task
includes a paginated view of the history of the workflow execution.
The decider should use the workflow type and the history to determine
how to properly handle the task.
This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned, but that the value of taskToken is an empty string.
IMPORTANT: Deciders should set their client side socket timeout to at least 70 seconds (10 seconds higher than the timeout).
IMPORTANT: Because the number of workflow history events for a single workflow execution might be very large, the result returned might be split up across a number of pages. To retrieve subsequent pages, make additional calls to PollForDecisionTask using the nextPageToken returned by the initial call. Note that you do not call GetWorkflowExecutionHistory with this nextPageToken. Instead, call PollForDecisionTask again.
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.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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
pollForDecisionTaskRequest - Container for the necessary
parameters to execute the PollForDecisionTask operation on
AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<DecisionTask> pollForDecisionTaskAsync(PollForDecisionTaskRequest pollForDecisionTaskRequest, AsyncHandler<PollForDecisionTaskRequest,DecisionTask> asyncHandler) throws AmazonServiceException, AmazonClientException
Used by deciders to get a DecisionTask from the specified decision
taskList . A decision task may be returned for any open
workflow execution that is using the specified task list. The task
includes a paginated view of the history of the workflow execution.
The decider should use the workflow type and the history to determine
how to properly handle the task.
This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned, but that the value of taskToken is an empty string.
IMPORTANT: Deciders should set their client side socket timeout to at least 70 seconds (10 seconds higher than the timeout).
IMPORTANT: Because the number of workflow history events for a single workflow execution might be very large, the result returned might be split up across a number of pages. To retrieve subsequent pages, make additional calls to PollForDecisionTask using the nextPageToken returned by the initial call. Note that you do not call GetWorkflowExecutionHistory with this nextPageToken. Instead, call PollForDecisionTask again.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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.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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
pollForDecisionTaskRequest - Container for the necessary
parameters to execute the PollForDecisionTask operation on
AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<ActivityTypeInfos> listActivityTypesAsync(ListActivityTypesRequest listActivityTypesRequest) throws AmazonServiceException, AmazonClientException
Returns information about all activities registered in the specified
domain that match the specified name and registration status. The
result includes information like creation date, current status of the
activity, etc. The results may be split into multiple pages. To
retrieve subsequent pages, make the call again using the
nextPageToken returned by the initial call.
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
listActivityTypesRequest - Container for the necessary parameters
to execute the ListActivityTypes operation on AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<ActivityTypeInfos> listActivityTypesAsync(ListActivityTypesRequest listActivityTypesRequest, AsyncHandler<ListActivityTypesRequest,ActivityTypeInfos> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns information about all activities registered in the specified
domain that match the specified name and registration status. The
result includes information like creation date, current status of the
activity, etc. The results may be split into multiple pages. To
retrieve subsequent pages, make the call again using the
nextPageToken returned by the initial call.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
listActivityTypesRequest - Container for the necessary parameters
to execute the ListActivityTypes operation on AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<DomainDetail> describeDomainAsync(DescribeDomainRequest describeDomainRequest) throws AmazonServiceException, AmazonClientException
Returns information about the specified domain including description and status.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
describeDomainRequest - Container for the necessary parameters to
execute the DescribeDomain operation on AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<DomainDetail> describeDomainAsync(DescribeDomainRequest describeDomainRequest, AsyncHandler<DescribeDomainRequest,DomainDetail> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns information about the specified domain including description and status.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
describeDomainRequest - Container for the necessary parameters to
execute the DescribeDomain operation on AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<Void> respondActivityTaskFailedAsync(RespondActivityTaskFailedRequest respondActivityTaskFailedRequest) throws AmazonServiceException, AmazonClientException
Used by workers to tell the service that the ActivityTask identified
by the taskToken has failed with reason (if
specified). The reason and details appear in
the ActivityTaskFailed event added to the workflow
history.
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
respondActivityTaskFailedRequest - Container for the necessary
parameters to execute the RespondActivityTaskFailed operation on
AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<Void> respondActivityTaskFailedAsync(RespondActivityTaskFailedRequest respondActivityTaskFailedRequest, AsyncHandler<RespondActivityTaskFailedRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Used by workers to tell the service that the ActivityTask identified
by the taskToken has failed with reason (if
specified). The reason and details appear in
the ActivityTaskFailed event added to the workflow
history.
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
respondActivityTaskFailedRequest - Container for the necessary
parameters to execute the RespondActivityTaskFailed operation on
AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<PendingTaskCount> countPendingDecisionTasksAsync(CountPendingDecisionTasksRequest countPendingDecisionTasksRequest) throws AmazonServiceException, AmazonClientException
Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then 0 will be returned.
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.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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
countPendingDecisionTasksRequest - Container for the necessary
parameters to execute the CountPendingDecisionTasks operation on
AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<PendingTaskCount> countPendingDecisionTasksAsync(CountPendingDecisionTasksRequest countPendingDecisionTasksRequest, AsyncHandler<CountPendingDecisionTasksRequest,PendingTaskCount> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then 0 will be returned.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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.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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
countPendingDecisionTasksRequest - Container for the necessary
parameters to execute the CountPendingDecisionTasks operation on
AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<Void> terminateWorkflowExecutionAsync(TerminateWorkflowExecutionRequest terminateWorkflowExecutionRequest) throws AmazonServiceException, AmazonClientException
Records a WorkflowExecutionTerminated event and forces
closure of the workflow execution identified by the given domain,
runId, and workflowId. The child policy, registered with the workflow
type or specified when starting this execution, is applied to any open
child workflow executions of this workflow execution.
IMPORTANT: If the identified workflow execution was in progress, it is terminated immediately.
NOTE: If a runId is not specified, then the WorkflowExecutionTerminated event is recorded in the history of the current open workflow with the matching workflowId in the domain.
NOTE: You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution does not.
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
terminateWorkflowExecutionRequest - Container for the necessary
parameters to execute the TerminateWorkflowExecution operation on
AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<Void> terminateWorkflowExecutionAsync(TerminateWorkflowExecutionRequest terminateWorkflowExecutionRequest, AsyncHandler<TerminateWorkflowExecutionRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Records a WorkflowExecutionTerminated event and forces
closure of the workflow execution identified by the given domain,
runId, and workflowId. The child policy, registered with the workflow
type or specified when starting this execution, is applied to any open
child workflow executions of this workflow execution.
IMPORTANT: If the identified workflow execution was in progress, it is terminated immediately.
NOTE: If a runId is not specified, then the WorkflowExecutionTerminated event is recorded in the history of the current open workflow with the matching workflowId in the domain.
NOTE: You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution does not.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
terminateWorkflowExecutionRequest - Container for the necessary
parameters to execute the TerminateWorkflowExecution operation on
AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<WorkflowExecutionDetail> describeWorkflowExecutionAsync(DescribeWorkflowExecutionRequest describeWorkflowExecutionRequest) throws AmazonServiceException, AmazonClientException
Returns information about the specified workflow execution including its type and some statistics.
NOTE: This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
describeWorkflowExecutionRequest - Container for the necessary
parameters to execute the DescribeWorkflowExecution operation on
AmazonSimpleWorkflow.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Future<WorkflowExecutionDetail> describeWorkflowExecutionAsync(DescribeWorkflowExecutionRequest describeWorkflowExecutionRequest, AsyncHandler<DescribeWorkflowExecutionRequest,WorkflowExecutionDetail> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns information about the specified workflow execution including its type and some statistics.
NOTE: This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 by throwing
OperationNotPermitted . For details and example IAM
policies, see
Using IAM to Manage Access to Amazon SWF Workflows
.
describeWorkflowExecutionRequest - Container for the necessary
parameters to execute the DescribeWorkflowExecution operation on
AmazonSimpleWorkflow.asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.AmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSimpleWorkflow indicating
either a problem with the data in the request, or a server side issue.Copyright © 2014. All rights reserved.