Interface SwfClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface SwfClient extends AwsClient
Service client for accessing Amazon SWF. This can be created using the staticbuilder()method.Amazon Simple Workflow Service The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to coordinate work across distributed components. In Amazon SWF, a task represents a logical unit of work that is performed by a component of your workflow. Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and concurrency in accordance with the logical flow of the application.
Amazon SWF gives you full control over implementing tasks and coordinating them without worrying about underlying complexities such as tracking their progress and maintaining their state.
This documentation serves as reference only. For a broader overview of the Amazon SWF programming model, see the Amazon SWF Developer Guide .
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static SwfClientBuilderbuilder()Create a builder that can be used to configure and create aSwfClient.default CountClosedWorkflowExecutionsResponsecountClosedWorkflowExecutions(Consumer<CountClosedWorkflowExecutionsRequest.Builder> countClosedWorkflowExecutionsRequest)Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.default CountClosedWorkflowExecutionsResponsecountClosedWorkflowExecutions(CountClosedWorkflowExecutionsRequest countClosedWorkflowExecutionsRequest)Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.default CountOpenWorkflowExecutionsResponsecountOpenWorkflowExecutions(Consumer<CountOpenWorkflowExecutionsRequest.Builder> countOpenWorkflowExecutionsRequest)Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.default CountOpenWorkflowExecutionsResponsecountOpenWorkflowExecutions(CountOpenWorkflowExecutionsRequest countOpenWorkflowExecutionsRequest)Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.default CountPendingActivityTasksResponsecountPendingActivityTasks(Consumer<CountPendingActivityTasksRequest.Builder> countPendingActivityTasksRequest)Returns the estimated number of activity tasks in the specified task list.default CountPendingActivityTasksResponsecountPendingActivityTasks(CountPendingActivityTasksRequest countPendingActivityTasksRequest)Returns the estimated number of activity tasks in the specified task list.default CountPendingDecisionTasksResponsecountPendingDecisionTasks(Consumer<CountPendingDecisionTasksRequest.Builder> countPendingDecisionTasksRequest)Returns the estimated number of decision tasks in the specified task list.default CountPendingDecisionTasksResponsecountPendingDecisionTasks(CountPendingDecisionTasksRequest countPendingDecisionTasksRequest)Returns the estimated number of decision tasks in the specified task list.static SwfClientcreate()Create aSwfClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default DeleteActivityTypeResponsedeleteActivityType(Consumer<DeleteActivityTypeRequest.Builder> deleteActivityTypeRequest)Deletes the specified activity type.default DeleteActivityTypeResponsedeleteActivityType(DeleteActivityTypeRequest deleteActivityTypeRequest)Deletes the specified activity type.default DeleteWorkflowTypeResponsedeleteWorkflowType(Consumer<DeleteWorkflowTypeRequest.Builder> deleteWorkflowTypeRequest)Deletes the specified workflow type.default DeleteWorkflowTypeResponsedeleteWorkflowType(DeleteWorkflowTypeRequest deleteWorkflowTypeRequest)Deletes the specified workflow type.default DeprecateActivityTypeResponsedeprecateActivityType(Consumer<DeprecateActivityTypeRequest.Builder> deprecateActivityTypeRequest)Deprecates the specified activity type.default DeprecateActivityTypeResponsedeprecateActivityType(DeprecateActivityTypeRequest deprecateActivityTypeRequest)Deprecates the specified activity type.default DeprecateDomainResponsedeprecateDomain(Consumer<DeprecateDomainRequest.Builder> deprecateDomainRequest)Deprecates the specified domain.default DeprecateDomainResponsedeprecateDomain(DeprecateDomainRequest deprecateDomainRequest)Deprecates the specified domain.default DeprecateWorkflowTypeResponsedeprecateWorkflowType(Consumer<DeprecateWorkflowTypeRequest.Builder> deprecateWorkflowTypeRequest)Deprecates the specified workflow type.default DeprecateWorkflowTypeResponsedeprecateWorkflowType(DeprecateWorkflowTypeRequest deprecateWorkflowTypeRequest)Deprecates the specified workflow type.default DescribeActivityTypeResponsedescribeActivityType(Consumer<DescribeActivityTypeRequest.Builder> describeActivityTypeRequest)Returns information about the specified activity type.default DescribeActivityTypeResponsedescribeActivityType(DescribeActivityTypeRequest describeActivityTypeRequest)Returns information about the specified activity type.default DescribeDomainResponsedescribeDomain(Consumer<DescribeDomainRequest.Builder> describeDomainRequest)Returns information about the specified domain, including description and status.default DescribeDomainResponsedescribeDomain(DescribeDomainRequest describeDomainRequest)Returns information about the specified domain, including description and status.default DescribeWorkflowExecutionResponsedescribeWorkflowExecution(Consumer<DescribeWorkflowExecutionRequest.Builder> describeWorkflowExecutionRequest)Returns information about the specified workflow execution including its type and some statistics.default DescribeWorkflowExecutionResponsedescribeWorkflowExecution(DescribeWorkflowExecutionRequest describeWorkflowExecutionRequest)Returns information about the specified workflow execution including its type and some statistics.default DescribeWorkflowTypeResponsedescribeWorkflowType(Consumer<DescribeWorkflowTypeRequest.Builder> describeWorkflowTypeRequest)Returns information about the specified workflow type.default DescribeWorkflowTypeResponsedescribeWorkflowType(DescribeWorkflowTypeRequest describeWorkflowTypeRequest)Returns information about the specified workflow type.default GetWorkflowExecutionHistoryResponsegetWorkflowExecutionHistory(Consumer<GetWorkflowExecutionHistoryRequest.Builder> getWorkflowExecutionHistoryRequest)Returns the history of the specified workflow execution.default GetWorkflowExecutionHistoryResponsegetWorkflowExecutionHistory(GetWorkflowExecutionHistoryRequest getWorkflowExecutionHistoryRequest)Returns the history of the specified workflow execution.default GetWorkflowExecutionHistoryIterablegetWorkflowExecutionHistoryPaginator(Consumer<GetWorkflowExecutionHistoryRequest.Builder> getWorkflowExecutionHistoryRequest)This is a variant ofgetWorkflowExecutionHistory(software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryRequest)operation.default GetWorkflowExecutionHistoryIterablegetWorkflowExecutionHistoryPaginator(GetWorkflowExecutionHistoryRequest getWorkflowExecutionHistoryRequest)This is a variant ofgetWorkflowExecutionHistory(software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryRequest)operation.default ListActivityTypesResponselistActivityTypes(Consumer<ListActivityTypesRequest.Builder> listActivityTypesRequest)Returns information about all activities registered in the specified domain that match the specified name and registration status.default ListActivityTypesResponselistActivityTypes(ListActivityTypesRequest listActivityTypesRequest)Returns information about all activities registered in the specified domain that match the specified name and registration status.default ListActivityTypesIterablelistActivityTypesPaginator(Consumer<ListActivityTypesRequest.Builder> listActivityTypesRequest)This is a variant oflistActivityTypes(software.amazon.awssdk.services.swf.model.ListActivityTypesRequest)operation.default ListActivityTypesIterablelistActivityTypesPaginator(ListActivityTypesRequest listActivityTypesRequest)This is a variant oflistActivityTypes(software.amazon.awssdk.services.swf.model.ListActivityTypesRequest)operation.default ListClosedWorkflowExecutionsResponselistClosedWorkflowExecutions(Consumer<ListClosedWorkflowExecutionsRequest.Builder> listClosedWorkflowExecutionsRequest)Returns a list of closed workflow executions in the specified domain that meet the filtering criteria.default ListClosedWorkflowExecutionsResponselistClosedWorkflowExecutions(ListClosedWorkflowExecutionsRequest listClosedWorkflowExecutionsRequest)Returns a list of closed workflow executions in the specified domain that meet the filtering criteria.default ListClosedWorkflowExecutionsIterablelistClosedWorkflowExecutionsPaginator(Consumer<ListClosedWorkflowExecutionsRequest.Builder> listClosedWorkflowExecutionsRequest)This is a variant oflistClosedWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsRequest)operation.default ListClosedWorkflowExecutionsIterablelistClosedWorkflowExecutionsPaginator(ListClosedWorkflowExecutionsRequest listClosedWorkflowExecutionsRequest)This is a variant oflistClosedWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsRequest)operation.default ListDomainsResponselistDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest)Returns the list of domains registered in the account.default ListDomainsResponselistDomains(ListDomainsRequest listDomainsRequest)Returns the list of domains registered in the account.default ListDomainsIterablelistDomainsPaginator(Consumer<ListDomainsRequest.Builder> listDomainsRequest)This is a variant oflistDomains(software.amazon.awssdk.services.swf.model.ListDomainsRequest)operation.default ListDomainsIterablelistDomainsPaginator(ListDomainsRequest listDomainsRequest)This is a variant oflistDomains(software.amazon.awssdk.services.swf.model.ListDomainsRequest)operation.default ListOpenWorkflowExecutionsResponselistOpenWorkflowExecutions(Consumer<ListOpenWorkflowExecutionsRequest.Builder> listOpenWorkflowExecutionsRequest)Returns a list of open workflow executions in the specified domain that meet the filtering criteria.default ListOpenWorkflowExecutionsResponselistOpenWorkflowExecutions(ListOpenWorkflowExecutionsRequest listOpenWorkflowExecutionsRequest)Returns a list of open workflow executions in the specified domain that meet the filtering criteria.default ListOpenWorkflowExecutionsIterablelistOpenWorkflowExecutionsPaginator(Consumer<ListOpenWorkflowExecutionsRequest.Builder> listOpenWorkflowExecutionsRequest)This is a variant oflistOpenWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsRequest)operation.default ListOpenWorkflowExecutionsIterablelistOpenWorkflowExecutionsPaginator(ListOpenWorkflowExecutionsRequest listOpenWorkflowExecutionsRequest)This is a variant oflistOpenWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsRequest)operation.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)List tags for a given domain.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)List tags for a given domain.default ListWorkflowTypesResponselistWorkflowTypes(Consumer<ListWorkflowTypesRequest.Builder> listWorkflowTypesRequest)Returns information about workflow types in the specified domain.default ListWorkflowTypesResponselistWorkflowTypes(ListWorkflowTypesRequest listWorkflowTypesRequest)Returns information about workflow types in the specified domain.default ListWorkflowTypesIterablelistWorkflowTypesPaginator(Consumer<ListWorkflowTypesRequest.Builder> listWorkflowTypesRequest)This is a variant oflistWorkflowTypes(software.amazon.awssdk.services.swf.model.ListWorkflowTypesRequest)operation.default ListWorkflowTypesIterablelistWorkflowTypesPaginator(ListWorkflowTypesRequest listWorkflowTypesRequest)This is a variant oflistWorkflowTypes(software.amazon.awssdk.services.swf.model.ListWorkflowTypesRequest)operation.default PollForActivityTaskResponsepollForActivityTask(Consumer<PollForActivityTaskRequest.Builder> pollForActivityTaskRequest)Used by workers to get an ActivityTask from the specified activitytaskList.default PollForActivityTaskResponsepollForActivityTask(PollForActivityTaskRequest pollForActivityTaskRequest)Used by workers to get an ActivityTask from the specified activitytaskList.default PollForDecisionTaskResponsepollForDecisionTask(Consumer<PollForDecisionTaskRequest.Builder> pollForDecisionTaskRequest)Used by deciders to get a DecisionTask from the specified decisiontaskList.default PollForDecisionTaskResponsepollForDecisionTask(PollForDecisionTaskRequest pollForDecisionTaskRequest)Used by deciders to get a DecisionTask from the specified decisiontaskList.default PollForDecisionTaskIterablepollForDecisionTaskPaginator(Consumer<PollForDecisionTaskRequest.Builder> pollForDecisionTaskRequest)This is a variant ofpollForDecisionTask(software.amazon.awssdk.services.swf.model.PollForDecisionTaskRequest)operation.default PollForDecisionTaskIterablepollForDecisionTaskPaginator(PollForDecisionTaskRequest pollForDecisionTaskRequest)This is a variant ofpollForDecisionTask(software.amazon.awssdk.services.swf.model.PollForDecisionTaskRequest)operation.default RecordActivityTaskHeartbeatResponserecordActivityTaskHeartbeat(Consumer<RecordActivityTaskHeartbeatRequest.Builder> recordActivityTaskHeartbeatRequest)Used by activity workers to report to the service that the ActivityTask represented by the specifiedtaskTokenis still making progress.default RecordActivityTaskHeartbeatResponserecordActivityTaskHeartbeat(RecordActivityTaskHeartbeatRequest recordActivityTaskHeartbeatRequest)Used by activity workers to report to the service that the ActivityTask represented by the specifiedtaskTokenis still making progress.default RegisterActivityTypeResponseregisterActivityType(Consumer<RegisterActivityTypeRequest.Builder> registerActivityTypeRequest)Registers a new activity type along with its configuration settings in the specified domain.default RegisterActivityTypeResponseregisterActivityType(RegisterActivityTypeRequest registerActivityTypeRequest)Registers a new activity type along with its configuration settings in the specified domain.default RegisterDomainResponseregisterDomain(Consumer<RegisterDomainRequest.Builder> registerDomainRequest)Registers a new domain.default RegisterDomainResponseregisterDomain(RegisterDomainRequest registerDomainRequest)Registers a new domain.default RegisterWorkflowTypeResponseregisterWorkflowType(Consumer<RegisterWorkflowTypeRequest.Builder> registerWorkflowTypeRequest)Registers a new workflow type and its configuration settings in the specified domain.default RegisterWorkflowTypeResponseregisterWorkflowType(RegisterWorkflowTypeRequest registerWorkflowTypeRequest)Registers a new workflow type and its configuration settings in the specified domain.default RequestCancelWorkflowExecutionResponserequestCancelWorkflowExecution(Consumer<RequestCancelWorkflowExecutionRequest.Builder> requestCancelWorkflowExecutionRequest)Records aWorkflowExecutionCancelRequestedevent in the currently running workflow execution identified by the given domain, workflowId, and runId.default RequestCancelWorkflowExecutionResponserequestCancelWorkflowExecution(RequestCancelWorkflowExecutionRequest requestCancelWorkflowExecutionRequest)Records aWorkflowExecutionCancelRequestedevent in the currently running workflow execution identified by the given domain, workflowId, and runId.default RespondActivityTaskCanceledResponserespondActivityTaskCanceled(Consumer<RespondActivityTaskCanceledRequest.Builder> respondActivityTaskCanceledRequest)Used by workers to tell the service that the ActivityTask identified by thetaskTokenwas successfully canceled.default RespondActivityTaskCanceledResponserespondActivityTaskCanceled(RespondActivityTaskCanceledRequest respondActivityTaskCanceledRequest)Used by workers to tell the service that the ActivityTask identified by thetaskTokenwas successfully canceled.default RespondActivityTaskCompletedResponserespondActivityTaskCompleted(Consumer<RespondActivityTaskCompletedRequest.Builder> respondActivityTaskCompletedRequest)Used by workers to tell the service that the ActivityTask identified by thetaskTokencompleted successfully with aresult(if provided).default RespondActivityTaskCompletedResponserespondActivityTaskCompleted(RespondActivityTaskCompletedRequest respondActivityTaskCompletedRequest)Used by workers to tell the service that the ActivityTask identified by thetaskTokencompleted successfully with aresult(if provided).default RespondActivityTaskFailedResponserespondActivityTaskFailed(Consumer<RespondActivityTaskFailedRequest.Builder> respondActivityTaskFailedRequest)Used by workers to tell the service that the ActivityTask identified by thetaskTokenhas failed withreason(if specified).default RespondActivityTaskFailedResponserespondActivityTaskFailed(RespondActivityTaskFailedRequest respondActivityTaskFailedRequest)Used by workers to tell the service that the ActivityTask identified by thetaskTokenhas failed withreason(if specified).default RespondDecisionTaskCompletedResponserespondDecisionTaskCompleted(Consumer<RespondDecisionTaskCompletedRequest.Builder> respondDecisionTaskCompletedRequest)Used by deciders to tell the service that the DecisionTask identified by thetaskTokenhas successfully completed.default RespondDecisionTaskCompletedResponserespondDecisionTaskCompleted(RespondDecisionTaskCompletedRequest respondDecisionTaskCompletedRequest)Used by deciders to tell the service that the DecisionTask identified by thetaskTokenhas successfully completed.default SwfServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default SignalWorkflowExecutionResponsesignalWorkflowExecution(Consumer<SignalWorkflowExecutionRequest.Builder> signalWorkflowExecutionRequest)Records aWorkflowExecutionSignaledevent in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId.default SignalWorkflowExecutionResponsesignalWorkflowExecution(SignalWorkflowExecutionRequest signalWorkflowExecutionRequest)Records aWorkflowExecutionSignaledevent in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId.default StartWorkflowExecutionResponsestartWorkflowExecution(Consumer<StartWorkflowExecutionRequest.Builder> startWorkflowExecutionRequest)Starts an execution of the workflow type in the specified domain using the providedworkflowIdand input data.default StartWorkflowExecutionResponsestartWorkflowExecution(StartWorkflowExecutionRequest startWorkflowExecutionRequest)Starts an execution of the workflow type in the specified domain using the providedworkflowIdand input data.default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)Add a tag to a Amazon SWF domain.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest)Add a tag to a Amazon SWF domain.default TerminateWorkflowExecutionResponseterminateWorkflowExecution(Consumer<TerminateWorkflowExecutionRequest.Builder> terminateWorkflowExecutionRequest)Records aWorkflowExecutionTerminatedevent and forces closure of the workflow execution identified by the given domain, runId, and workflowId.default TerminateWorkflowExecutionResponseterminateWorkflowExecution(TerminateWorkflowExecutionRequest terminateWorkflowExecutionRequest)Records aWorkflowExecutionTerminatedevent and forces closure of the workflow execution identified by the given domain, runId, and workflowId.default UndeprecateActivityTypeResponseundeprecateActivityType(Consumer<UndeprecateActivityTypeRequest.Builder> undeprecateActivityTypeRequest)Undeprecates a previously deprecated activity type.default UndeprecateActivityTypeResponseundeprecateActivityType(UndeprecateActivityTypeRequest undeprecateActivityTypeRequest)Undeprecates a previously deprecated activity type.default UndeprecateDomainResponseundeprecateDomain(Consumer<UndeprecateDomainRequest.Builder> undeprecateDomainRequest)Undeprecates a previously deprecated domain.default UndeprecateDomainResponseundeprecateDomain(UndeprecateDomainRequest undeprecateDomainRequest)Undeprecates a previously deprecated domain.default UndeprecateWorkflowTypeResponseundeprecateWorkflowType(Consumer<UndeprecateWorkflowTypeRequest.Builder> undeprecateWorkflowTypeRequest)Undeprecates a previously deprecated workflow type.default UndeprecateWorkflowTypeResponseundeprecateWorkflowType(UndeprecateWorkflowTypeRequest undeprecateWorkflowTypeRequest)Undeprecates a previously deprecated workflow type.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)Remove a tag from a Amazon SWF domain.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest)Remove a tag from a Amazon SWF domain.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
countClosedWorkflowExecutions
default CountClosedWorkflowExecutionsResponse countClosedWorkflowExecutions(CountClosedWorkflowExecutionsRequest countClosedWorkflowExecutionsRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
tagFilter.tag: String constraint. The key isswf:tagFilter.tag. -
typeFilter.name: String constraint. The key isswf:typeFilter.name. -
typeFilter.version: String constraint. The key isswf:typeFilter.version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
countClosedWorkflowExecutionsRequest-- Returns:
- Result of the CountClosedWorkflowExecutions operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
countClosedWorkflowExecutions
default CountClosedWorkflowExecutionsResponse countClosedWorkflowExecutions(Consumer<CountClosedWorkflowExecutionsRequest.Builder> countClosedWorkflowExecutionsRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
tagFilter.tag: String constraint. The key isswf:tagFilter.tag. -
typeFilter.name: String constraint. The key isswf:typeFilter.name. -
typeFilter.version: String constraint. The key isswf:typeFilter.version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
CountClosedWorkflowExecutionsRequest.Builderavoiding the need to create one manually viaCountClosedWorkflowExecutionsRequest.builder()- Parameters:
countClosedWorkflowExecutionsRequest- AConsumerthat will call methods onCountClosedWorkflowExecutionsRequest.Builderto create a request.- Returns:
- Result of the CountClosedWorkflowExecutions operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
countOpenWorkflowExecutions
default CountOpenWorkflowExecutionsResponse countOpenWorkflowExecutions(CountOpenWorkflowExecutionsRequest countOpenWorkflowExecutionsRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
tagFilter.tag: String constraint. The key isswf:tagFilter.tag. -
typeFilter.name: String constraint. The key isswf:typeFilter.name. -
typeFilter.version: String constraint. The key isswf:typeFilter.version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
countOpenWorkflowExecutionsRequest-- Returns:
- Result of the CountOpenWorkflowExecutions operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
countOpenWorkflowExecutions
default CountOpenWorkflowExecutionsResponse countOpenWorkflowExecutions(Consumer<CountOpenWorkflowExecutionsRequest.Builder> countOpenWorkflowExecutionsRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
tagFilter.tag: String constraint. The key isswf:tagFilter.tag. -
typeFilter.name: String constraint. The key isswf:typeFilter.name. -
typeFilter.version: String constraint. The key isswf:typeFilter.version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
CountOpenWorkflowExecutionsRequest.Builderavoiding the need to create one manually viaCountOpenWorkflowExecutionsRequest.builder()- Parameters:
countOpenWorkflowExecutionsRequest- AConsumerthat will call methods onCountOpenWorkflowExecutionsRequest.Builderto create a request.- Returns:
- Result of the CountOpenWorkflowExecutions operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
countPendingActivityTasks
default CountPendingActivityTasksResponse countPendingActivityTasks(CountPendingActivityTasksRequest countPendingActivityTasksRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and isn't guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then
0is returned.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the
taskList.nameparameter by using aConditionelement with theswf:taskList.namekey to allow the action to access only certain task lists.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
countPendingActivityTasksRequest-- Returns:
- Result of the CountPendingActivityTasks operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
countPendingActivityTasks
default CountPendingActivityTasksResponse countPendingActivityTasks(Consumer<CountPendingActivityTasksRequest.Builder> countPendingActivityTasksRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and isn't guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then
0is returned.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the
taskList.nameparameter by using aConditionelement with theswf:taskList.namekey to allow the action to access only certain task lists.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
CountPendingActivityTasksRequest.Builderavoiding the need to create one manually viaCountPendingActivityTasksRequest.builder()- Parameters:
countPendingActivityTasksRequest- AConsumerthat will call methods onCountPendingActivityTasksRequest.Builderto create a request.- Returns:
- Result of the CountPendingActivityTasks operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
countPendingDecisionTasks
default CountPendingDecisionTasksResponse countPendingDecisionTasks(CountPendingDecisionTasksRequest countPendingDecisionTasksRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and isn't guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then
0is returned.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the
taskList.nameparameter by using aConditionelement with theswf:taskList.namekey to allow the action to access only certain task lists.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
countPendingDecisionTasksRequest-- Returns:
- Result of the CountPendingDecisionTasks operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
countPendingDecisionTasks
default CountPendingDecisionTasksResponse countPendingDecisionTasks(Consumer<CountPendingDecisionTasksRequest.Builder> countPendingDecisionTasksRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and isn't guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then
0is returned.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the
taskList.nameparameter by using aConditionelement with theswf:taskList.namekey to allow the action to access only certain task lists.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
CountPendingDecisionTasksRequest.Builderavoiding the need to create one manually viaCountPendingDecisionTasksRequest.builder()- Parameters:
countPendingDecisionTasksRequest- AConsumerthat will call methods onCountPendingDecisionTasksRequest.Builderto create a request.- Returns:
- Result of the CountPendingDecisionTasks operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
deleteActivityType
default DeleteActivityTypeResponse deleteActivityType(DeleteActivityTypeRequest deleteActivityTypeRequest) throws UnknownResourceException, TypeNotDeprecatedException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Deletes the specified activity type.
Note: Prior to deletion, activity types must first be deprecated.
After an activity type has been deleted, you cannot schedule new activities of that type. Activities that started before the type was deleted will continue to run.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
activityType.name: String constraint. The key isswf:activityType.name. -
activityType.version: String constraint. The key isswf:activityType.version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
deleteActivityTypeRequest-- Returns:
- Result of the DeleteActivityType operation returned by the service.
- Throws:
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.TypeNotDeprecatedException- Returned when the resource type has not been deprecated.OperationNotPermittedException- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
deleteActivityType
default DeleteActivityTypeResponse deleteActivityType(Consumer<DeleteActivityTypeRequest.Builder> deleteActivityTypeRequest) throws UnknownResourceException, TypeNotDeprecatedException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Deletes the specified activity type.
Note: Prior to deletion, activity types must first be deprecated.
After an activity type has been deleted, you cannot schedule new activities of that type. Activities that started before the type was deleted will continue to run.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
activityType.name: String constraint. The key isswf:activityType.name. -
activityType.version: String constraint. The key isswf:activityType.version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
DeleteActivityTypeRequest.Builderavoiding the need to create one manually viaDeleteActivityTypeRequest.builder()- Parameters:
deleteActivityTypeRequest- AConsumerthat will call methods onDeleteActivityTypeRequest.Builderto create a request.- Returns:
- Result of the DeleteActivityType operation returned by the service.
- Throws:
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.TypeNotDeprecatedException- Returned when the resource type has not been deprecated.OperationNotPermittedException- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
deleteWorkflowType
default DeleteWorkflowTypeResponse deleteWorkflowType(DeleteWorkflowTypeRequest deleteWorkflowTypeRequest) throws UnknownResourceException, TypeNotDeprecatedException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Deletes the specified workflow type.
Note: Prior to deletion, workflow types must first be deprecated.
After a workflow type has been deleted, you cannot create new executions of that type. Executions that started before the type was deleted will continue to run.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
workflowType.name: String constraint. The key isswf:workflowType.name. -
workflowType.version: String constraint. The key isswf:workflowType.version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
deleteWorkflowTypeRequest-- Returns:
- Result of the DeleteWorkflowType operation returned by the service.
- Throws:
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.TypeNotDeprecatedException- Returned when the resource type has not been deprecated.OperationNotPermittedException- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
deleteWorkflowType
default DeleteWorkflowTypeResponse deleteWorkflowType(Consumer<DeleteWorkflowTypeRequest.Builder> deleteWorkflowTypeRequest) throws UnknownResourceException, TypeNotDeprecatedException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Deletes the specified workflow type.
Note: Prior to deletion, workflow types must first be deprecated.
After a workflow type has been deleted, you cannot create new executions of that type. Executions that started before the type was deleted will continue to run.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
workflowType.name: String constraint. The key isswf:workflowType.name. -
workflowType.version: String constraint. The key isswf:workflowType.version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
DeleteWorkflowTypeRequest.Builderavoiding the need to create one manually viaDeleteWorkflowTypeRequest.builder()- Parameters:
deleteWorkflowTypeRequest- AConsumerthat will call methods onDeleteWorkflowTypeRequest.Builderto create a request.- Returns:
- Result of the DeleteWorkflowType operation returned by the service.
- Throws:
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.TypeNotDeprecatedException- Returned when the resource type has not been deprecated.OperationNotPermittedException- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
deprecateActivityType
default DeprecateActivityTypeResponse deprecateActivityType(DeprecateActivityTypeRequest deprecateActivityTypeRequest) throws UnknownResourceException, TypeDeprecatedException, OperationNotPermittedException, AwsServiceException, 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 continue to run.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
activityType.name: String constraint. The key isswf:activityType.name. -
activityType.version: String constraint. The key isswf:activityType.version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
deprecateActivityTypeRequest-- Returns:
- Result of the DeprecateActivityType operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
deprecateActivityType
default DeprecateActivityTypeResponse deprecateActivityType(Consumer<DeprecateActivityTypeRequest.Builder> deprecateActivityTypeRequest) throws UnknownResourceException, TypeDeprecatedException, OperationNotPermittedException, AwsServiceException, 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 continue to run.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
activityType.name: String constraint. The key isswf:activityType.name. -
activityType.version: String constraint. The key isswf:activityType.version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
DeprecateActivityTypeRequest.Builderavoiding the need to create one manually viaDeprecateActivityTypeRequest.builder()- Parameters:
deprecateActivityTypeRequest- AConsumerthat will call methods onDeprecateActivityTypeRequest.Builderto create a request.- Returns:
- Result of the DeprecateActivityType operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
deprecateDomain
default DeprecateDomainResponse deprecateDomain(DeprecateDomainRequest deprecateDomainRequest) throws UnknownResourceException, DomainDeprecatedException, OperationNotPermittedException, AwsServiceException, 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 continues to run.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
deprecateDomainRequest-- Returns:
- Result of the DeprecateDomain operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
deprecateDomain
default DeprecateDomainResponse deprecateDomain(Consumer<DeprecateDomainRequest.Builder> deprecateDomainRequest) throws UnknownResourceException, DomainDeprecatedException, OperationNotPermittedException, AwsServiceException, 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 continues to run.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
DeprecateDomainRequest.Builderavoiding the need to create one manually viaDeprecateDomainRequest.builder()- Parameters:
deprecateDomainRequest- AConsumerthat will call methods onDeprecateDomainRequest.Builderto create a request.- Returns:
- Result of the DeprecateDomain operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
deprecateWorkflowType
default DeprecateWorkflowTypeResponse deprecateWorkflowType(DeprecateWorkflowTypeRequest deprecateWorkflowTypeRequest) throws UnknownResourceException, TypeDeprecatedException, OperationNotPermittedException, AwsServiceException, 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 continues to run. A deprecated workflow type may still be used when calling visibility actions.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
workflowType.name: String constraint. The key isswf:workflowType.name. -
workflowType.version: String constraint. The key isswf:workflowType.version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
deprecateWorkflowTypeRequest-- Returns:
- Result of the DeprecateWorkflowType operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
deprecateWorkflowType
default DeprecateWorkflowTypeResponse deprecateWorkflowType(Consumer<DeprecateWorkflowTypeRequest.Builder> deprecateWorkflowTypeRequest) throws UnknownResourceException, TypeDeprecatedException, OperationNotPermittedException, AwsServiceException, 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 continues to run. A deprecated workflow type may still be used when calling visibility actions.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
workflowType.name: String constraint. The key isswf:workflowType.name. -
workflowType.version: String constraint. The key isswf:workflowType.version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
DeprecateWorkflowTypeRequest.Builderavoiding the need to create one manually viaDeprecateWorkflowTypeRequest.builder()- Parameters:
deprecateWorkflowTypeRequest- AConsumerthat will call methods onDeprecateWorkflowTypeRequest.Builderto create a request.- Returns:
- Result of the DeprecateWorkflowType operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
describeActivityType
default DescribeActivityTypeResponse describeActivityType(DescribeActivityTypeRequest describeActivityTypeRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, 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:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
activityType.name: String constraint. The key isswf:activityType.name. -
activityType.version: String constraint. The key isswf:activityType.version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
describeActivityTypeRequest-- Returns:
- Result of the DescribeActivityType operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
describeActivityType
default DescribeActivityTypeResponse describeActivityType(Consumer<DescribeActivityTypeRequest.Builder> describeActivityTypeRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, 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:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
activityType.name: String constraint. The key isswf:activityType.name. -
activityType.version: String constraint. The key isswf:activityType.version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
DescribeActivityTypeRequest.Builderavoiding the need to create one manually viaDescribeActivityTypeRequest.builder()- Parameters:
describeActivityTypeRequest- AConsumerthat will call methods onDescribeActivityTypeRequest.Builderto create a request.- Returns:
- Result of the DescribeActivityType operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
describeDomain
default DescribeDomainResponse describeDomain(DescribeDomainRequest describeDomainRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, 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:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
describeDomainRequest-- Returns:
- Result of the DescribeDomain operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
describeDomain
default DescribeDomainResponse describeDomain(Consumer<DescribeDomainRequest.Builder> describeDomainRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, 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:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
DescribeDomainRequest.Builderavoiding the need to create one manually viaDescribeDomainRequest.builder()- Parameters:
describeDomainRequest- AConsumerthat will call methods onDescribeDomainRequest.Builderto create a request.- Returns:
- Result of the DescribeDomain operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
describeWorkflowExecution
default DescribeWorkflowExecutionResponse describeWorkflowExecution(DescribeWorkflowExecutionRequest describeWorkflowExecutionRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Returns information about the specified workflow execution including its type and some statistics.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
describeWorkflowExecutionRequest-- Returns:
- Result of the DescribeWorkflowExecution operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
describeWorkflowExecution
default DescribeWorkflowExecutionResponse describeWorkflowExecution(Consumer<DescribeWorkflowExecutionRequest.Builder> describeWorkflowExecutionRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Returns information about the specified workflow execution including its type and some statistics.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
DescribeWorkflowExecutionRequest.Builderavoiding the need to create one manually viaDescribeWorkflowExecutionRequest.builder()- Parameters:
describeWorkflowExecutionRequest- AConsumerthat will call methods onDescribeWorkflowExecutionRequest.Builderto create a request.- Returns:
- Result of the DescribeWorkflowExecution operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
describeWorkflowType
default DescribeWorkflowTypeResponse describeWorkflowType(DescribeWorkflowTypeRequest describeWorkflowTypeRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, 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, etc.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
workflowType.name: String constraint. The key isswf:workflowType.name. -
workflowType.version: String constraint. The key isswf:workflowType.version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
describeWorkflowTypeRequest-- Returns:
- Result of the DescribeWorkflowType operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
describeWorkflowType
default DescribeWorkflowTypeResponse describeWorkflowType(Consumer<DescribeWorkflowTypeRequest.Builder> describeWorkflowTypeRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, 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, etc.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
workflowType.name: String constraint. The key isswf:workflowType.name. -
workflowType.version: String constraint. The key isswf:workflowType.version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
DescribeWorkflowTypeRequest.Builderavoiding the need to create one manually viaDescribeWorkflowTypeRequest.builder()- Parameters:
describeWorkflowTypeRequest- AConsumerthat will call methods onDescribeWorkflowTypeRequest.Builderto create a request.- Returns:
- Result of the DescribeWorkflowType operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
getWorkflowExecutionHistory
default GetWorkflowExecutionHistoryResponse getWorkflowExecutionHistory(GetWorkflowExecutionHistoryRequest getWorkflowExecutionHistoryRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, 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
nextPageTokenreturned by the initial call.This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
getWorkflowExecutionHistoryRequest-- Returns:
- Result of the GetWorkflowExecutionHistory operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
getWorkflowExecutionHistory
default GetWorkflowExecutionHistoryResponse getWorkflowExecutionHistory(Consumer<GetWorkflowExecutionHistoryRequest.Builder> getWorkflowExecutionHistoryRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, 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
nextPageTokenreturned by the initial call.This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
GetWorkflowExecutionHistoryRequest.Builderavoiding the need to create one manually viaGetWorkflowExecutionHistoryRequest.builder()- Parameters:
getWorkflowExecutionHistoryRequest- AConsumerthat will call methods onGetWorkflowExecutionHistoryRequest.Builderto create a request.- Returns:
- Result of the GetWorkflowExecutionHistory operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
getWorkflowExecutionHistoryPaginator
default GetWorkflowExecutionHistoryIterable getWorkflowExecutionHistoryPaginator(GetWorkflowExecutionHistoryRequest getWorkflowExecutionHistoryRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
This is a variant of
getWorkflowExecutionHistory(software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.swf.paginators.GetWorkflowExecutionHistoryIterable responses = client.getWorkflowExecutionHistoryPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.swf.paginators.GetWorkflowExecutionHistoryIterable responses = client .getWorkflowExecutionHistoryPaginator(request); for (software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.swf.paginators.GetWorkflowExecutionHistoryIterable responses = client.getWorkflowExecutionHistoryPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maximumPageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getWorkflowExecutionHistory(software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryRequest)operation.- Parameters:
getWorkflowExecutionHistoryRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
getWorkflowExecutionHistoryPaginator
default GetWorkflowExecutionHistoryIterable getWorkflowExecutionHistoryPaginator(Consumer<GetWorkflowExecutionHistoryRequest.Builder> getWorkflowExecutionHistoryRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
This is a variant of
getWorkflowExecutionHistory(software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.swf.paginators.GetWorkflowExecutionHistoryIterable responses = client.getWorkflowExecutionHistoryPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.swf.paginators.GetWorkflowExecutionHistoryIterable responses = client .getWorkflowExecutionHistoryPaginator(request); for (software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.swf.paginators.GetWorkflowExecutionHistoryIterable responses = client.getWorkflowExecutionHistoryPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maximumPageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getWorkflowExecutionHistory(software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryRequest)operation.
This is a convenience which creates an instance of the
GetWorkflowExecutionHistoryRequest.Builderavoiding the need to create one manually viaGetWorkflowExecutionHistoryRequest.builder()- Parameters:
getWorkflowExecutionHistoryRequest- AConsumerthat will call methods onGetWorkflowExecutionHistoryRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
listActivityTypes
default ListActivityTypesResponse listActivityTypes(ListActivityTypesRequest listActivityTypesRequest) throws OperationNotPermittedException, UnknownResourceException, AwsServiceException, 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
nextPageTokenreturned by the initial call.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
listActivityTypesRequest-- Returns:
- Result of the ListActivityTypes operation returned by the service.
- Throws:
OperationNotPermittedException- Returned when the caller doesn't 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.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
listActivityTypes
default ListActivityTypesResponse listActivityTypes(Consumer<ListActivityTypesRequest.Builder> listActivityTypesRequest) throws OperationNotPermittedException, UnknownResourceException, AwsServiceException, 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
nextPageTokenreturned by the initial call.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
ListActivityTypesRequest.Builderavoiding the need to create one manually viaListActivityTypesRequest.builder()- Parameters:
listActivityTypesRequest- AConsumerthat will call methods onListActivityTypesRequest.Builderto create a request.- Returns:
- Result of the ListActivityTypes operation returned by the service.
- Throws:
OperationNotPermittedException- Returned when the caller doesn't 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.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
listActivityTypesPaginator
default ListActivityTypesIterable listActivityTypesPaginator(ListActivityTypesRequest listActivityTypesRequest) throws OperationNotPermittedException, UnknownResourceException, AwsServiceException, SdkClientException, SwfException
This is a variant of
listActivityTypes(software.amazon.awssdk.services.swf.model.ListActivityTypesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.swf.paginators.ListActivityTypesIterable responses = client.listActivityTypesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.swf.paginators.ListActivityTypesIterable responses = client .listActivityTypesPaginator(request); for (software.amazon.awssdk.services.swf.model.ListActivityTypesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.swf.paginators.ListActivityTypesIterable responses = client.listActivityTypesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maximumPageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listActivityTypes(software.amazon.awssdk.services.swf.model.ListActivityTypesRequest)operation.- Parameters:
listActivityTypesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
OperationNotPermittedException- Returned when the caller doesn't 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.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
listActivityTypesPaginator
default ListActivityTypesIterable listActivityTypesPaginator(Consumer<ListActivityTypesRequest.Builder> listActivityTypesRequest) throws OperationNotPermittedException, UnknownResourceException, AwsServiceException, SdkClientException, SwfException
This is a variant of
listActivityTypes(software.amazon.awssdk.services.swf.model.ListActivityTypesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.swf.paginators.ListActivityTypesIterable responses = client.listActivityTypesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.swf.paginators.ListActivityTypesIterable responses = client .listActivityTypesPaginator(request); for (software.amazon.awssdk.services.swf.model.ListActivityTypesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.swf.paginators.ListActivityTypesIterable responses = client.listActivityTypesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maximumPageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listActivityTypes(software.amazon.awssdk.services.swf.model.ListActivityTypesRequest)operation.
This is a convenience which creates an instance of the
ListActivityTypesRequest.Builderavoiding the need to create one manually viaListActivityTypesRequest.builder()- Parameters:
listActivityTypesRequest- AConsumerthat will call methods onListActivityTypesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
OperationNotPermittedException- Returned when the caller doesn't 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.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
listClosedWorkflowExecutions
default ListClosedWorkflowExecutionsResponse listClosedWorkflowExecutions(ListClosedWorkflowExecutionsRequest listClosedWorkflowExecutionsRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, 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.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
tagFilter.tag: String constraint. The key isswf:tagFilter.tag. -
typeFilter.name: String constraint. The key isswf:typeFilter.name. -
typeFilter.version: String constraint. The key isswf:typeFilter.version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
listClosedWorkflowExecutionsRequest-- Returns:
- Result of the ListClosedWorkflowExecutions operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
listClosedWorkflowExecutions
default ListClosedWorkflowExecutionsResponse listClosedWorkflowExecutions(Consumer<ListClosedWorkflowExecutionsRequest.Builder> listClosedWorkflowExecutionsRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, 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.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
tagFilter.tag: String constraint. The key isswf:tagFilter.tag. -
typeFilter.name: String constraint. The key isswf:typeFilter.name. -
typeFilter.version: String constraint. The key isswf:typeFilter.version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
ListClosedWorkflowExecutionsRequest.Builderavoiding the need to create one manually viaListClosedWorkflowExecutionsRequest.builder()- Parameters:
listClosedWorkflowExecutionsRequest- AConsumerthat will call methods onListClosedWorkflowExecutionsRequest.Builderto create a request.- Returns:
- Result of the ListClosedWorkflowExecutions operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
listClosedWorkflowExecutionsPaginator
default ListClosedWorkflowExecutionsIterable listClosedWorkflowExecutionsPaginator(ListClosedWorkflowExecutionsRequest listClosedWorkflowExecutionsRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
This is a variant of
listClosedWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.swf.paginators.ListClosedWorkflowExecutionsIterable responses = client.listClosedWorkflowExecutionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.swf.paginators.ListClosedWorkflowExecutionsIterable responses = client .listClosedWorkflowExecutionsPaginator(request); for (software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.swf.paginators.ListClosedWorkflowExecutionsIterable responses = client.listClosedWorkflowExecutionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maximumPageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listClosedWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsRequest)operation.- Parameters:
listClosedWorkflowExecutionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
listClosedWorkflowExecutionsPaginator
default ListClosedWorkflowExecutionsIterable listClosedWorkflowExecutionsPaginator(Consumer<ListClosedWorkflowExecutionsRequest.Builder> listClosedWorkflowExecutionsRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
This is a variant of
listClosedWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.swf.paginators.ListClosedWorkflowExecutionsIterable responses = client.listClosedWorkflowExecutionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.swf.paginators.ListClosedWorkflowExecutionsIterable responses = client .listClosedWorkflowExecutionsPaginator(request); for (software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.swf.paginators.ListClosedWorkflowExecutionsIterable responses = client.listClosedWorkflowExecutionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maximumPageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listClosedWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsRequest)operation.
This is a convenience which creates an instance of the
ListClosedWorkflowExecutionsRequest.Builderavoiding the need to create one manually viaListClosedWorkflowExecutionsRequest.builder()- Parameters:
listClosedWorkflowExecutionsRequest- AConsumerthat will call methods onListClosedWorkflowExecutionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
listDomains
default ListDomainsResponse listDomains(ListDomainsRequest listDomainsRequest) throws OperationNotPermittedException, AwsServiceException, 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.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. The element must be set toarn:aws:swf::AccountID:domain/*, where AccountID is the account ID, with no dashes. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
listDomainsRequest-- Returns:
- Result of the ListDomains operation returned by the service.
- Throws:
OperationNotPermittedException- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
listDomains
default ListDomainsResponse listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest) throws OperationNotPermittedException, AwsServiceException, 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.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. The element must be set toarn:aws:swf::AccountID:domain/*, where AccountID is the account ID, with no dashes. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
ListDomainsRequest.Builderavoiding the need to create one manually viaListDomainsRequest.builder()- Parameters:
listDomainsRequest- AConsumerthat will call methods onListDomainsRequest.Builderto create a request.- Returns:
- Result of the ListDomains operation returned by the service.
- Throws:
OperationNotPermittedException- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
listDomainsPaginator
default ListDomainsIterable listDomainsPaginator(ListDomainsRequest listDomainsRequest) throws OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
This is a variant of
listDomains(software.amazon.awssdk.services.swf.model.ListDomainsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.swf.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.swf.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request); for (software.amazon.awssdk.services.swf.model.ListDomainsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.swf.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maximumPageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDomains(software.amazon.awssdk.services.swf.model.ListDomainsRequest)operation.- Parameters:
listDomainsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
OperationNotPermittedException- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
listDomainsPaginator
default ListDomainsIterable listDomainsPaginator(Consumer<ListDomainsRequest.Builder> listDomainsRequest) throws OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
This is a variant of
listDomains(software.amazon.awssdk.services.swf.model.ListDomainsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.swf.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.swf.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request); for (software.amazon.awssdk.services.swf.model.ListDomainsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.swf.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maximumPageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDomains(software.amazon.awssdk.services.swf.model.ListDomainsRequest)operation.
This is a convenience which creates an instance of the
ListDomainsRequest.Builderavoiding the need to create one manually viaListDomainsRequest.builder()- Parameters:
listDomainsRequest- AConsumerthat will call methods onListDomainsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
OperationNotPermittedException- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
listOpenWorkflowExecutions
default ListOpenWorkflowExecutionsResponse listOpenWorkflowExecutions(ListOpenWorkflowExecutionsRequest listOpenWorkflowExecutionsRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, 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.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
tagFilter.tag: String constraint. The key isswf:tagFilter.tag. -
typeFilter.name: String constraint. The key isswf:typeFilter.name. -
typeFilter.version: String constraint. The key isswf:typeFilter.version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
listOpenWorkflowExecutionsRequest-- Returns:
- Result of the ListOpenWorkflowExecutions operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
listOpenWorkflowExecutions
default ListOpenWorkflowExecutionsResponse listOpenWorkflowExecutions(Consumer<ListOpenWorkflowExecutionsRequest.Builder> listOpenWorkflowExecutionsRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, 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.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
tagFilter.tag: String constraint. The key isswf:tagFilter.tag. -
typeFilter.name: String constraint. The key isswf:typeFilter.name. -
typeFilter.version: String constraint. The key isswf:typeFilter.version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
ListOpenWorkflowExecutionsRequest.Builderavoiding the need to create one manually viaListOpenWorkflowExecutionsRequest.builder()- Parameters:
listOpenWorkflowExecutionsRequest- AConsumerthat will call methods onListOpenWorkflowExecutionsRequest.Builderto create a request.- Returns:
- Result of the ListOpenWorkflowExecutions operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
listOpenWorkflowExecutionsPaginator
default ListOpenWorkflowExecutionsIterable listOpenWorkflowExecutionsPaginator(ListOpenWorkflowExecutionsRequest listOpenWorkflowExecutionsRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
This is a variant of
listOpenWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.swf.paginators.ListOpenWorkflowExecutionsIterable responses = client.listOpenWorkflowExecutionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.swf.paginators.ListOpenWorkflowExecutionsIterable responses = client .listOpenWorkflowExecutionsPaginator(request); for (software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.swf.paginators.ListOpenWorkflowExecutionsIterable responses = client.listOpenWorkflowExecutionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maximumPageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listOpenWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsRequest)operation.- Parameters:
listOpenWorkflowExecutionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
listOpenWorkflowExecutionsPaginator
default ListOpenWorkflowExecutionsIterable listOpenWorkflowExecutionsPaginator(Consumer<ListOpenWorkflowExecutionsRequest.Builder> listOpenWorkflowExecutionsRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
This is a variant of
listOpenWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.swf.paginators.ListOpenWorkflowExecutionsIterable responses = client.listOpenWorkflowExecutionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.swf.paginators.ListOpenWorkflowExecutionsIterable responses = client .listOpenWorkflowExecutionsPaginator(request); for (software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.swf.paginators.ListOpenWorkflowExecutionsIterable responses = client.listOpenWorkflowExecutionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maximumPageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listOpenWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsRequest)operation.
This is a convenience which creates an instance of the
ListOpenWorkflowExecutionsRequest.Builderavoiding the need to create one manually viaListOpenWorkflowExecutionsRequest.builder()- Parameters:
listOpenWorkflowExecutionsRequest- AConsumerthat will call methods onListOpenWorkflowExecutionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws UnknownResourceException, LimitExceededException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
List tags for a given domain.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws UnknownResourceException, LimitExceededException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
List tags for a given domain.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
listWorkflowTypes
default ListWorkflowTypesResponse listWorkflowTypes(ListWorkflowTypesRequest listWorkflowTypesRequest) throws OperationNotPermittedException, UnknownResourceException, AwsServiceException, 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:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
listWorkflowTypesRequest-- Returns:
- Result of the ListWorkflowTypes operation returned by the service.
- Throws:
OperationNotPermittedException- Returned when the caller doesn't 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.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
listWorkflowTypes
default ListWorkflowTypesResponse listWorkflowTypes(Consumer<ListWorkflowTypesRequest.Builder> listWorkflowTypesRequest) throws OperationNotPermittedException, UnknownResourceException, AwsServiceException, 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:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
ListWorkflowTypesRequest.Builderavoiding the need to create one manually viaListWorkflowTypesRequest.builder()- Parameters:
listWorkflowTypesRequest- AConsumerthat will call methods onListWorkflowTypesRequest.Builderto create a request.- Returns:
- Result of the ListWorkflowTypes operation returned by the service.
- Throws:
OperationNotPermittedException- Returned when the caller doesn't 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.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
listWorkflowTypesPaginator
default ListWorkflowTypesIterable listWorkflowTypesPaginator(ListWorkflowTypesRequest listWorkflowTypesRequest) throws OperationNotPermittedException, UnknownResourceException, AwsServiceException, SdkClientException, SwfException
This is a variant of
listWorkflowTypes(software.amazon.awssdk.services.swf.model.ListWorkflowTypesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.swf.paginators.ListWorkflowTypesIterable responses = client.listWorkflowTypesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.swf.paginators.ListWorkflowTypesIterable responses = client .listWorkflowTypesPaginator(request); for (software.amazon.awssdk.services.swf.model.ListWorkflowTypesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.swf.paginators.ListWorkflowTypesIterable responses = client.listWorkflowTypesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maximumPageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkflowTypes(software.amazon.awssdk.services.swf.model.ListWorkflowTypesRequest)operation.- Parameters:
listWorkflowTypesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
OperationNotPermittedException- Returned when the caller doesn't 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.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
listWorkflowTypesPaginator
default ListWorkflowTypesIterable listWorkflowTypesPaginator(Consumer<ListWorkflowTypesRequest.Builder> listWorkflowTypesRequest) throws OperationNotPermittedException, UnknownResourceException, AwsServiceException, SdkClientException, SwfException
This is a variant of
listWorkflowTypes(software.amazon.awssdk.services.swf.model.ListWorkflowTypesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.swf.paginators.ListWorkflowTypesIterable responses = client.listWorkflowTypesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.swf.paginators.ListWorkflowTypesIterable responses = client .listWorkflowTypesPaginator(request); for (software.amazon.awssdk.services.swf.model.ListWorkflowTypesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.swf.paginators.ListWorkflowTypesIterable responses = client.listWorkflowTypesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maximumPageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkflowTypes(software.amazon.awssdk.services.swf.model.ListWorkflowTypesRequest)operation.
This is a convenience which creates an instance of the
ListWorkflowTypesRequest.Builderavoiding the need to create one manually viaListWorkflowTypesRequest.builder()- Parameters:
listWorkflowTypesRequest- AConsumerthat will call methods onListWorkflowTypesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
OperationNotPermittedException- Returned when the caller doesn't 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.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
pollForActivityTask
default PollForActivityTaskResponse pollForActivityTask(PollForActivityTaskRequest pollForActivityTaskRequest) throws UnknownResourceException, OperationNotPermittedException, LimitExceededException, AwsServiceException, 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 returns 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.Workers should set their client side socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may hold the poll request).
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the
taskList.nameparameter by using aConditionelement with theswf:taskList.namekey to allow the action to access only certain task lists.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
pollForActivityTaskRequest-- Returns:
- Result of the PollForActivityTask operation returned by the service.
- Throws:
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 doesn't 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.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
pollForActivityTask
default PollForActivityTaskResponse pollForActivityTask(Consumer<PollForActivityTaskRequest.Builder> pollForActivityTaskRequest) throws UnknownResourceException, OperationNotPermittedException, LimitExceededException, AwsServiceException, 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 returns 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.Workers should set their client side socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may hold the poll request).
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the
taskList.nameparameter by using aConditionelement with theswf:taskList.namekey to allow the action to access only certain task lists.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
PollForActivityTaskRequest.Builderavoiding the need to create one manually viaPollForActivityTaskRequest.builder()- Parameters:
pollForActivityTaskRequest- AConsumerthat will call methods onPollForActivityTaskRequest.Builderto create a request.- Returns:
- Result of the PollForActivityTask operation returned by the service.
- Throws:
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 doesn't 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.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
pollForDecisionTask
default PollForDecisionTaskResponse pollForDecisionTask(PollForDecisionTaskRequest pollForDecisionTaskRequest) throws UnknownResourceException, OperationNotPermittedException, LimitExceededException, AwsServiceException, 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.
Deciders should set their client side socket timeout to at least 70 seconds (10 seconds higher than the timeout).
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
PollForDecisionTaskusing thenextPageTokenreturned by the initial call. Note that you do not callGetWorkflowExecutionHistorywith thisnextPageToken. Instead, callPollForDecisionTaskagain.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the
taskList.nameparameter by using aConditionelement with theswf:taskList.namekey to allow the action to access only certain task lists.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
pollForDecisionTaskRequest-- Returns:
- Result of the PollForDecisionTask operation returned by the service.
- Throws:
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 doesn't 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.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
pollForDecisionTask
default PollForDecisionTaskResponse pollForDecisionTask(Consumer<PollForDecisionTaskRequest.Builder> pollForDecisionTaskRequest) throws UnknownResourceException, OperationNotPermittedException, LimitExceededException, AwsServiceException, 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.
Deciders should set their client side socket timeout to at least 70 seconds (10 seconds higher than the timeout).
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
PollForDecisionTaskusing thenextPageTokenreturned by the initial call. Note that you do not callGetWorkflowExecutionHistorywith thisnextPageToken. Instead, callPollForDecisionTaskagain.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the
taskList.nameparameter by using aConditionelement with theswf:taskList.namekey to allow the action to access only certain task lists.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
PollForDecisionTaskRequest.Builderavoiding the need to create one manually viaPollForDecisionTaskRequest.builder()- Parameters:
pollForDecisionTaskRequest- AConsumerthat will call methods onPollForDecisionTaskRequest.Builderto create a request.- Returns:
- Result of the PollForDecisionTask operation returned by the service.
- Throws:
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 doesn't 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.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
pollForDecisionTaskPaginator
default PollForDecisionTaskIterable pollForDecisionTaskPaginator(PollForDecisionTaskRequest pollForDecisionTaskRequest) throws UnknownResourceException, OperationNotPermittedException, LimitExceededException, AwsServiceException, SdkClientException, SwfException
This is a variant of
pollForDecisionTask(software.amazon.awssdk.services.swf.model.PollForDecisionTaskRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.swf.paginators.PollForDecisionTaskIterable responses = client.pollForDecisionTaskPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.swf.paginators.PollForDecisionTaskIterable responses = client .pollForDecisionTaskPaginator(request); for (software.amazon.awssdk.services.swf.model.PollForDecisionTaskResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.swf.paginators.PollForDecisionTaskIterable responses = client.pollForDecisionTaskPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maximumPageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
pollForDecisionTask(software.amazon.awssdk.services.swf.model.PollForDecisionTaskRequest)operation.- Parameters:
pollForDecisionTaskRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 doesn't 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.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
pollForDecisionTaskPaginator
default PollForDecisionTaskIterable pollForDecisionTaskPaginator(Consumer<PollForDecisionTaskRequest.Builder> pollForDecisionTaskRequest) throws UnknownResourceException, OperationNotPermittedException, LimitExceededException, AwsServiceException, SdkClientException, SwfException
This is a variant of
pollForDecisionTask(software.amazon.awssdk.services.swf.model.PollForDecisionTaskRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.swf.paginators.PollForDecisionTaskIterable responses = client.pollForDecisionTaskPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.swf.paginators.PollForDecisionTaskIterable responses = client .pollForDecisionTaskPaginator(request); for (software.amazon.awssdk.services.swf.model.PollForDecisionTaskResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.swf.paginators.PollForDecisionTaskIterable responses = client.pollForDecisionTaskPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maximumPageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
pollForDecisionTask(software.amazon.awssdk.services.swf.model.PollForDecisionTaskRequest)operation.
This is a convenience which creates an instance of the
PollForDecisionTaskRequest.Builderavoiding the need to create one manually viaPollForDecisionTaskRequest.builder()- Parameters:
pollForDecisionTaskRequest- AConsumerthat will call methods onPollForDecisionTaskRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 doesn't 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.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
recordActivityTaskHeartbeat
default RecordActivityTaskHeartbeatResponse recordActivityTaskHeartbeat(RecordActivityTaskHeartbeatRequest recordActivityTaskHeartbeatRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Used by activity workers to report to the service that the ActivityTask represented by the specified
taskTokenis still making progress. The worker can also specify details of the progress, for example percent complete, using thedetailsparameter. 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 booleancancelRequestedflag returned by the service is set totrue.This action resets the
taskHeartbeatTimeoutclock. ThetaskHeartbeatTimeoutis specified in RegisterActivityType.This action doesn't in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history contains a
ActivityTaskTimedOutevent that contains the information from the last heartbeat generated by the activity worker.The
taskStartToCloseTimeoutof an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. ThetaskStartToCloseTimeoutis also specified in RegisterActivityType.This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted.
If the
cancelRequestedflag returnstrue, a cancellation is being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
recordActivityTaskHeartbeatRequest-- Returns:
- Result of the RecordActivityTaskHeartbeat operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
recordActivityTaskHeartbeat
default RecordActivityTaskHeartbeatResponse recordActivityTaskHeartbeat(Consumer<RecordActivityTaskHeartbeatRequest.Builder> recordActivityTaskHeartbeatRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Used by activity workers to report to the service that the ActivityTask represented by the specified
taskTokenis still making progress. The worker can also specify details of the progress, for example percent complete, using thedetailsparameter. 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 booleancancelRequestedflag returned by the service is set totrue.This action resets the
taskHeartbeatTimeoutclock. ThetaskHeartbeatTimeoutis specified in RegisterActivityType.This action doesn't in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history contains a
ActivityTaskTimedOutevent that contains the information from the last heartbeat generated by the activity worker.The
taskStartToCloseTimeoutof an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. ThetaskStartToCloseTimeoutis also specified in RegisterActivityType.This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted.
If the
cancelRequestedflag returnstrue, a cancellation is being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
RecordActivityTaskHeartbeatRequest.Builderavoiding the need to create one manually viaRecordActivityTaskHeartbeatRequest.builder()- Parameters:
recordActivityTaskHeartbeatRequest- AConsumerthat will call methods onRecordActivityTaskHeartbeatRequest.Builderto create a request.- Returns:
- Result of the RecordActivityTaskHeartbeat operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
registerActivityType
default RegisterActivityTypeResponse registerActivityType(RegisterActivityTypeRequest registerActivityTypeRequest) throws TypeAlreadyExistsException, LimitExceededException, UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Registers a new activity type along with its configuration settings in the specified domain.
A
TypeAlreadyExistsfault is returned if the type already exists in the domain. You cannot change any configuration settings of the type after its registration, and it must be registered as a new version.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
defaultTaskList.name: String constraint. The key isswf:defaultTaskList.name. -
name: String constraint. The key isswf:name. -
version: String constraint. The key isswf:version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
registerActivityTypeRequest-- Returns:
- Result of the RegisterActivityType operation returned by the service.
- Throws:
TypeAlreadyExistsException- Returned if the type already exists in the specified domain. You may get this fault if you are registering a type that is either already registered or deprecated, or if you undeprecate a type that is currently registered.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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
registerActivityType
default RegisterActivityTypeResponse registerActivityType(Consumer<RegisterActivityTypeRequest.Builder> registerActivityTypeRequest) throws TypeAlreadyExistsException, LimitExceededException, UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Registers a new activity type along with its configuration settings in the specified domain.
A
TypeAlreadyExistsfault is returned if the type already exists in the domain. You cannot change any configuration settings of the type after its registration, and it must be registered as a new version.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
defaultTaskList.name: String constraint. The key isswf:defaultTaskList.name. -
name: String constraint. The key isswf:name. -
version: String constraint. The key isswf:version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
RegisterActivityTypeRequest.Builderavoiding the need to create one manually viaRegisterActivityTypeRequest.builder()- Parameters:
registerActivityTypeRequest- AConsumerthat will call methods onRegisterActivityTypeRequest.Builderto create a request.- Returns:
- Result of the RegisterActivityType operation returned by the service.
- Throws:
TypeAlreadyExistsException- Returned if the type already exists in the specified domain. You may get this fault if you are registering a type that is either already registered or deprecated, or if you undeprecate a type that is currently registered.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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
registerDomain
default RegisterDomainResponse registerDomain(RegisterDomainRequest registerDomainRequest) throws DomainAlreadyExistsException, LimitExceededException, OperationNotPermittedException, TooManyTagsException, AwsServiceException, 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:
-
You cannot use an IAM policy to control domain access for this action. The name of the domain being registered is available as the resource of this action.
-
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
registerDomainRequest-- Returns:
- Result of the RegisterDomain operation returned by the service.
- Throws:
DomainAlreadyExistsException- Returned if the domain already exists. You may get this fault if you are registering a domain that is either already registered or deprecated, or if you undeprecate a domain that is currently registered.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 doesn't have sufficient permissions to invoke the action.TooManyTagsException- You've exceeded the number of tags allowed for a domain.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
registerDomain
default RegisterDomainResponse registerDomain(Consumer<RegisterDomainRequest.Builder> registerDomainRequest) throws DomainAlreadyExistsException, LimitExceededException, OperationNotPermittedException, TooManyTagsException, AwsServiceException, 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:
-
You cannot use an IAM policy to control domain access for this action. The name of the domain being registered is available as the resource of this action.
-
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
RegisterDomainRequest.Builderavoiding the need to create one manually viaRegisterDomainRequest.builder()- Parameters:
registerDomainRequest- AConsumerthat will call methods onRegisterDomainRequest.Builderto create a request.- Returns:
- Result of the RegisterDomain operation returned by the service.
- Throws:
DomainAlreadyExistsException- Returned if the domain already exists. You may get this fault if you are registering a domain that is either already registered or deprecated, or if you undeprecate a domain that is currently registered.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 doesn't have sufficient permissions to invoke the action.TooManyTagsException- You've exceeded the number of tags allowed for a domain.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
registerWorkflowType
default RegisterWorkflowTypeResponse registerWorkflowType(RegisterWorkflowTypeRequest registerWorkflowTypeRequest) throws TypeAlreadyExistsException, LimitExceededException, UnknownResourceException, OperationNotPermittedException, AwsServiceException, 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.
If the type already exists, then a
TypeAlreadyExistsfault is returned. You cannot change the configuration settings of a workflow type once it is registered and it must be registered as a new version.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
defaultTaskList.name: String constraint. The key isswf:defaultTaskList.name. -
name: String constraint. The key isswf:name. -
version: String constraint. The key isswf:version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
registerWorkflowTypeRequest-- Returns:
- Result of the RegisterWorkflowType operation returned by the service.
- Throws:
TypeAlreadyExistsException- Returned if the type already exists in the specified domain. You may get this fault if you are registering a type that is either already registered or deprecated, or if you undeprecate a type that is currently registered.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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
registerWorkflowType
default RegisterWorkflowTypeResponse registerWorkflowType(Consumer<RegisterWorkflowTypeRequest.Builder> registerWorkflowTypeRequest) throws TypeAlreadyExistsException, LimitExceededException, UnknownResourceException, OperationNotPermittedException, AwsServiceException, 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.
If the type already exists, then a
TypeAlreadyExistsfault is returned. You cannot change the configuration settings of a workflow type once it is registered and it must be registered as a new version.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
defaultTaskList.name: String constraint. The key isswf:defaultTaskList.name. -
name: String constraint. The key isswf:name. -
version: String constraint. The key isswf:version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
RegisterWorkflowTypeRequest.Builderavoiding the need to create one manually viaRegisterWorkflowTypeRequest.builder()- Parameters:
registerWorkflowTypeRequest- AConsumerthat will call methods onRegisterWorkflowTypeRequest.Builderto create a request.- Returns:
- Result of the RegisterWorkflowType operation returned by the service.
- Throws:
TypeAlreadyExistsException- Returned if the type already exists in the specified domain. You may get this fault if you are registering a type that is either already registered or deprecated, or if you undeprecate a type that is currently registered.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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
requestCancelWorkflowExecution
default RequestCancelWorkflowExecutionResponse requestCancelWorkflowExecution(RequestCancelWorkflowExecutionRequest requestCancelWorkflowExecutionRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Records a
WorkflowExecutionCancelRequestedevent 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.If the runId isn't specified, the
WorkflowExecutionCancelRequestedevent is recorded in the history of the current open workflow execution with the specified workflowId in the domain.Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of TerminateWorkflowExecution when possible.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
requestCancelWorkflowExecutionRequest-- Returns:
- Result of the RequestCancelWorkflowExecution operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
requestCancelWorkflowExecution
default RequestCancelWorkflowExecutionResponse requestCancelWorkflowExecution(Consumer<RequestCancelWorkflowExecutionRequest.Builder> requestCancelWorkflowExecutionRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Records a
WorkflowExecutionCancelRequestedevent 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.If the runId isn't specified, the
WorkflowExecutionCancelRequestedevent is recorded in the history of the current open workflow execution with the specified workflowId in the domain.Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of TerminateWorkflowExecution when possible.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
RequestCancelWorkflowExecutionRequest.Builderavoiding the need to create one manually viaRequestCancelWorkflowExecutionRequest.builder()- Parameters:
requestCancelWorkflowExecutionRequest- AConsumerthat will call methods onRequestCancelWorkflowExecutionRequest.Builderto create a request.- Returns:
- Result of the RequestCancelWorkflowExecution operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
respondActivityTaskCanceled
default RespondActivityTaskCanceledResponse respondActivityTaskCanceled(RespondActivityTaskCanceledRequest respondActivityTaskCanceledRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Used by workers to tell the service that the ActivityTask identified by the
taskTokenwas successfully canceled. Additionaldetailscan be provided using thedetailsargument.These
details(if provided) appear in theActivityTaskCanceledevent added to the workflow history.Only use this operation if the
canceledflag of a RecordActivityTaskHeartbeat request returnstrueand if the activity can be safely undone or abandoned.A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
respondActivityTaskCanceledRequest-- Returns:
- Result of the RespondActivityTaskCanceled operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
respondActivityTaskCanceled
default RespondActivityTaskCanceledResponse respondActivityTaskCanceled(Consumer<RespondActivityTaskCanceledRequest.Builder> respondActivityTaskCanceledRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Used by workers to tell the service that the ActivityTask identified by the
taskTokenwas successfully canceled. Additionaldetailscan be provided using thedetailsargument.These
details(if provided) appear in theActivityTaskCanceledevent added to the workflow history.Only use this operation if the
canceledflag of a RecordActivityTaskHeartbeat request returnstrueand if the activity can be safely undone or abandoned.A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
RespondActivityTaskCanceledRequest.Builderavoiding the need to create one manually viaRespondActivityTaskCanceledRequest.builder()- Parameters:
respondActivityTaskCanceledRequest- AConsumerthat will call methods onRespondActivityTaskCanceledRequest.Builderto create a request.- Returns:
- Result of the RespondActivityTaskCanceled operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
respondActivityTaskCompleted
default RespondActivityTaskCompletedResponse respondActivityTaskCompleted(RespondActivityTaskCompletedRequest respondActivityTaskCompletedRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Used by workers to tell the service that the ActivityTask identified by the
taskTokencompleted successfully with aresult(if provided). Theresultappears in theActivityTaskCompletedevent in the workflow history.If the requested task doesn't complete successfully, use RespondActivityTaskFailed instead. If the worker finds that the task is canceled through the
canceledflag 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:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
respondActivityTaskCompletedRequest-- Returns:
- Result of the RespondActivityTaskCompleted operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
respondActivityTaskCompleted
default RespondActivityTaskCompletedResponse respondActivityTaskCompleted(Consumer<RespondActivityTaskCompletedRequest.Builder> respondActivityTaskCompletedRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Used by workers to tell the service that the ActivityTask identified by the
taskTokencompleted successfully with aresult(if provided). Theresultappears in theActivityTaskCompletedevent in the workflow history.If the requested task doesn't complete successfully, use RespondActivityTaskFailed instead. If the worker finds that the task is canceled through the
canceledflag 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:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
RespondActivityTaskCompletedRequest.Builderavoiding the need to create one manually viaRespondActivityTaskCompletedRequest.builder()- Parameters:
respondActivityTaskCompletedRequest- AConsumerthat will call methods onRespondActivityTaskCompletedRequest.Builderto create a request.- Returns:
- Result of the RespondActivityTaskCompleted operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
respondActivityTaskFailed
default RespondActivityTaskFailedResponse respondActivityTaskFailed(RespondActivityTaskFailedRequest respondActivityTaskFailedRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Used by workers to tell the service that the ActivityTask identified by the
taskTokenhas failed withreason(if specified). Thereasonanddetailsappear in theActivityTaskFailedevent 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:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
respondActivityTaskFailedRequest-- Returns:
- Result of the RespondActivityTaskFailed operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
respondActivityTaskFailed
default RespondActivityTaskFailedResponse respondActivityTaskFailed(Consumer<RespondActivityTaskFailedRequest.Builder> respondActivityTaskFailedRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Used by workers to tell the service that the ActivityTask identified by the
taskTokenhas failed withreason(if specified). Thereasonanddetailsappear in theActivityTaskFailedevent 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:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
RespondActivityTaskFailedRequest.Builderavoiding the need to create one manually viaRespondActivityTaskFailedRequest.builder()- Parameters:
respondActivityTaskFailedRequest- AConsumerthat will call methods onRespondActivityTaskFailedRequest.Builderto create a request.- Returns:
- Result of the RespondActivityTaskFailed operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
respondDecisionTaskCompleted
default RespondDecisionTaskCompletedResponse respondDecisionTaskCompleted(RespondDecisionTaskCompletedRequest respondDecisionTaskCompletedRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Used by deciders to tell the service that the DecisionTask identified by the
taskTokenhas successfully completed. Thedecisionsargument specifies the list of decisions made while processing the task.A
DecisionTaskCompletedevent is added to the workflow history. TheexecutionContextspecified 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 thedecisionsparameter. 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 in the Amazon SWF Developer Guide.- Parameters:
respondDecisionTaskCompletedRequest- Input data for a TaskCompleted response to a decision task.- Returns:
- Result of the RespondDecisionTaskCompleted operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
respondDecisionTaskCompleted
default RespondDecisionTaskCompletedResponse respondDecisionTaskCompleted(Consumer<RespondDecisionTaskCompletedRequest.Builder> respondDecisionTaskCompletedRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Used by deciders to tell the service that the DecisionTask identified by the
taskTokenhas successfully completed. Thedecisionsargument specifies the list of decisions made while processing the task.A
DecisionTaskCompletedevent is added to the workflow history. TheexecutionContextspecified 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 thedecisionsparameter. 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 in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
RespondDecisionTaskCompletedRequest.Builderavoiding the need to create one manually viaRespondDecisionTaskCompletedRequest.builder()- Parameters:
respondDecisionTaskCompletedRequest- AConsumerthat will call methods onRespondDecisionTaskCompletedRequest.Builderto create a request. Input data for a TaskCompleted response to a decision task.- Returns:
- Result of the RespondDecisionTaskCompleted operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
signalWorkflowExecution
default SignalWorkflowExecutionResponse signalWorkflowExecution(SignalWorkflowExecutionRequest signalWorkflowExecutionRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Records a
WorkflowExecutionSignaledevent in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided).If a runId isn't specified, then the
WorkflowExecutionSignaledevent is recorded in the history of the current open workflow with the matching workflowId in the domain.If the specified workflow execution isn't open, this method fails with
UnknownResource.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
signalWorkflowExecutionRequest-- Returns:
- Result of the SignalWorkflowExecution operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
signalWorkflowExecution
default SignalWorkflowExecutionResponse signalWorkflowExecution(Consumer<SignalWorkflowExecutionRequest.Builder> signalWorkflowExecutionRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Records a
WorkflowExecutionSignaledevent in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided).If a runId isn't specified, then the
WorkflowExecutionSignaledevent is recorded in the history of the current open workflow with the matching workflowId in the domain.If the specified workflow execution isn't open, this method fails with
UnknownResource.Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
SignalWorkflowExecutionRequest.Builderavoiding the need to create one manually viaSignalWorkflowExecutionRequest.builder()- Parameters:
signalWorkflowExecutionRequest- AConsumerthat will call methods onSignalWorkflowExecutionRequest.Builderto create a request.- Returns:
- Result of the SignalWorkflowExecution operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
startWorkflowExecution
default StartWorkflowExecutionResponse startWorkflowExecution(StartWorkflowExecutionRequest startWorkflowExecutionRequest) throws UnknownResourceException, TypeDeprecatedException, WorkflowExecutionAlreadyStartedException, LimitExceededException, OperationNotPermittedException, DefaultUndefinedException, AwsServiceException, SdkClientException, SwfException
Starts an execution of the workflow type in the specified domain using the provided
workflowIdand input data.This action returns the newly started workflow execution.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
tagList.member.0: The key isswf:tagList.member.0. -
tagList.member.1: The key isswf:tagList.member.1. -
tagList.member.2: The key isswf:tagList.member.2. -
tagList.member.3: The key isswf:tagList.member.3. -
tagList.member.4: The key isswf:tagList.member.4. -
taskList: String constraint. The key isswf:taskList.name. -
workflowType.name: String constraint. The key isswf:workflowType.name. -
workflowType.version: String constraint. The key isswf:workflowType.version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
startWorkflowExecutionRequest-- Returns:
- Result of the StartWorkflowExecution operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.DefaultUndefinedException- TheStartWorkflowExecutionAPI action was called without the required parameters set.Some workflow execution parameters, such as the decision
taskList, must be set to start the execution. However, these parameters might have been set as defaults when the workflow type was registered. In this case, you can omit these parameters from theStartWorkflowExecutioncall and Amazon SWF uses the values defined in the workflow type.If these parameters aren't set and no default parameters were defined in the workflow type, this error is displayed.
SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
startWorkflowExecution
default StartWorkflowExecutionResponse startWorkflowExecution(Consumer<StartWorkflowExecutionRequest.Builder> startWorkflowExecutionRequest) throws UnknownResourceException, TypeDeprecatedException, WorkflowExecutionAlreadyStartedException, LimitExceededException, OperationNotPermittedException, DefaultUndefinedException, AwsServiceException, SdkClientException, SwfException
Starts an execution of the workflow type in the specified domain using the provided
workflowIdand input data.This action returns the newly started workflow execution.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
tagList.member.0: The key isswf:tagList.member.0. -
tagList.member.1: The key isswf:tagList.member.1. -
tagList.member.2: The key isswf:tagList.member.2. -
tagList.member.3: The key isswf:tagList.member.3. -
tagList.member.4: The key isswf:tagList.member.4. -
taskList: String constraint. The key isswf:taskList.name. -
workflowType.name: String constraint. The key isswf:workflowType.name. -
workflowType.version: String constraint. The key isswf:workflowType.version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
StartWorkflowExecutionRequest.Builderavoiding the need to create one manually viaStartWorkflowExecutionRequest.builder()- Parameters:
startWorkflowExecutionRequest- AConsumerthat will call methods onStartWorkflowExecutionRequest.Builderto create a request.- Returns:
- Result of the StartWorkflowExecution operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.DefaultUndefinedException- TheStartWorkflowExecutionAPI action was called without the required parameters set.Some workflow execution parameters, such as the decision
taskList, must be set to start the execution. However, these parameters might have been set as defaults when the workflow type was registered. In this case, you can omit these parameters from theStartWorkflowExecutioncall and Amazon SWF uses the values defined in the workflow type.If these parameters aren't set and no default parameters were defined in the workflow type, this error is displayed.
SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws UnknownResourceException, TooManyTagsException, LimitExceededException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Add a tag to a Amazon SWF domain.
Amazon SWF supports a maximum of 50 tags per resource.
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.TooManyTagsException- You've exceeded the number of tags allowed for a 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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws UnknownResourceException, TooManyTagsException, LimitExceededException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Add a tag to a Amazon SWF domain.
Amazon SWF supports a maximum of 50 tags per resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.TooManyTagsException- You've exceeded the number of tags allowed for a 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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
terminateWorkflowExecution
default TerminateWorkflowExecutionResponse terminateWorkflowExecution(TerminateWorkflowExecutionRequest terminateWorkflowExecutionRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Records a
WorkflowExecutionTerminatedevent 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.If the identified workflow execution was in progress, it is terminated immediately.
If a runId isn't specified, then the
WorkflowExecutionTerminatedevent is recorded in the history of the current open workflow with the matching workflowId in the domain.You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution doesn't.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
terminateWorkflowExecutionRequest-- Returns:
- Result of the TerminateWorkflowExecution operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
terminateWorkflowExecution
default TerminateWorkflowExecutionResponse terminateWorkflowExecution(Consumer<TerminateWorkflowExecutionRequest.Builder> terminateWorkflowExecutionRequest) throws UnknownResourceException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Records a
WorkflowExecutionTerminatedevent 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.If the identified workflow execution was in progress, it is terminated immediately.
If a runId isn't specified, then the
WorkflowExecutionTerminatedevent is recorded in the history of the current open workflow with the matching workflowId in the domain.You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution doesn't.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
TerminateWorkflowExecutionRequest.Builderavoiding the need to create one manually viaTerminateWorkflowExecutionRequest.builder()- Parameters:
terminateWorkflowExecutionRequest- AConsumerthat will call methods onTerminateWorkflowExecutionRequest.Builderto create a request.- Returns:
- Result of the TerminateWorkflowExecution operation returned by the service.
- Throws:
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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
undeprecateActivityType
default UndeprecateActivityTypeResponse undeprecateActivityType(UndeprecateActivityTypeRequest undeprecateActivityTypeRequest) throws UnknownResourceException, TypeAlreadyExistsException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Undeprecates a previously deprecated activity type. After an activity type has been undeprecated, you can create new tasks of that activity type.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
activityType.name: String constraint. The key isswf:activityType.name. -
activityType.version: String constraint. The key isswf:activityType.version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
undeprecateActivityTypeRequest-- Returns:
- Result of the UndeprecateActivityType operation returned by the service.
- Throws:
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.TypeAlreadyExistsException- Returned if the type already exists in the specified domain. You may get this fault if you are registering a type that is either already registered or deprecated, or if you undeprecate a type that is currently registered.OperationNotPermittedException- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
undeprecateActivityType
default UndeprecateActivityTypeResponse undeprecateActivityType(Consumer<UndeprecateActivityTypeRequest.Builder> undeprecateActivityTypeRequest) throws UnknownResourceException, TypeAlreadyExistsException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Undeprecates a previously deprecated activity type. After an activity type has been undeprecated, you can create new tasks of that activity type.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
activityType.name: String constraint. The key isswf:activityType.name. -
activityType.version: String constraint. The key isswf:activityType.version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
UndeprecateActivityTypeRequest.Builderavoiding the need to create one manually viaUndeprecateActivityTypeRequest.builder()- Parameters:
undeprecateActivityTypeRequest- AConsumerthat will call methods onUndeprecateActivityTypeRequest.Builderto create a request.- Returns:
- Result of the UndeprecateActivityType operation returned by the service.
- Throws:
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.TypeAlreadyExistsException- Returned if the type already exists in the specified domain. You may get this fault if you are registering a type that is either already registered or deprecated, or if you undeprecate a type that is currently registered.OperationNotPermittedException- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
undeprecateDomain
default UndeprecateDomainResponse undeprecateDomain(UndeprecateDomainRequest undeprecateDomainRequest) throws UnknownResourceException, DomainAlreadyExistsException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Undeprecates a previously deprecated domain. After a domain has been undeprecated it can be used to create new workflow executions or register new types.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
undeprecateDomainRequest-- Returns:
- Result of the UndeprecateDomain operation returned by the service.
- Throws:
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.DomainAlreadyExistsException- Returned if the domain already exists. You may get this fault if you are registering a domain that is either already registered or deprecated, or if you undeprecate a domain that is currently registered.OperationNotPermittedException- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
undeprecateDomain
default UndeprecateDomainResponse undeprecateDomain(Consumer<UndeprecateDomainRequest.Builder> undeprecateDomainRequest) throws UnknownResourceException, DomainAlreadyExistsException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Undeprecates a previously deprecated domain. After a domain has been undeprecated it can be used to create new workflow executions or register new types.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
UndeprecateDomainRequest.Builderavoiding the need to create one manually viaUndeprecateDomainRequest.builder()- Parameters:
undeprecateDomainRequest- AConsumerthat will call methods onUndeprecateDomainRequest.Builderto create a request.- Returns:
- Result of the UndeprecateDomain operation returned by the service.
- Throws:
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.DomainAlreadyExistsException- Returned if the domain already exists. You may get this fault if you are registering a domain that is either already registered or deprecated, or if you undeprecate a domain that is currently registered.OperationNotPermittedException- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
undeprecateWorkflowType
default UndeprecateWorkflowTypeResponse undeprecateWorkflowType(UndeprecateWorkflowTypeRequest undeprecateWorkflowTypeRequest) throws UnknownResourceException, TypeAlreadyExistsException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Undeprecates a previously deprecated workflow type. After a workflow type has been undeprecated, you can create new executions of that type.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
workflowType.name: String constraint. The key isswf:workflowType.name. -
workflowType.version: String constraint. The key isswf:workflowType.version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.- Parameters:
undeprecateWorkflowTypeRequest-- Returns:
- Result of the UndeprecateWorkflowType operation returned by the service.
- Throws:
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.TypeAlreadyExistsException- Returned if the type already exists in the specified domain. You may get this fault if you are registering a type that is either already registered or deprecated, or if you undeprecate a type that is currently registered.OperationNotPermittedException- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
undeprecateWorkflowType
default UndeprecateWorkflowTypeResponse undeprecateWorkflowType(Consumer<UndeprecateWorkflowTypeRequest.Builder> undeprecateWorkflowTypeRequest) throws UnknownResourceException, TypeAlreadyExistsException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Undeprecates a previously deprecated workflow type. After a workflow type has been undeprecated, you can create new executions of that type.
This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
workflowType.name: String constraint. The key isswf:workflowType.name. -
workflowType.version: String constraint. The key isswf:workflowType.version.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
causeparameter is set toOPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
This is a convenience which creates an instance of the
UndeprecateWorkflowTypeRequest.Builderavoiding the need to create one manually viaUndeprecateWorkflowTypeRequest.builder()- Parameters:
undeprecateWorkflowTypeRequest- AConsumerthat will call methods onUndeprecateWorkflowTypeRequest.Builderto create a request.- Returns:
- Result of the UndeprecateWorkflowType operation returned by the service.
- Throws:
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.TypeAlreadyExistsException- Returned if the type already exists in the specified domain. You may get this fault if you are registering a type that is either already registered or deprecated, or if you undeprecate a type that is currently registered.OperationNotPermittedException- Returned when the caller doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws UnknownResourceException, LimitExceededException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Remove a tag from a Amazon SWF domain.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws UnknownResourceException, LimitExceededException, OperationNotPermittedException, AwsServiceException, SdkClientException, SwfException
Remove a tag from a Amazon SWF domain.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.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 doesn't have sufficient permissions to invoke the action.SdkException- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
-
create
static SwfClient create()
Create aSwfClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static SwfClientBuilder builder()
Create a builder that can be used to configure and create aSwfClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default SwfServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-