AutoCloseable@Generated("software.amazon.awssdk:codegen") public interface SWFClient extends AutoCloseable
builder() method.
The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to coordinate work across distributed components. In Amazon SWF, a task represents a logical unit of work that is performed by a component of your workflow. Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and concurrency in accordance with the logical flow of the application.
Amazon SWF gives you full control over implementing tasks and coordinating them without worrying about underlying complexities such as tracking their progress and maintaining their state.
This documentation serves as reference only. For a broader overview of the Amazon SWF programming model, see the Amazon SWF Developer Guide.
| Modifier and Type | Field | Description |
|---|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method | Description |
|---|---|---|
static SWFClientBuilder |
builder() |
Create a builder that can be used to configure and create a
SWFClient. |
default CountClosedWorkflowExecutionsResponse |
countClosedWorkflowExecutions(CountClosedWorkflowExecutionsRequest countClosedWorkflowExecutionsRequest) |
Returns the number of closed workflow executions within the given domain that meet the specified filtering
criteria.
|
default CountOpenWorkflowExecutionsResponse |
countOpenWorkflowExecutions(CountOpenWorkflowExecutionsRequest countOpenWorkflowExecutionsRequest) |
Returns the number of open workflow executions within the given domain that meet the specified filtering
criteria.
|
default CountPendingActivityTasksResponse |
countPendingActivityTasks(CountPendingActivityTasksRequest countPendingActivityTasksRequest) |
Returns the estimated number of activity tasks in the specified task list.
|
default CountPendingDecisionTasksResponse |
countPendingDecisionTasks(CountPendingDecisionTasksRequest countPendingDecisionTasksRequest) |
Returns the estimated number of decision tasks in the specified task list.
|
static SWFClient |
create() |
Create a
SWFClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default DeprecateActivityTypeResponse |
deprecateActivityType(DeprecateActivityTypeRequest deprecateActivityTypeRequest) |
Deprecates the specified activity type.
|
default DeprecateDomainResponse |
deprecateDomain(DeprecateDomainRequest deprecateDomainRequest) |
Deprecates the specified domain.
|
default DeprecateWorkflowTypeResponse |
deprecateWorkflowType(DeprecateWorkflowTypeRequest deprecateWorkflowTypeRequest) |
Deprecates the specified workflow type.
|
default DescribeActivityTypeResponse |
describeActivityType(DescribeActivityTypeRequest describeActivityTypeRequest) |
Returns information about the specified activity type.
|
default DescribeDomainResponse |
describeDomain(DescribeDomainRequest describeDomainRequest) |
Returns information about the specified domain, including description and status.
|
default DescribeWorkflowExecutionResponse |
describeWorkflowExecution(DescribeWorkflowExecutionRequest describeWorkflowExecutionRequest) |
Returns information about the specified workflow execution including its type and some statistics.
|
default DescribeWorkflowTypeResponse |
describeWorkflowType(DescribeWorkflowTypeRequest describeWorkflowTypeRequest) |
Returns information about the specified workflow type.
|
default GetWorkflowExecutionHistoryResponse |
getWorkflowExecutionHistory(GetWorkflowExecutionHistoryRequest getWorkflowExecutionHistoryRequest) |
Returns the history of the specified workflow execution.
|
default ListActivityTypesResponse |
listActivityTypes(ListActivityTypesRequest listActivityTypesRequest) |
Returns information about all activities registered in the specified domain that match the specified name and
registration status.
|
default ListClosedWorkflowExecutionsResponse |
listClosedWorkflowExecutions(ListClosedWorkflowExecutionsRequest listClosedWorkflowExecutionsRequest) |
Returns a list of closed workflow executions in the specified domain that meet the filtering criteria.
|
default ListDomainsResponse |
listDomains(ListDomainsRequest listDomainsRequest) |
Returns the list of domains registered in the account.
|
default ListOpenWorkflowExecutionsResponse |
listOpenWorkflowExecutions(ListOpenWorkflowExecutionsRequest listOpenWorkflowExecutionsRequest) |
Returns a list of open workflow executions in the specified domain that meet the filtering criteria.
|
default ListWorkflowTypesResponse |
listWorkflowTypes(ListWorkflowTypesRequest listWorkflowTypesRequest) |
Returns information about workflow types in the specified domain.
|
default PollForActivityTaskResponse |
pollForActivityTask(PollForActivityTaskRequest pollForActivityTaskRequest) |
Used by workers to get an ActivityTask from the specified activity
taskList. |
default PollForDecisionTaskResponse |
pollForDecisionTask(PollForDecisionTaskRequest pollForDecisionTaskRequest) |
Used by deciders to get a DecisionTask from the specified decision
taskList. |
default RecordActivityTaskHeartbeatResponse |
recordActivityTaskHeartbeat(RecordActivityTaskHeartbeatRequest recordActivityTaskHeartbeatRequest) |
Used by activity workers to report to the service that the ActivityTask represented by the specified
taskToken is still making progress. |
default RegisterActivityTypeResponse |
registerActivityType(RegisterActivityTypeRequest registerActivityTypeRequest) |
Registers a new activity type along with its configuration settings in the specified domain.
|
default RegisterDomainResponse |
registerDomain(RegisterDomainRequest registerDomainRequest) |
Registers a new domain.
|
default RegisterWorkflowTypeResponse |
registerWorkflowType(RegisterWorkflowTypeRequest registerWorkflowTypeRequest) |
Registers a new workflow type and its configuration settings in the specified domain.
|
default RequestCancelWorkflowExecutionResponse |
requestCancelWorkflowExecution(RequestCancelWorkflowExecutionRequest requestCancelWorkflowExecutionRequest) |
Records a
WorkflowExecutionCancelRequested event in the currently running workflow execution
identified by the given domain, workflowId, and runId. |
default RespondActivityTaskCanceledResponse |
respondActivityTaskCanceled(RespondActivityTaskCanceledRequest respondActivityTaskCanceledRequest) |
Used by workers to tell the service that the ActivityTask identified by the
taskToken was
successfully canceled. |
default RespondActivityTaskCompletedResponse |
respondActivityTaskCompleted(RespondActivityTaskCompletedRequest respondActivityTaskCompletedRequest) |
Used by workers to tell the service that the ActivityTask identified by the
taskToken
completed successfully with a result (if provided). |
default RespondActivityTaskFailedResponse |
respondActivityTaskFailed(RespondActivityTaskFailedRequest respondActivityTaskFailedRequest) |
Used by workers to tell the service that the ActivityTask identified by the
taskToken has
failed with reason (if specified). |
default RespondDecisionTaskCompletedResponse |
respondDecisionTaskCompleted(RespondDecisionTaskCompletedRequest respondDecisionTaskCompletedRequest) |
Used by deciders to tell the service that the DecisionTask identified by the
taskToken has
successfully completed. |
static ServiceMetadata |
serviceMetadata() |
|
default SignalWorkflowExecutionResponse |
signalWorkflowExecution(SignalWorkflowExecutionRequest signalWorkflowExecutionRequest) |
Records a
WorkflowExecutionSignaled event in the workflow execution history and creates a decision
task for the workflow execution identified by the given domain, workflowId and runId. |
default StartWorkflowExecutionResponse |
startWorkflowExecution(StartWorkflowExecutionRequest startWorkflowExecutionRequest) |
Starts an execution of the workflow type in the specified domain using the provided
workflowId and
input data. |
default TerminateWorkflowExecutionResponse |
terminateWorkflowExecution(TerminateWorkflowExecutionRequest terminateWorkflowExecutionRequest) |
Records a
WorkflowExecutionTerminated event and forces closure of the workflow execution identified
by the given domain, runId, and workflowId. |
closestatic final String SERVICE_NAME
static SWFClient create()
SWFClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static SWFClientBuilder builder()
SWFClient.default CountClosedWorkflowExecutionsResponse countClosedWorkflowExecutions(CountClosedWorkflowExecutionsRequest countClosedWorkflowExecutionsRequest) throws UnknownResourceException, OperationNotPermittedException, SdkBaseException, SdkClientException, SWFException
Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys.
tagFilter.tag: String constraint. The key is swf:tagFilter.tag.typeFilter.name: String constraint. The key is swf:typeFilter.name.typeFilter.version: String constraint. The key is swf:typeFilter.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
countClosedWorkflowExecutionsRequest - UnknownResourceException - Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CountOpenWorkflowExecutionsResponse countOpenWorkflowExecutions(CountOpenWorkflowExecutionsRequest countOpenWorkflowExecutionsRequest) throws UnknownResourceException, OperationNotPermittedException, SdkBaseException, SdkClientException, SWFException
Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys.
tagFilter.tag: String constraint. The key is swf:tagFilter.tag.typeFilter.name: String constraint. The key is swf:typeFilter.name.typeFilter.version: String constraint. The key is swf:typeFilter.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
countOpenWorkflowExecutionsRequest - UnknownResourceException - Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CountPendingActivityTasksResponse countPendingActivityTasks(CountPendingActivityTasksRequest countPendingActivityTasksRequest) throws UnknownResourceException, OperationNotPermittedException, SdkBaseException, SdkClientException, SWFException
Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 will be returned.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.taskList.name parameter by using a Condition element with the
swf:taskList.name key to allow the action to access only certain task lists.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
countPendingActivityTasksRequest - UnknownResourceException - Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CountPendingDecisionTasksResponse countPendingDecisionTasks(CountPendingDecisionTasksRequest countPendingDecisionTasksRequest) throws UnknownResourceException, OperationNotPermittedException, SdkBaseException, SdkClientException, SWFException
Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then 0 will be returned.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.taskList.name parameter by using a Condition element with the
swf:taskList.name key to allow the action to access only certain task lists.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
countPendingDecisionTasksRequest - UnknownResourceException - Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeprecateActivityTypeResponse deprecateActivityType(DeprecateActivityTypeRequest deprecateActivityTypeRequest) throws UnknownResourceException, TypeDeprecatedException, OperationNotPermittedException, SdkBaseException, SdkClientException, SWFException
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.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys.
activityType.name: String constraint. The key is swf:activityType.name.activityType.version: String constraint. The key is swf:activityType.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
deprecateActivityTypeRequest - UnknownResourceException - Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.TypeDeprecatedException - Returned when the specified activity or workflow type was already deprecated.OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeprecateDomainResponse deprecateDomain(DeprecateDomainRequest deprecateDomainRequest) throws UnknownResourceException, DomainDeprecatedException, OperationNotPermittedException, SdkBaseException, SdkClientException, SWFException
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.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
deprecateDomainRequest - UnknownResourceException - Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.DomainDeprecatedException - Returned when the specified domain has been deprecated.OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeprecateWorkflowTypeResponse deprecateWorkflowType(DeprecateWorkflowTypeRequest deprecateWorkflowTypeRequest) throws UnknownResourceException, TypeDeprecatedException, OperationNotPermittedException, SdkBaseException, SdkClientException, SWFException
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.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys.
workflowType.name: String constraint. The key is swf:workflowType.name.workflowType.version: String constraint. The key is swf:workflowType.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
deprecateWorkflowTypeRequest - UnknownResourceException - Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.TypeDeprecatedException - Returned when the specified activity or workflow type was already deprecated.OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeActivityTypeResponse describeActivityType(DescribeActivityTypeRequest describeActivityTypeRequest) throws UnknownResourceException, OperationNotPermittedException, SdkBaseException, SdkClientException, SWFException
Returns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys.
activityType.name: String constraint. The key is swf:activityType.name.activityType.version: String constraint. The key is swf:activityType.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
describeActivityTypeRequest - UnknownResourceException - Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeDomainResponse describeDomain(DescribeDomainRequest describeDomainRequest) throws UnknownResourceException, OperationNotPermittedException, SdkBaseException, SdkClientException, SWFException
Returns information about the specified domain, including description and status.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
describeDomainRequest - UnknownResourceException - Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeWorkflowExecutionResponse describeWorkflowExecution(DescribeWorkflowExecutionRequest describeWorkflowExecutionRequest) throws UnknownResourceException, OperationNotPermittedException, SdkBaseException, SdkClientException, SWFException
Returns information about the specified workflow execution including its type and some statistics.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
describeWorkflowExecutionRequest - UnknownResourceException - Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeWorkflowTypeResponse describeWorkflowType(DescribeWorkflowTypeRequest describeWorkflowTypeRequest) throws UnknownResourceException, OperationNotPermittedException, SdkBaseException, SdkClientException, SWFException
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, and so on.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys.
workflowType.name: String constraint. The key is swf:workflowType.name.workflowType.version: String constraint. The key is swf:workflowType.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
describeWorkflowTypeRequest - UnknownResourceException - Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetWorkflowExecutionHistoryResponse getWorkflowExecutionHistory(GetWorkflowExecutionHistoryRequest getWorkflowExecutionHistoryRequest) throws UnknownResourceException, OperationNotPermittedException, SdkBaseException, SdkClientException, SWFException
Returns the history of the specified workflow execution. The results may be split into multiple pages. To
retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
getWorkflowExecutionHistoryRequest - UnknownResourceException - Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListActivityTypesResponse listActivityTypes(ListActivityTypesRequest listActivityTypesRequest) throws OperationNotPermittedException, UnknownResourceException, SdkBaseException, SdkClientException, SWFException
Returns information about all activities registered in the specified domain that match the specified name and
registration status. The result includes information like creation date, current status of the activity, etc. The
results may be split into multiple pages. To retrieve subsequent pages, make the call again using the
nextPageToken returned by the initial call.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
listActivityTypesRequest - OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.UnknownResourceException - Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListClosedWorkflowExecutionsResponse listClosedWorkflowExecutions(ListClosedWorkflowExecutionsRequest listClosedWorkflowExecutionsRequest) throws UnknownResourceException, OperationNotPermittedException, SdkBaseException, SdkClientException, SWFException
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.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys.
tagFilter.tag: String constraint. The key is swf:tagFilter.tag.typeFilter.name: String constraint. The key is swf:typeFilter.name.typeFilter.version: String constraint. The key is swf:typeFilter.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
listClosedWorkflowExecutionsRequest - UnknownResourceException - Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListDomainsResponse listDomains(ListDomainsRequest listDomainsRequest) throws OperationNotPermittedException, SdkBaseException, SdkClientException, SWFException
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.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains. The
element must be set to arn:aws:swf::AccountID:domain/*, where AccountID is the account ID,
with no dashes.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
listDomainsRequest - OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListOpenWorkflowExecutionsResponse listOpenWorkflowExecutions(ListOpenWorkflowExecutionsRequest listOpenWorkflowExecutionsRequest) throws UnknownResourceException, OperationNotPermittedException, SdkBaseException, SdkClientException, SWFException
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.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys.
tagFilter.tag: String constraint. The key is swf:tagFilter.tag.typeFilter.name: String constraint. The key is swf:typeFilter.name.typeFilter.version: String constraint. The key is swf:typeFilter.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
listOpenWorkflowExecutionsRequest - UnknownResourceException - Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListWorkflowTypesResponse listWorkflowTypes(ListWorkflowTypesRequest listWorkflowTypesRequest) throws OperationNotPermittedException, UnknownResourceException, SdkBaseException, SdkClientException, SWFException
Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
listWorkflowTypesRequest - OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.UnknownResourceException - Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault PollForActivityTaskResponse pollForActivityTask(PollForActivityTaskRequest pollForActivityTaskRequest) throws UnknownResourceException, OperationNotPermittedException, LimitExceededException, SdkBaseException, SdkClientException, SWFException
Used by workers to get an ActivityTask from the specified activity taskList. This initiates a
long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available. The
maximum time the service holds on to the request before responding is 60 seconds. If no task is available within
60 seconds, the poll will return an empty result. An empty result, in this context, means that an ActivityTask is
returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its
type to identify and process it correctly.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.taskList.name parameter by using a Condition element with the
swf:taskList.name key to allow the action to access only certain task lists.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
pollForActivityTaskRequest - UnknownResourceException - Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.LimitExceededException - Returned by any operation if a system imposed limitation has been reached. To address this fault you
should either clean up unused resources or increase the limit by contacting AWS.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault PollForDecisionTaskResponse pollForDecisionTask(PollForDecisionTaskRequest pollForDecisionTaskRequest) throws UnknownResourceException, OperationNotPermittedException, LimitExceededException, SdkBaseException, SdkClientException, SWFException
Used by deciders to get a DecisionTask from the specified decision taskList. A decision task
may be returned for any open workflow execution that is using the specified task list. The task includes a
paginated view of the history of the workflow execution. The decider should use the workflow type and the history
to determine how to properly handle the task.
This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task
becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds
expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned,
but that the value of taskToken is an empty string.
PollForDecisionTask using the nextPageToken
returned by the initial call. Note that you do not call GetWorkflowExecutionHistory with this
nextPageToken. Instead, call PollForDecisionTask again.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.taskList.name parameter by using a Condition element with the
swf:taskList.name key to allow the action to access only certain task lists.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
pollForDecisionTaskRequest - UnknownResourceException - Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.LimitExceededException - Returned by any operation if a system imposed limitation has been reached. To address this fault you
should either clean up unused resources or increase the limit by contacting AWS.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RecordActivityTaskHeartbeatResponse recordActivityTaskHeartbeat(RecordActivityTaskHeartbeatRequest recordActivityTaskHeartbeatRequest) throws UnknownResourceException, OperationNotPermittedException, SdkBaseException, SdkClientException, SWFException
Used by activity workers to report to the service that the ActivityTask represented by the specified
taskToken is still making progress. The worker can also (optionally) specify details of the
progress, for example percent complete, using the details parameter. This action can also be used by
the worker as a mechanism to check if cancellation is being requested for the activity task. If a cancellation is
being attempted for the specified task, then the boolean cancelRequested flag returned by the
service is set to true.
This action resets the taskHeartbeatTimeout clock. The taskHeartbeatTimeout is
specified in RegisterActivityType.
This action does not in itself create an event in the workflow execution history. However, if the task times out,
the workflow execution history will contain a ActivityTaskTimedOut event that contains the
information from the last heartbeat generated by the activity worker.
taskStartToCloseTimeout of an activity type is the maximum duration of an activity task,
regardless of the number of RecordActivityTaskHeartbeat requests received. The
taskStartToCloseTimeout is also specified in RegisterActivityType.cancelRequested flag returns
true, a cancellation is being attempted. If the worker can cancel the activity, it should respond
with RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
recordActivityTaskHeartbeatRequest - UnknownResourceException - Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RegisterActivityTypeResponse registerActivityType(RegisterActivityTypeRequest registerActivityTypeRequest) throws TypeAlreadyExistsException, LimitExceededException, UnknownResourceException, OperationNotPermittedException, SdkBaseException, SdkClientException, SWFException
Registers a new activity type along with its configuration settings in the specified domain.
TypeAlreadyExists fault is returned if the type already exists in the domain. You
cannot change any configuration settings of the type after its registration, and it must be registered as a new
version.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys.
defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.name: String constraint. The key is swf:name.version: String constraint. The key is swf:version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
registerActivityTypeRequest - TypeAlreadyExistsException - Returned if the type already exists in the specified domain. You will get this fault even if the existing
type is in deprecated status. You can specify another version if the intent is to create a new distinct
version of the type.LimitExceededException - Returned by any operation if a system imposed limitation has been reached. To address this fault you
should either clean up unused resources or increase the limit by contacting AWS.UnknownResourceException - Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RegisterDomainResponse registerDomain(RegisterDomainRequest registerDomainRequest) throws DomainAlreadyExistsException, LimitExceededException, OperationNotPermittedException, SdkBaseException, SdkClientException, SWFException
Registers a new domain.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
registerDomainRequest - DomainAlreadyExistsException - Returned if the specified domain already exists. You will get this fault even if the existing domain is
in deprecated status.LimitExceededException - Returned by any operation if a system imposed limitation has been reached. To address this fault you
should either clean up unused resources or increase the limit by contacting AWS.OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RegisterWorkflowTypeResponse registerWorkflowType(RegisterWorkflowTypeRequest registerWorkflowTypeRequest) throws TypeAlreadyExistsException, LimitExceededException, UnknownResourceException, OperationNotPermittedException, SdkBaseException, SdkClientException, SWFException
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.
TypeAlreadyExists fault is returned. You cannot change
the configuration settings of a workflow type once it is registered and it must be registered as a new
version.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys.
defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.name: String constraint. The key is swf:name.version: String constraint. The key is swf:version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
registerWorkflowTypeRequest - TypeAlreadyExistsException - Returned if the type already exists in the specified domain. You will get this fault even if the existing
type is in deprecated status. You can specify another version if the intent is to create a new distinct
version of the type.LimitExceededException - Returned by any operation if a system imposed limitation has been reached. To address this fault you
should either clean up unused resources or increase the limit by contacting AWS.UnknownResourceException - Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RequestCancelWorkflowExecutionResponse requestCancelWorkflowExecution(RequestCancelWorkflowExecutionRequest requestCancelWorkflowExecutionRequest) throws UnknownResourceException, OperationNotPermittedException, SdkBaseException, SdkClientException, SWFException
Records a WorkflowExecutionCancelRequested event in the currently running workflow execution
identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow
execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history
with this event.
WorkflowExecutionCancelRequested event is recorded in the
history of the current open workflow execution with the specified workflowId in the domain.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
requestCancelWorkflowExecutionRequest - UnknownResourceException - Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RespondActivityTaskCanceledResponse respondActivityTaskCanceled(RespondActivityTaskCanceledRequest respondActivityTaskCanceledRequest) throws UnknownResourceException, OperationNotPermittedException, SdkBaseException, SdkClientException, SWFException
Used by workers to tell the service that the ActivityTask identified by the taskToken was
successfully canceled. Additional details can be optionally provided using the details
argument.
These details (if provided) appear in the ActivityTaskCanceled event added to the
workflow history.
canceled flag of a RecordActivityTaskHeartbeat
request returns true and if the activity can be safely undone or abandoned.A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
respondActivityTaskCanceledRequest - UnknownResourceException - Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RespondActivityTaskCompletedResponse respondActivityTaskCompleted(RespondActivityTaskCompletedRequest respondActivityTaskCompletedRequest) throws UnknownResourceException, OperationNotPermittedException, SdkBaseException, SdkClientException, SWFException
Used by workers to tell the service that the ActivityTask identified by the taskToken
completed successfully with a result (if provided). The result appears in the
ActivityTaskCompleted event in the workflow history.
canceled flag returned by
RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call
RespondActivityTaskCanceled.A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
respondActivityTaskCompletedRequest - UnknownResourceException - Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RespondActivityTaskFailedResponse respondActivityTaskFailed(RespondActivityTaskFailedRequest respondActivityTaskFailedRequest) throws UnknownResourceException, OperationNotPermittedException, SdkBaseException, SdkClientException, SWFException
Used by workers to tell the service that the ActivityTask identified by the taskToken has
failed with reason (if specified). The reason and details appear in the
ActivityTaskFailed event added to the workflow history.
A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
respondActivityTaskFailedRequest - UnknownResourceException - Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RespondDecisionTaskCompletedResponse respondDecisionTaskCompleted(RespondDecisionTaskCompletedRequest respondDecisionTaskCompletedRequest) throws UnknownResourceException, OperationNotPermittedException, SdkBaseException, SdkClientException, SWFException
Used by deciders to tell the service that the DecisionTask identified by the taskToken has
successfully completed. The decisions argument specifies the list of decisions made while processing
the task.
A DecisionTaskCompleted event is added to the workflow history. The executionContext
specified is attached to the event in the workflow execution history.
Access Control
If an IAM policy grants permission to use RespondDecisionTaskCompleted, it can express permissions
for the list of decisions in the decisions parameter. Each of the decisions has one or more
parameters, much like a regular API call. To allow for policies to be as readable as possible, you can express
permissions on decisions as if they were actual API calls, including applying conditions to some parameters. For
more information, see Using
IAM to Manage Access to Amazon SWF Workflows.
respondDecisionTaskCompletedRequest - UnknownResourceException - Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault SignalWorkflowExecutionResponse signalWorkflowExecution(SignalWorkflowExecutionRequest signalWorkflowExecutionRequest) throws UnknownResourceException, OperationNotPermittedException, SdkBaseException, SdkClientException, SWFException
Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision
task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with
the specified user defined signalName and input (if provided).
WorkflowExecutionSignaled event is recorded in the
history of the current open workflow with the matching workflowId in the domain.UnknownResource.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
signalWorkflowExecutionRequest - UnknownResourceException - Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault StartWorkflowExecutionResponse startWorkflowExecution(StartWorkflowExecutionRequest startWorkflowExecutionRequest) throws UnknownResourceException, TypeDeprecatedException, WorkflowExecutionAlreadyStartedException, LimitExceededException, OperationNotPermittedException, DefaultUndefinedException, SdkBaseException, SdkClientException, SWFException
Starts an execution of the workflow type in the specified domain using the provided workflowId and
input data.
This action returns the newly started workflow execution.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Condition element with the appropriate keys.
tagList.member.0: The key is swf:tagList.member.0.tagList.member.1: The key is swf:tagList.member.1.tagList.member.2: The key is swf:tagList.member.2.tagList.member.3: The key is swf:tagList.member.3.tagList.member.4: The key is swf:tagList.member.4.taskList: String constraint. The key is swf:taskList.name.workflowType.name: String constraint. The key is swf:workflowType.name.workflowType.version: String constraint. The key is swf:workflowType.version.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
startWorkflowExecutionRequest - UnknownResourceException - Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.TypeDeprecatedException - Returned when the specified activity or workflow type was already deprecated.WorkflowExecutionAlreadyStartedException - Returned by StartWorkflowExecution when an open execution with the same workflowId is already
running in the specified domain.LimitExceededException - Returned by any operation if a system imposed limitation has been reached. To address this fault you
should either clean up unused resources or increase the limit by contacting AWS.OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.DefaultUndefinedExceptionSdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault TerminateWorkflowExecutionResponse terminateWorkflowExecution(TerminateWorkflowExecutionRequest terminateWorkflowExecutionRequest) throws UnknownResourceException, OperationNotPermittedException, SdkBaseException, SdkClientException, SWFException
Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified
by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when
starting this execution, is applied to any open child workflow executions of this workflow execution.
WorkflowExecutionTerminated event is recorded in the
history of the current open workflow with the matching workflowId in the domain.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
terminateWorkflowExecutionRequest - UnknownResourceException - Returned when the named resource cannot be found with in the scope of this operation (region or domain).
This could happen if the named resource was never created or is no longer available for this operation.OperationNotPermittedException - Returned when the caller does not have sufficient permissions to invoke the action.SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)SWFException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typestatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.