software.amazon.awssdk.services.swf.SwfAsyncClient Maven / Gradle / Ivy
Show all versions of swf Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.swf;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.AwsClient;
import software.amazon.awssdk.services.swf.model.CountClosedWorkflowExecutionsRequest;
import software.amazon.awssdk.services.swf.model.CountClosedWorkflowExecutionsResponse;
import software.amazon.awssdk.services.swf.model.CountOpenWorkflowExecutionsRequest;
import software.amazon.awssdk.services.swf.model.CountOpenWorkflowExecutionsResponse;
import software.amazon.awssdk.services.swf.model.CountPendingActivityTasksRequest;
import software.amazon.awssdk.services.swf.model.CountPendingActivityTasksResponse;
import software.amazon.awssdk.services.swf.model.CountPendingDecisionTasksRequest;
import software.amazon.awssdk.services.swf.model.CountPendingDecisionTasksResponse;
import software.amazon.awssdk.services.swf.model.DeleteActivityTypeRequest;
import software.amazon.awssdk.services.swf.model.DeleteActivityTypeResponse;
import software.amazon.awssdk.services.swf.model.DeleteWorkflowTypeRequest;
import software.amazon.awssdk.services.swf.model.DeleteWorkflowTypeResponse;
import software.amazon.awssdk.services.swf.model.DeprecateActivityTypeRequest;
import software.amazon.awssdk.services.swf.model.DeprecateActivityTypeResponse;
import software.amazon.awssdk.services.swf.model.DeprecateDomainRequest;
import software.amazon.awssdk.services.swf.model.DeprecateDomainResponse;
import software.amazon.awssdk.services.swf.model.DeprecateWorkflowTypeRequest;
import software.amazon.awssdk.services.swf.model.DeprecateWorkflowTypeResponse;
import software.amazon.awssdk.services.swf.model.DescribeActivityTypeRequest;
import software.amazon.awssdk.services.swf.model.DescribeActivityTypeResponse;
import software.amazon.awssdk.services.swf.model.DescribeDomainRequest;
import software.amazon.awssdk.services.swf.model.DescribeDomainResponse;
import software.amazon.awssdk.services.swf.model.DescribeWorkflowExecutionRequest;
import software.amazon.awssdk.services.swf.model.DescribeWorkflowExecutionResponse;
import software.amazon.awssdk.services.swf.model.DescribeWorkflowTypeRequest;
import software.amazon.awssdk.services.swf.model.DescribeWorkflowTypeResponse;
import software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryRequest;
import software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryResponse;
import software.amazon.awssdk.services.swf.model.ListActivityTypesRequest;
import software.amazon.awssdk.services.swf.model.ListActivityTypesResponse;
import software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsRequest;
import software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsResponse;
import software.amazon.awssdk.services.swf.model.ListDomainsRequest;
import software.amazon.awssdk.services.swf.model.ListDomainsResponse;
import software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsRequest;
import software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsResponse;
import software.amazon.awssdk.services.swf.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.swf.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.swf.model.ListWorkflowTypesRequest;
import software.amazon.awssdk.services.swf.model.ListWorkflowTypesResponse;
import software.amazon.awssdk.services.swf.model.PollForActivityTaskRequest;
import software.amazon.awssdk.services.swf.model.PollForActivityTaskResponse;
import software.amazon.awssdk.services.swf.model.PollForDecisionTaskRequest;
import software.amazon.awssdk.services.swf.model.PollForDecisionTaskResponse;
import software.amazon.awssdk.services.swf.model.RecordActivityTaskHeartbeatRequest;
import software.amazon.awssdk.services.swf.model.RecordActivityTaskHeartbeatResponse;
import software.amazon.awssdk.services.swf.model.RegisterActivityTypeRequest;
import software.amazon.awssdk.services.swf.model.RegisterActivityTypeResponse;
import software.amazon.awssdk.services.swf.model.RegisterDomainRequest;
import software.amazon.awssdk.services.swf.model.RegisterDomainResponse;
import software.amazon.awssdk.services.swf.model.RegisterWorkflowTypeRequest;
import software.amazon.awssdk.services.swf.model.RegisterWorkflowTypeResponse;
import software.amazon.awssdk.services.swf.model.RequestCancelWorkflowExecutionRequest;
import software.amazon.awssdk.services.swf.model.RequestCancelWorkflowExecutionResponse;
import software.amazon.awssdk.services.swf.model.RespondActivityTaskCanceledRequest;
import software.amazon.awssdk.services.swf.model.RespondActivityTaskCanceledResponse;
import software.amazon.awssdk.services.swf.model.RespondActivityTaskCompletedRequest;
import software.amazon.awssdk.services.swf.model.RespondActivityTaskCompletedResponse;
import software.amazon.awssdk.services.swf.model.RespondActivityTaskFailedRequest;
import software.amazon.awssdk.services.swf.model.RespondActivityTaskFailedResponse;
import software.amazon.awssdk.services.swf.model.RespondDecisionTaskCompletedRequest;
import software.amazon.awssdk.services.swf.model.RespondDecisionTaskCompletedResponse;
import software.amazon.awssdk.services.swf.model.SignalWorkflowExecutionRequest;
import software.amazon.awssdk.services.swf.model.SignalWorkflowExecutionResponse;
import software.amazon.awssdk.services.swf.model.StartWorkflowExecutionRequest;
import software.amazon.awssdk.services.swf.model.StartWorkflowExecutionResponse;
import software.amazon.awssdk.services.swf.model.TagResourceRequest;
import software.amazon.awssdk.services.swf.model.TagResourceResponse;
import software.amazon.awssdk.services.swf.model.TerminateWorkflowExecutionRequest;
import software.amazon.awssdk.services.swf.model.TerminateWorkflowExecutionResponse;
import software.amazon.awssdk.services.swf.model.UndeprecateActivityTypeRequest;
import software.amazon.awssdk.services.swf.model.UndeprecateActivityTypeResponse;
import software.amazon.awssdk.services.swf.model.UndeprecateDomainRequest;
import software.amazon.awssdk.services.swf.model.UndeprecateDomainResponse;
import software.amazon.awssdk.services.swf.model.UndeprecateWorkflowTypeRequest;
import software.amazon.awssdk.services.swf.model.UndeprecateWorkflowTypeResponse;
import software.amazon.awssdk.services.swf.model.UntagResourceRequest;
import software.amazon.awssdk.services.swf.model.UntagResourceResponse;
import software.amazon.awssdk.services.swf.paginators.GetWorkflowExecutionHistoryPublisher;
import software.amazon.awssdk.services.swf.paginators.ListActivityTypesPublisher;
import software.amazon.awssdk.services.swf.paginators.ListClosedWorkflowExecutionsPublisher;
import software.amazon.awssdk.services.swf.paginators.ListDomainsPublisher;
import software.amazon.awssdk.services.swf.paginators.ListOpenWorkflowExecutionsPublisher;
import software.amazon.awssdk.services.swf.paginators.ListWorkflowTypesPublisher;
import software.amazon.awssdk.services.swf.paginators.PollForDecisionTaskPublisher;
/**
* Service client for accessing Amazon SWF asynchronously. This can be created using the static {@link #builder()}
* method.The asynchronous client performs non-blocking I/O when configured with any {@code SdkAsyncHttpClient}
* supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
* some cases such as credentials retrieval and endpoint discovery as part of the async API call.
*
* 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 .
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface SwfAsyncClient extends AwsClient {
String SERVICE_NAME = "swf";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "swf";
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* tagFilter.tag: String constraint. The key is swf:tagFilter.tag.
*
*
* -
*
* typeFilter.name: String constraint. The key is swf:typeFilter.name.
*
*
* -
*
* typeFilter.version: String constraint. The key is swf:typeFilter.version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param countClosedWorkflowExecutionsRequest
* @return A Java Future containing the result of the CountClosedWorkflowExecutions operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.CountClosedWorkflowExecutions
*/
default CompletableFuture countClosedWorkflowExecutions(
CountClosedWorkflowExecutionsRequest countClosedWorkflowExecutionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* tagFilter.tag: String constraint. The key is swf:tagFilter.tag.
*
*
* -
*
* typeFilter.name: String constraint. The key is swf:typeFilter.name.
*
*
* -
*
* typeFilter.version: String constraint. The key is swf:typeFilter.version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_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 {@link CountClosedWorkflowExecutionsRequest.Builder}
* avoiding the need to create one manually via {@link CountClosedWorkflowExecutionsRequest#builder()}
*
*
* @param countClosedWorkflowExecutionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.CountClosedWorkflowExecutionsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CountClosedWorkflowExecutions operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.CountClosedWorkflowExecutions
*/
default CompletableFuture countClosedWorkflowExecutions(
Consumer countClosedWorkflowExecutionsRequest) {
return countClosedWorkflowExecutions(CountClosedWorkflowExecutionsRequest.builder()
.applyMutation(countClosedWorkflowExecutionsRequest).build());
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* tagFilter.tag: String constraint. The key is swf:tagFilter.tag.
*
*
* -
*
* typeFilter.name: String constraint. The key is swf:typeFilter.name.
*
*
* -
*
* typeFilter.version: String constraint. The key is swf:typeFilter.version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param countOpenWorkflowExecutionsRequest
* @return A Java Future containing the result of the CountOpenWorkflowExecutions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.CountOpenWorkflowExecutions
*/
default CompletableFuture countOpenWorkflowExecutions(
CountOpenWorkflowExecutionsRequest countOpenWorkflowExecutionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* tagFilter.tag: String constraint. The key is swf:tagFilter.tag.
*
*
* -
*
* typeFilter.name: String constraint. The key is swf:typeFilter.name.
*
*
* -
*
* typeFilter.version: String constraint. The key is swf:typeFilter.version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_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 {@link CountOpenWorkflowExecutionsRequest.Builder}
* avoiding the need to create one manually via {@link CountOpenWorkflowExecutionsRequest#builder()}
*
*
* @param countOpenWorkflowExecutionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.CountOpenWorkflowExecutionsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CountOpenWorkflowExecutions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.CountOpenWorkflowExecutions
*/
default CompletableFuture countOpenWorkflowExecutions(
Consumer countOpenWorkflowExecutionsRequest) {
return countOpenWorkflowExecutions(CountOpenWorkflowExecutionsRequest.builder()
.applyMutation(countOpenWorkflowExecutionsRequest).build());
}
/**
*
* 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
* 0 is returned.
*
*
* Access Control
*
*
* You can use IAM policies to control this action's access to Amazon SWF resources as follows:
*
*
* -
*
* Use a Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the taskList.name parameter by using a Condition element with the
* swf:taskList.name key to allow the action to access only certain task lists.
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param countPendingActivityTasksRequest
* @return A Java Future containing the result of the CountPendingActivityTasks operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.CountPendingActivityTasks
*/
default CompletableFuture countPendingActivityTasks(
CountPendingActivityTasksRequest countPendingActivityTasksRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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
* 0 is returned.
*
*
* Access Control
*
*
* You can use IAM policies to control this action's access to Amazon SWF resources as follows:
*
*
* -
*
* Use a Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the taskList.name parameter by using a Condition element with the
* swf:taskList.name key to allow the action to access only certain task lists.
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_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 {@link CountPendingActivityTasksRequest.Builder} avoiding
* the need to create one manually via {@link CountPendingActivityTasksRequest#builder()}
*
*
* @param countPendingActivityTasksRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.CountPendingActivityTasksRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CountPendingActivityTasks operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.CountPendingActivityTasks
*/
default CompletableFuture countPendingActivityTasks(
Consumer countPendingActivityTasksRequest) {
return countPendingActivityTasks(CountPendingActivityTasksRequest.builder()
.applyMutation(countPendingActivityTasksRequest).build());
}
/**
*
* 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
* 0 is returned.
*
*
* Access Control
*
*
* You can use IAM policies to control this action's access to Amazon SWF resources as follows:
*
*
* -
*
* Use a Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the taskList.name parameter by using a Condition element with the
* swf:taskList.name key to allow the action to access only certain task lists.
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param countPendingDecisionTasksRequest
* @return A Java Future containing the result of the CountPendingDecisionTasks operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.CountPendingDecisionTasks
*/
default CompletableFuture countPendingDecisionTasks(
CountPendingDecisionTasksRequest countPendingDecisionTasksRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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
* 0 is returned.
*
*
* Access Control
*
*
* You can use IAM policies to control this action's access to Amazon SWF resources as follows:
*
*
* -
*
* Use a Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the taskList.name parameter by using a Condition element with the
* swf:taskList.name key to allow the action to access only certain task lists.
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_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 {@link CountPendingDecisionTasksRequest.Builder} avoiding
* the need to create one manually via {@link CountPendingDecisionTasksRequest#builder()}
*
*
* @param countPendingDecisionTasksRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.CountPendingDecisionTasksRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CountPendingDecisionTasks operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.CountPendingDecisionTasks
*/
default CompletableFuture countPendingDecisionTasks(
Consumer countPendingDecisionTasksRequest) {
return countPendingDecisionTasks(CountPendingDecisionTasksRequest.builder()
.applyMutation(countPendingDecisionTasksRequest).build());
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* activityType.name: String constraint. The key is swf:activityType.name.
*
*
* -
*
* activityType.version: String constraint. The key is swf:activityType.version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param deleteActivityTypeRequest
* @return A Java Future containing the result of the DeleteActivityType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.DeleteActivityType
*/
default CompletableFuture deleteActivityType(DeleteActivityTypeRequest deleteActivityTypeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* activityType.name: String constraint. The key is swf:activityType.name.
*
*
* -
*
* activityType.version: String constraint. The key is swf:activityType.version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_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 {@link DeleteActivityTypeRequest.Builder} avoiding the
* need to create one manually via {@link DeleteActivityTypeRequest#builder()}
*
*
* @param deleteActivityTypeRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.DeleteActivityTypeRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteActivityType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.DeleteActivityType
*/
default CompletableFuture deleteActivityType(
Consumer deleteActivityTypeRequest) {
return deleteActivityType(DeleteActivityTypeRequest.builder().applyMutation(deleteActivityTypeRequest).build());
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* workflowType.name: String constraint. The key is swf:workflowType.name.
*
*
* -
*
* workflowType.version: String constraint. The key is swf:workflowType.version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param deleteWorkflowTypeRequest
* @return A Java Future containing the result of the DeleteWorkflowType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.DeleteWorkflowType
*/
default CompletableFuture deleteWorkflowType(DeleteWorkflowTypeRequest deleteWorkflowTypeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* workflowType.name: String constraint. The key is swf:workflowType.name.
*
*
* -
*
* workflowType.version: String constraint. The key is swf:workflowType.version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_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 {@link DeleteWorkflowTypeRequest.Builder} avoiding the
* need to create one manually via {@link DeleteWorkflowTypeRequest#builder()}
*
*
* @param deleteWorkflowTypeRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.DeleteWorkflowTypeRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteWorkflowType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.DeleteWorkflowType
*/
default CompletableFuture deleteWorkflowType(
Consumer deleteWorkflowTypeRequest) {
return deleteWorkflowType(DeleteWorkflowTypeRequest.builder().applyMutation(deleteWorkflowTypeRequest).build());
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* activityType.name: String constraint. The key is swf:activityType.name.
*
*
* -
*
* activityType.version: String constraint. The key is swf:activityType.version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param deprecateActivityTypeRequest
* @return A Java Future containing the result of the DeprecateActivityType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.DeprecateActivityType
*/
default CompletableFuture deprecateActivityType(
DeprecateActivityTypeRequest deprecateActivityTypeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* activityType.name: String constraint. The key is swf:activityType.name.
*
*
* -
*
* activityType.version: String constraint. The key is swf:activityType.version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_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 {@link DeprecateActivityTypeRequest.Builder} avoiding the
* need to create one manually via {@link DeprecateActivityTypeRequest#builder()}
*
*
* @param deprecateActivityTypeRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.DeprecateActivityTypeRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeprecateActivityType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.DeprecateActivityType
*/
default CompletableFuture deprecateActivityType(
Consumer deprecateActivityTypeRequest) {
return deprecateActivityType(DeprecateActivityTypeRequest.builder().applyMutation(deprecateActivityTypeRequest).build());
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param deprecateDomainRequest
* @return A Java Future containing the result of the DeprecateDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.DeprecateDomain
*/
default CompletableFuture deprecateDomain(DeprecateDomainRequest deprecateDomainRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_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 {@link DeprecateDomainRequest.Builder} avoiding the need
* to create one manually via {@link DeprecateDomainRequest#builder()}
*
*
* @param deprecateDomainRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.DeprecateDomainRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeprecateDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.DeprecateDomain
*/
default CompletableFuture deprecateDomain(
Consumer deprecateDomainRequest) {
return deprecateDomain(DeprecateDomainRequest.builder().applyMutation(deprecateDomainRequest).build());
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* workflowType.name: String constraint. The key is swf:workflowType.name.
*
*
* -
*
* workflowType.version: String constraint. The key is swf:workflowType.version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param deprecateWorkflowTypeRequest
* @return A Java Future containing the result of the DeprecateWorkflowType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.DeprecateWorkflowType
*/
default CompletableFuture deprecateWorkflowType(
DeprecateWorkflowTypeRequest deprecateWorkflowTypeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* workflowType.name: String constraint. The key is swf:workflowType.name.
*
*
* -
*
* workflowType.version: String constraint. The key is swf:workflowType.version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_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 {@link DeprecateWorkflowTypeRequest.Builder} avoiding the
* need to create one manually via {@link DeprecateWorkflowTypeRequest#builder()}
*
*
* @param deprecateWorkflowTypeRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.DeprecateWorkflowTypeRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeprecateWorkflowType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.DeprecateWorkflowType
*/
default CompletableFuture deprecateWorkflowType(
Consumer deprecateWorkflowTypeRequest) {
return deprecateWorkflowType(DeprecateWorkflowTypeRequest.builder().applyMutation(deprecateWorkflowTypeRequest).build());
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* activityType.name: String constraint. The key is swf:activityType.name.
*
*
* -
*
* activityType.version: String constraint. The key is swf:activityType.version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param describeActivityTypeRequest
* @return A Java Future containing the result of the DescribeActivityType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.DescribeActivityType
*/
default CompletableFuture describeActivityType(
DescribeActivityTypeRequest describeActivityTypeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* activityType.name: String constraint. The key is swf:activityType.name.
*
*
* -
*
* activityType.version: String constraint. The key is swf:activityType.version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_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 {@link DescribeActivityTypeRequest.Builder} avoiding the
* need to create one manually via {@link DescribeActivityTypeRequest#builder()}
*
*
* @param describeActivityTypeRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.DescribeActivityTypeRequest.Builder} to create a request.
* @return A Java Future containing the result of the DescribeActivityType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.DescribeActivityType
*/
default CompletableFuture describeActivityType(
Consumer describeActivityTypeRequest) {
return describeActivityType(DescribeActivityTypeRequest.builder().applyMutation(describeActivityTypeRequest).build());
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param describeDomainRequest
* @return A Java Future containing the result of the DescribeDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.DescribeDomain
*/
default CompletableFuture describeDomain(DescribeDomainRequest describeDomainRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_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 {@link DescribeDomainRequest.Builder} avoiding the need to
* create one manually via {@link DescribeDomainRequest#builder()}
*
*
* @param describeDomainRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.DescribeDomainRequest.Builder} to create a request.
* @return A Java Future containing the result of the DescribeDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.DescribeDomain
*/
default CompletableFuture describeDomain(Consumer describeDomainRequest) {
return describeDomain(DescribeDomainRequest.builder().applyMutation(describeDomainRequest).build());
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param describeWorkflowExecutionRequest
* @return A Java Future containing the result of the DescribeWorkflowExecution operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.DescribeWorkflowExecution
*/
default CompletableFuture describeWorkflowExecution(
DescribeWorkflowExecutionRequest describeWorkflowExecutionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_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 {@link DescribeWorkflowExecutionRequest.Builder} avoiding
* the need to create one manually via {@link DescribeWorkflowExecutionRequest#builder()}
*
*
* @param describeWorkflowExecutionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.DescribeWorkflowExecutionRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeWorkflowExecution operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.DescribeWorkflowExecution
*/
default CompletableFuture describeWorkflowExecution(
Consumer describeWorkflowExecutionRequest) {
return describeWorkflowExecution(DescribeWorkflowExecutionRequest.builder()
.applyMutation(describeWorkflowExecutionRequest).build());
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* workflowType.name: String constraint. The key is swf:workflowType.name.
*
*
* -
*
* workflowType.version: String constraint. The key is swf:workflowType.version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param describeWorkflowTypeRequest
* @return A Java Future containing the result of the DescribeWorkflowType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.DescribeWorkflowType
*/
default CompletableFuture describeWorkflowType(
DescribeWorkflowTypeRequest describeWorkflowTypeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* workflowType.name: String constraint. The key is swf:workflowType.name.
*
*
* -
*
* workflowType.version: String constraint. The key is swf:workflowType.version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_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 {@link DescribeWorkflowTypeRequest.Builder} avoiding the
* need to create one manually via {@link DescribeWorkflowTypeRequest#builder()}
*
*
* @param describeWorkflowTypeRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.DescribeWorkflowTypeRequest.Builder} to create a request.
* @return A Java Future containing the result of the DescribeWorkflowType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.DescribeWorkflowType
*/
default CompletableFuture describeWorkflowType(
Consumer describeWorkflowTypeRequest) {
return describeWorkflowType(DescribeWorkflowTypeRequest.builder().applyMutation(describeWorkflowTypeRequest).build());
}
/**
*
* Returns the history of the specified workflow execution. The results may be split into multiple pages. To
* retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
*
*
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param getWorkflowExecutionHistoryRequest
* @return A Java Future containing the result of the GetWorkflowExecutionHistory operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.GetWorkflowExecutionHistory
*/
default CompletableFuture getWorkflowExecutionHistory(
GetWorkflowExecutionHistoryRequest getWorkflowExecutionHistoryRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the history of the specified workflow execution. The results may be split into multiple pages. To
* retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
*
*
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_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 {@link GetWorkflowExecutionHistoryRequest.Builder}
* avoiding the need to create one manually via {@link GetWorkflowExecutionHistoryRequest#builder()}
*
*
* @param getWorkflowExecutionHistoryRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetWorkflowExecutionHistory operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.GetWorkflowExecutionHistory
*/
default CompletableFuture getWorkflowExecutionHistory(
Consumer getWorkflowExecutionHistoryRequest) {
return getWorkflowExecutionHistory(GetWorkflowExecutionHistoryRequest.builder()
.applyMutation(getWorkflowExecutionHistoryRequest).build());
}
/**
*
* This is a variant of
* {@link #getWorkflowExecutionHistory(software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.swf.paginators.GetWorkflowExecutionHistoryPublisher publisher = client.getWorkflowExecutionHistoryPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.swf.paginators.GetWorkflowExecutionHistoryPublisher publisher = client.getWorkflowExecutionHistoryPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #getWorkflowExecutionHistory(software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryRequest)}
* operation.
*
*
* @param getWorkflowExecutionHistoryRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.GetWorkflowExecutionHistory
*/
default GetWorkflowExecutionHistoryPublisher getWorkflowExecutionHistoryPaginator(
GetWorkflowExecutionHistoryRequest getWorkflowExecutionHistoryRequest) {
return new GetWorkflowExecutionHistoryPublisher(this, getWorkflowExecutionHistoryRequest);
}
/**
*
* This is a variant of
* {@link #getWorkflowExecutionHistory(software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.swf.paginators.GetWorkflowExecutionHistoryPublisher publisher = client.getWorkflowExecutionHistoryPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.swf.paginators.GetWorkflowExecutionHistoryPublisher publisher = client.getWorkflowExecutionHistoryPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #getWorkflowExecutionHistory(software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link GetWorkflowExecutionHistoryRequest.Builder}
* avoiding the need to create one manually via {@link GetWorkflowExecutionHistoryRequest#builder()}
*
*
* @param getWorkflowExecutionHistoryRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.GetWorkflowExecutionHistory
*/
default GetWorkflowExecutionHistoryPublisher getWorkflowExecutionHistoryPaginator(
Consumer getWorkflowExecutionHistoryRequest) {
return getWorkflowExecutionHistoryPaginator(GetWorkflowExecutionHistoryRequest.builder()
.applyMutation(getWorkflowExecutionHistoryRequest).build());
}
/**
*
* Returns information about all activities registered in the specified domain that match the specified name and
* registration status. The result includes information like creation date, current status of the activity, etc. The
* results may be split into multiple pages. To retrieve subsequent pages, make the call again using the
* nextPageToken returned by the initial call.
*
*
* Access Control
*
*
* You can use IAM policies to control this action's access to Amazon SWF resources as follows:
*
*
* -
*
* Use a Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param listActivityTypesRequest
* @return A Java Future containing the result of the ListActivityTypes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.ListActivityTypes
*/
default CompletableFuture listActivityTypes(ListActivityTypesRequest listActivityTypesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about all activities registered in the specified domain that match the specified name and
* registration status. The result includes information like creation date, current status of the activity, etc. The
* results may be split into multiple pages. To retrieve subsequent pages, make the call again using the
* nextPageToken returned by the initial call.
*
*
* Access Control
*
*
* You can use IAM policies to control this action's access to Amazon SWF resources as follows:
*
*
* -
*
* Use a Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_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 {@link ListActivityTypesRequest.Builder} avoiding the need
* to create one manually via {@link ListActivityTypesRequest#builder()}
*
*
* @param listActivityTypesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.ListActivityTypesRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListActivityTypes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.ListActivityTypes
*/
default CompletableFuture listActivityTypes(
Consumer listActivityTypesRequest) {
return listActivityTypes(ListActivityTypesRequest.builder().applyMutation(listActivityTypesRequest).build());
}
/**
*
* This is a variant of
* {@link #listActivityTypes(software.amazon.awssdk.services.swf.model.ListActivityTypesRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.swf.paginators.ListActivityTypesPublisher publisher = client.listActivityTypesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.swf.paginators.ListActivityTypesPublisher publisher = client.listActivityTypesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.swf.model.ListActivityTypesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listActivityTypes(software.amazon.awssdk.services.swf.model.ListActivityTypesRequest)} operation.
*
*
* @param listActivityTypesRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.ListActivityTypes
*/
default ListActivityTypesPublisher listActivityTypesPaginator(ListActivityTypesRequest listActivityTypesRequest) {
return new ListActivityTypesPublisher(this, listActivityTypesRequest);
}
/**
*
* This is a variant of
* {@link #listActivityTypes(software.amazon.awssdk.services.swf.model.ListActivityTypesRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.swf.paginators.ListActivityTypesPublisher publisher = client.listActivityTypesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.swf.paginators.ListActivityTypesPublisher publisher = client.listActivityTypesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.swf.model.ListActivityTypesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listActivityTypes(software.amazon.awssdk.services.swf.model.ListActivityTypesRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListActivityTypesRequest.Builder} avoiding the need
* to create one manually via {@link ListActivityTypesRequest#builder()}
*
*
* @param listActivityTypesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.ListActivityTypesRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.ListActivityTypes
*/
default ListActivityTypesPublisher listActivityTypesPaginator(
Consumer listActivityTypesRequest) {
return listActivityTypesPaginator(ListActivityTypesRequest.builder().applyMutation(listActivityTypesRequest).build());
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* tagFilter.tag: String constraint. The key is swf:tagFilter.tag.
*
*
* -
*
* typeFilter.name: String constraint. The key is swf:typeFilter.name.
*
*
* -
*
* typeFilter.version: String constraint. The key is swf:typeFilter.version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param listClosedWorkflowExecutionsRequest
* @return A Java Future containing the result of the ListClosedWorkflowExecutions operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.ListClosedWorkflowExecutions
*/
default CompletableFuture listClosedWorkflowExecutions(
ListClosedWorkflowExecutionsRequest listClosedWorkflowExecutionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* tagFilter.tag: String constraint. The key is swf:tagFilter.tag.
*
*
* -
*
* typeFilter.name: String constraint. The key is swf:typeFilter.name.
*
*
* -
*
* typeFilter.version: String constraint. The key is swf:typeFilter.version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_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 {@link ListClosedWorkflowExecutionsRequest.Builder}
* avoiding the need to create one manually via {@link ListClosedWorkflowExecutionsRequest#builder()}
*
*
* @param listClosedWorkflowExecutionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListClosedWorkflowExecutions operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.ListClosedWorkflowExecutions
*/
default CompletableFuture listClosedWorkflowExecutions(
Consumer listClosedWorkflowExecutionsRequest) {
return listClosedWorkflowExecutions(ListClosedWorkflowExecutionsRequest.builder()
.applyMutation(listClosedWorkflowExecutionsRequest).build());
}
/**
*
* This is a variant of
* {@link #listClosedWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.swf.paginators.ListClosedWorkflowExecutionsPublisher publisher = client.listClosedWorkflowExecutionsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.swf.paginators.ListClosedWorkflowExecutionsPublisher publisher = client.listClosedWorkflowExecutionsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listClosedWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsRequest)}
* operation.
*
*
* @param listClosedWorkflowExecutionsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.ListClosedWorkflowExecutions
*/
default ListClosedWorkflowExecutionsPublisher listClosedWorkflowExecutionsPaginator(
ListClosedWorkflowExecutionsRequest listClosedWorkflowExecutionsRequest) {
return new ListClosedWorkflowExecutionsPublisher(this, listClosedWorkflowExecutionsRequest);
}
/**
*
* This is a variant of
* {@link #listClosedWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.swf.paginators.ListClosedWorkflowExecutionsPublisher publisher = client.listClosedWorkflowExecutionsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.swf.paginators.ListClosedWorkflowExecutionsPublisher publisher = client.listClosedWorkflowExecutionsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listClosedWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListClosedWorkflowExecutionsRequest.Builder}
* avoiding the need to create one manually via {@link ListClosedWorkflowExecutionsRequest#builder()}
*
*
* @param listClosedWorkflowExecutionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.ListClosedWorkflowExecutions
*/
default ListClosedWorkflowExecutionsPublisher listClosedWorkflowExecutionsPaginator(
Consumer listClosedWorkflowExecutionsRequest) {
return listClosedWorkflowExecutionsPaginator(ListClosedWorkflowExecutionsRequest.builder()
.applyMutation(listClosedWorkflowExecutionsRequest).build());
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains. The
* element must be set to arn:aws:swf::AccountID:domain/*, where AccountID is the account ID,
* with no dashes.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param listDomainsRequest
* @return A Java Future containing the result of the ListDomains operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.ListDomains
*/
default CompletableFuture listDomains(ListDomainsRequest listDomainsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains. The
* element must be set to arn:aws:swf::AccountID:domain/*, where AccountID is the account ID,
* with no dashes.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_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 {@link ListDomainsRequest.Builder} avoiding the need to
* create one manually via {@link ListDomainsRequest#builder()}
*
*
* @param listDomainsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.ListDomainsRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListDomains operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.ListDomains
*/
default CompletableFuture listDomains(Consumer listDomainsRequest) {
return listDomains(ListDomainsRequest.builder().applyMutation(listDomainsRequest).build());
}
/**
*
* This is a variant of {@link #listDomains(software.amazon.awssdk.services.swf.model.ListDomainsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.swf.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.swf.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.swf.model.ListDomainsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listDomains(software.amazon.awssdk.services.swf.model.ListDomainsRequest)} operation.
*
*
* @param listDomainsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.ListDomains
*/
default ListDomainsPublisher listDomainsPaginator(ListDomainsRequest listDomainsRequest) {
return new ListDomainsPublisher(this, listDomainsRequest);
}
/**
*
* This is a variant of {@link #listDomains(software.amazon.awssdk.services.swf.model.ListDomainsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.swf.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.swf.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.swf.model.ListDomainsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listDomains(software.amazon.awssdk.services.swf.model.ListDomainsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListDomainsRequest.Builder} avoiding the need to
* create one manually via {@link ListDomainsRequest#builder()}
*
*
* @param listDomainsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.ListDomainsRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.ListDomains
*/
default ListDomainsPublisher listDomainsPaginator(Consumer listDomainsRequest) {
return listDomainsPaginator(ListDomainsRequest.builder().applyMutation(listDomainsRequest).build());
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* tagFilter.tag: String constraint. The key is swf:tagFilter.tag.
*
*
* -
*
* typeFilter.name: String constraint. The key is swf:typeFilter.name.
*
*
* -
*
* typeFilter.version: String constraint. The key is swf:typeFilter.version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param listOpenWorkflowExecutionsRequest
* @return A Java Future containing the result of the ListOpenWorkflowExecutions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.ListOpenWorkflowExecutions
*/
default CompletableFuture listOpenWorkflowExecutions(
ListOpenWorkflowExecutionsRequest listOpenWorkflowExecutionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* tagFilter.tag: String constraint. The key is swf:tagFilter.tag.
*
*
* -
*
* typeFilter.name: String constraint. The key is swf:typeFilter.name.
*
*
* -
*
* typeFilter.version: String constraint. The key is swf:typeFilter.version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_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 {@link ListOpenWorkflowExecutionsRequest.Builder} avoiding
* the need to create one manually via {@link ListOpenWorkflowExecutionsRequest#builder()}
*
*
* @param listOpenWorkflowExecutionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListOpenWorkflowExecutions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.ListOpenWorkflowExecutions
*/
default CompletableFuture listOpenWorkflowExecutions(
Consumer listOpenWorkflowExecutionsRequest) {
return listOpenWorkflowExecutions(ListOpenWorkflowExecutionsRequest.builder()
.applyMutation(listOpenWorkflowExecutionsRequest).build());
}
/**
*
* This is a variant of
* {@link #listOpenWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.swf.paginators.ListOpenWorkflowExecutionsPublisher publisher = client.listOpenWorkflowExecutionsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.swf.paginators.ListOpenWorkflowExecutionsPublisher publisher = client.listOpenWorkflowExecutionsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listOpenWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsRequest)}
* operation.
*
*
* @param listOpenWorkflowExecutionsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.ListOpenWorkflowExecutions
*/
default ListOpenWorkflowExecutionsPublisher listOpenWorkflowExecutionsPaginator(
ListOpenWorkflowExecutionsRequest listOpenWorkflowExecutionsRequest) {
return new ListOpenWorkflowExecutionsPublisher(this, listOpenWorkflowExecutionsRequest);
}
/**
*
* This is a variant of
* {@link #listOpenWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.swf.paginators.ListOpenWorkflowExecutionsPublisher publisher = client.listOpenWorkflowExecutionsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.swf.paginators.ListOpenWorkflowExecutionsPublisher publisher = client.listOpenWorkflowExecutionsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listOpenWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListOpenWorkflowExecutionsRequest.Builder} avoiding
* the need to create one manually via {@link ListOpenWorkflowExecutionsRequest#builder()}
*
*
* @param listOpenWorkflowExecutionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.ListOpenWorkflowExecutions
*/
default ListOpenWorkflowExecutionsPublisher listOpenWorkflowExecutionsPaginator(
Consumer listOpenWorkflowExecutionsRequest) {
return listOpenWorkflowExecutionsPaginator(ListOpenWorkflowExecutionsRequest.builder()
.applyMutation(listOpenWorkflowExecutionsRequest).build());
}
/**
*
* List tags for a given domain.
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.ListTagsForResource
*/
default CompletableFuture listTagsForResource(
ListTagsForResourceRequest listTagsForResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* List tags for a given domain.
*
*
*
* This is a convenience which creates an instance of the {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.ListTagsForResourceRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.ListTagsForResource
*/
default CompletableFuture listTagsForResource(
Consumer listTagsForResourceRequest) {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param listWorkflowTypesRequest
* @return A Java Future containing the result of the ListWorkflowTypes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.ListWorkflowTypes
*/
default CompletableFuture listWorkflowTypes(ListWorkflowTypesRequest listWorkflowTypesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_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 {@link ListWorkflowTypesRequest.Builder} avoiding the need
* to create one manually via {@link ListWorkflowTypesRequest#builder()}
*
*
* @param listWorkflowTypesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.ListWorkflowTypesRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListWorkflowTypes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.ListWorkflowTypes
*/
default CompletableFuture listWorkflowTypes(
Consumer listWorkflowTypesRequest) {
return listWorkflowTypes(ListWorkflowTypesRequest.builder().applyMutation(listWorkflowTypesRequest).build());
}
/**
*
* This is a variant of
* {@link #listWorkflowTypes(software.amazon.awssdk.services.swf.model.ListWorkflowTypesRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.swf.paginators.ListWorkflowTypesPublisher publisher = client.listWorkflowTypesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.swf.paginators.ListWorkflowTypesPublisher publisher = client.listWorkflowTypesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.swf.model.ListWorkflowTypesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listWorkflowTypes(software.amazon.awssdk.services.swf.model.ListWorkflowTypesRequest)} operation.
*
*
* @param listWorkflowTypesRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.ListWorkflowTypes
*/
default ListWorkflowTypesPublisher listWorkflowTypesPaginator(ListWorkflowTypesRequest listWorkflowTypesRequest) {
return new ListWorkflowTypesPublisher(this, listWorkflowTypesRequest);
}
/**
*
* This is a variant of
* {@link #listWorkflowTypes(software.amazon.awssdk.services.swf.model.ListWorkflowTypesRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.swf.paginators.ListWorkflowTypesPublisher publisher = client.listWorkflowTypesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.swf.paginators.ListWorkflowTypesPublisher publisher = client.listWorkflowTypesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.swf.model.ListWorkflowTypesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listWorkflowTypes(software.amazon.awssdk.services.swf.model.ListWorkflowTypesRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListWorkflowTypesRequest.Builder} avoiding the need
* to create one manually via {@link ListWorkflowTypesRequest#builder()}
*
*
* @param listWorkflowTypesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.ListWorkflowTypesRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.ListWorkflowTypes
*/
default ListWorkflowTypesPublisher listWorkflowTypesPaginator(
Consumer listWorkflowTypesRequest) {
return listWorkflowTypesPaginator(ListWorkflowTypesRequest.builder().applyMutation(listWorkflowTypesRequest).build());
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the taskList.name parameter by using a Condition element with the
* swf:taskList.name key to allow the action to access only certain task lists.
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param pollForActivityTaskRequest
* @return A Java Future containing the result of the PollForActivityTask operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.PollForActivityTask
*/
default CompletableFuture pollForActivityTask(
PollForActivityTaskRequest pollForActivityTaskRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the taskList.name parameter by using a Condition element with the
* swf:taskList.name key to allow the action to access only certain task lists.
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_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 {@link PollForActivityTaskRequest.Builder} avoiding the
* need to create one manually via {@link PollForActivityTaskRequest#builder()}
*
*
* @param pollForActivityTaskRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.PollForActivityTaskRequest.Builder} to create a request.
* @return A Java Future containing the result of the PollForActivityTask operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.PollForActivityTask
*/
default CompletableFuture pollForActivityTask(
Consumer pollForActivityTaskRequest) {
return pollForActivityTask(PollForActivityTaskRequest.builder().applyMutation(pollForActivityTaskRequest).build());
}
/**
*
* 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
* PollForDecisionTask using the nextPageToken returned by the initial call. Note that you
* do not call GetWorkflowExecutionHistory with this nextPageToken. Instead, call
* PollForDecisionTask again.
*
*
*
* Access Control
*
*
* You can use IAM policies to control this action's access to Amazon SWF resources as follows:
*
*
* -
*
* Use a Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the taskList.name parameter by using a Condition element with the
* swf:taskList.name key to allow the action to access only certain task lists.
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param pollForDecisionTaskRequest
* @return A Java Future containing the result of the PollForDecisionTask operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.PollForDecisionTask
*/
default CompletableFuture pollForDecisionTask(
PollForDecisionTaskRequest pollForDecisionTaskRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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
* PollForDecisionTask using the nextPageToken returned by the initial call. Note that you
* do not call GetWorkflowExecutionHistory with this nextPageToken. Instead, call
* PollForDecisionTask again.
*
*
*
* Access Control
*
*
* You can use IAM policies to control this action's access to Amazon SWF resources as follows:
*
*
* -
*
* Use a Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the taskList.name parameter by using a Condition element with the
* swf:taskList.name key to allow the action to access only certain task lists.
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_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 {@link PollForDecisionTaskRequest.Builder} avoiding the
* need to create one manually via {@link PollForDecisionTaskRequest#builder()}
*
*
* @param pollForDecisionTaskRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.PollForDecisionTaskRequest.Builder} to create a request.
* @return A Java Future containing the result of the PollForDecisionTask operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.PollForDecisionTask
*/
default CompletableFuture pollForDecisionTask(
Consumer pollForDecisionTaskRequest) {
return pollForDecisionTask(PollForDecisionTaskRequest.builder().applyMutation(pollForDecisionTaskRequest).build());
}
/**
*
* This is a variant of
* {@link #pollForDecisionTask(software.amazon.awssdk.services.swf.model.PollForDecisionTaskRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.swf.paginators.PollForDecisionTaskPublisher publisher = client.pollForDecisionTaskPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.swf.paginators.PollForDecisionTaskPublisher publisher = client.pollForDecisionTaskPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.swf.model.PollForDecisionTaskResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #pollForDecisionTask(software.amazon.awssdk.services.swf.model.PollForDecisionTaskRequest)} operation.
*
*
* @param pollForDecisionTaskRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.PollForDecisionTask
*/
default PollForDecisionTaskPublisher pollForDecisionTaskPaginator(PollForDecisionTaskRequest pollForDecisionTaskRequest) {
return new PollForDecisionTaskPublisher(this, pollForDecisionTaskRequest);
}
/**
*
* This is a variant of
* {@link #pollForDecisionTask(software.amazon.awssdk.services.swf.model.PollForDecisionTaskRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.swf.paginators.PollForDecisionTaskPublisher publisher = client.pollForDecisionTaskPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.swf.paginators.PollForDecisionTaskPublisher publisher = client.pollForDecisionTaskPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.swf.model.PollForDecisionTaskResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #pollForDecisionTask(software.amazon.awssdk.services.swf.model.PollForDecisionTaskRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link PollForDecisionTaskRequest.Builder} avoiding the
* need to create one manually via {@link PollForDecisionTaskRequest#builder()}
*
*
* @param pollForDecisionTaskRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.PollForDecisionTaskRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.PollForDecisionTask
*/
default PollForDecisionTaskPublisher pollForDecisionTaskPaginator(
Consumer pollForDecisionTaskRequest) {
return pollForDecisionTaskPaginator(PollForDecisionTaskRequest.builder().applyMutation(pollForDecisionTaskRequest)
.build());
}
/**
*
* Used by activity workers to report to the service that the ActivityTask represented by the specified
* taskToken is still making progress. The worker can also specify details of the progress, for example
* percent complete, using the details parameter. This action can also be used by the worker as a
* mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted
* for the specified task, then the boolean cancelRequested flag returned by the service is set to
* true.
*
*
* This action resets the taskHeartbeatTimeout clock. The taskHeartbeatTimeout is
* specified in RegisterActivityType.
*
*
* This action doesn't in itself create an event in the workflow execution history. However, if the task times out,
* the workflow execution history contains a ActivityTaskTimedOut event that contains the information
* from the last heartbeat generated by the activity worker.
*
*
*
* The taskStartToCloseTimeout of an activity type is the maximum duration of an activity task,
* regardless of the number of RecordActivityTaskHeartbeat requests received. The
* taskStartToCloseTimeout is also specified in RegisterActivityType.
*
*
*
* 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 cancelRequested flag returns true, a cancellation is being attempted. If the
* worker can cancel the activity, it should respond with RespondActivityTaskCanceled. Otherwise, it should
* ignore the cancellation request.
*
*
*
* Access Control
*
*
* You can use IAM policies to control this action's access to Amazon SWF resources as follows:
*
*
* -
*
* Use a Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param recordActivityTaskHeartbeatRequest
* @return A Java Future containing the result of the RecordActivityTaskHeartbeat operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.RecordActivityTaskHeartbeat
*/
default CompletableFuture recordActivityTaskHeartbeat(
RecordActivityTaskHeartbeatRequest recordActivityTaskHeartbeatRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Used by activity workers to report to the service that the ActivityTask represented by the specified
* taskToken is still making progress. The worker can also specify details of the progress, for example
* percent complete, using the details parameter. This action can also be used by the worker as a
* mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted
* for the specified task, then the boolean cancelRequested flag returned by the service is set to
* true.
*
*
* This action resets the taskHeartbeatTimeout clock. The taskHeartbeatTimeout is
* specified in RegisterActivityType.
*
*
* This action doesn't in itself create an event in the workflow execution history. However, if the task times out,
* the workflow execution history contains a ActivityTaskTimedOut event that contains the information
* from the last heartbeat generated by the activity worker.
*
*
*
* The taskStartToCloseTimeout of an activity type is the maximum duration of an activity task,
* regardless of the number of RecordActivityTaskHeartbeat requests received. The
* taskStartToCloseTimeout is also specified in RegisterActivityType.
*
*
*
* 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 cancelRequested flag returns true, a cancellation is being attempted. If the
* worker can cancel the activity, it should respond with RespondActivityTaskCanceled. Otherwise, it should
* ignore the cancellation request.
*
*
*
* Access Control
*
*
* You can use IAM policies to control this action's access to Amazon SWF resources as follows:
*
*
* -
*
* Use a Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_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 {@link RecordActivityTaskHeartbeatRequest.Builder}
* avoiding the need to create one manually via {@link RecordActivityTaskHeartbeatRequest#builder()}
*
*
* @param recordActivityTaskHeartbeatRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.RecordActivityTaskHeartbeatRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the RecordActivityTaskHeartbeat operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.RecordActivityTaskHeartbeat
*/
default CompletableFuture recordActivityTaskHeartbeat(
Consumer recordActivityTaskHeartbeatRequest) {
return recordActivityTaskHeartbeat(RecordActivityTaskHeartbeatRequest.builder()
.applyMutation(recordActivityTaskHeartbeatRequest).build());
}
/**
*
* Registers a new activity type along with its configuration settings in the specified domain.
*
*
*
* A TypeAlreadyExists fault is returned if the type already exists in the domain. You cannot change
* any configuration settings of the type after its registration, and it must be registered as a new version.
*
*
*
* Access Control
*
*
* You can use IAM policies to control this action's access to Amazon SWF resources as follows:
*
*
* -
*
* Use a Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.
*
*
* -
*
* name: String constraint. The key is swf:name.
*
*
* -
*
* version: String constraint. The key is swf:version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param registerActivityTypeRequest
* @return A Java Future containing the result of the RegisterActivityType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.RegisterActivityType
*/
default CompletableFuture registerActivityType(
RegisterActivityTypeRequest registerActivityTypeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Registers a new activity type along with its configuration settings in the specified domain.
*
*
*
* A TypeAlreadyExists fault is returned if the type already exists in the domain. You cannot change
* any configuration settings of the type after its registration, and it must be registered as a new version.
*
*
*
* Access Control
*
*
* You can use IAM policies to control this action's access to Amazon SWF resources as follows:
*
*
* -
*
* Use a Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.
*
*
* -
*
* name: String constraint. The key is swf:name.
*
*
* -
*
* version: String constraint. The key is swf:version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_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 {@link RegisterActivityTypeRequest.Builder} avoiding the
* need to create one manually via {@link RegisterActivityTypeRequest#builder()}
*
*
* @param registerActivityTypeRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.RegisterActivityTypeRequest.Builder} to create a request.
* @return A Java Future containing the result of the RegisterActivityType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.RegisterActivityType
*/
default CompletableFuture registerActivityType(
Consumer registerActivityTypeRequest) {
return registerActivityType(RegisterActivityTypeRequest.builder().applyMutation(registerActivityTypeRequest).build());
}
/**
*
* 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 Action element 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param registerDomainRequest
* @return A Java Future containing the result of the RegisterDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.RegisterDomain
*/
default CompletableFuture registerDomain(RegisterDomainRequest registerDomainRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 Action element 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 cause parameter is set to
* OPERATION_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 {@link RegisterDomainRequest.Builder} avoiding the need to
* create one manually via {@link RegisterDomainRequest#builder()}
*
*
* @param registerDomainRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.RegisterDomainRequest.Builder} to create a request.
* @return A Java Future containing the result of the RegisterDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.RegisterDomain
*/
default CompletableFuture registerDomain(Consumer registerDomainRequest) {
return registerDomain(RegisterDomainRequest.builder().applyMutation(registerDomainRequest).build());
}
/**
*
* 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 TypeAlreadyExists fault is returned. You cannot change the
* configuration settings of a workflow type once it is registered and it must be registered as a new version.
*
*
*
* Access Control
*
*
* You can use IAM policies to control this action's access to Amazon SWF resources as follows:
*
*
* -
*
* Use a Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.
*
*
* -
*
* name: String constraint. The key is swf:name.
*
*
* -
*
* version: String constraint. The key is swf:version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param registerWorkflowTypeRequest
* @return A Java Future containing the result of the RegisterWorkflowType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.RegisterWorkflowType
*/
default CompletableFuture registerWorkflowType(
RegisterWorkflowTypeRequest registerWorkflowTypeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 TypeAlreadyExists fault is returned. You cannot change the
* configuration settings of a workflow type once it is registered and it must be registered as a new version.
*
*
*
* Access Control
*
*
* You can use IAM policies to control this action's access to Amazon SWF resources as follows:
*
*
* -
*
* Use a Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.
*
*
* -
*
* name: String constraint. The key is swf:name.
*
*
* -
*
* version: String constraint. The key is swf:version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_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 {@link RegisterWorkflowTypeRequest.Builder} avoiding the
* need to create one manually via {@link RegisterWorkflowTypeRequest#builder()}
*
*
* @param registerWorkflowTypeRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.RegisterWorkflowTypeRequest.Builder} to create a request.
* @return A Java Future containing the result of the RegisterWorkflowType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.RegisterWorkflowType
*/
default CompletableFuture registerWorkflowType(
Consumer registerWorkflowTypeRequest) {
return registerWorkflowType(RegisterWorkflowTypeRequest.builder().applyMutation(registerWorkflowTypeRequest).build());
}
/**
*
* Records a WorkflowExecutionCancelRequested event in the currently running workflow execution
* identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow
* execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history
* with this event.
*
*
*
* If the runId isn't specified, the WorkflowExecutionCancelRequested event 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param requestCancelWorkflowExecutionRequest
* @return A Java Future containing the result of the RequestCancelWorkflowExecution operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.RequestCancelWorkflowExecution
*/
default CompletableFuture requestCancelWorkflowExecution(
RequestCancelWorkflowExecutionRequest requestCancelWorkflowExecutionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Records a WorkflowExecutionCancelRequested event in the currently running workflow execution
* identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow
* execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history
* with this event.
*
*
*
* If the runId isn't specified, the WorkflowExecutionCancelRequested event 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_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 {@link RequestCancelWorkflowExecutionRequest.Builder}
* avoiding the need to create one manually via {@link RequestCancelWorkflowExecutionRequest#builder()}
*
*
* @param requestCancelWorkflowExecutionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.RequestCancelWorkflowExecutionRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the RequestCancelWorkflowExecution operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.RequestCancelWorkflowExecution
*/
default CompletableFuture requestCancelWorkflowExecution(
Consumer requestCancelWorkflowExecutionRequest) {
return requestCancelWorkflowExecution(RequestCancelWorkflowExecutionRequest.builder()
.applyMutation(requestCancelWorkflowExecutionRequest).build());
}
/**
*
* Used by workers to tell the service that the ActivityTask identified by the taskToken was
* successfully canceled. Additional details can be provided using the details argument.
*
*
* These details (if provided) appear in the ActivityTaskCanceled event added to the
* workflow history.
*
*
*
* Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns
* true and if the activity can be safely undone or abandoned.
*
*
*
* A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as
* open while a worker is processing it. A task is closed after it has been specified in a call to
* RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task
* has timed
* out.
*
*
* Access Control
*
*
* You can use IAM policies to control this action's access to Amazon SWF resources as follows:
*
*
* -
*
* Use a Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param respondActivityTaskCanceledRequest
* @return A Java Future containing the result of the RespondActivityTaskCanceled operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.RespondActivityTaskCanceled
*/
default CompletableFuture respondActivityTaskCanceled(
RespondActivityTaskCanceledRequest respondActivityTaskCanceledRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Used by workers to tell the service that the ActivityTask identified by the taskToken was
* successfully canceled. Additional details can be provided using the details argument.
*
*
* These details (if provided) appear in the ActivityTaskCanceled event added to the
* workflow history.
*
*
*
* Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns
* true and if the activity can be safely undone or abandoned.
*
*
*
* A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as
* open while a worker is processing it. A task is closed after it has been specified in a call to
* RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task
* has timed
* out.
*
*
* Access Control
*
*
* You can use IAM policies to control this action's access to Amazon SWF resources as follows:
*
*
* -
*
* Use a Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_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 {@link RespondActivityTaskCanceledRequest.Builder}
* avoiding the need to create one manually via {@link RespondActivityTaskCanceledRequest#builder()}
*
*
* @param respondActivityTaskCanceledRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.RespondActivityTaskCanceledRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the RespondActivityTaskCanceled operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.RespondActivityTaskCanceled
*/
default CompletableFuture respondActivityTaskCanceled(
Consumer respondActivityTaskCanceledRequest) {
return respondActivityTaskCanceled(RespondActivityTaskCanceledRequest.builder()
.applyMutation(respondActivityTaskCanceledRequest).build());
}
/**
*
* Used by workers to tell the service that the ActivityTask identified by the taskToken
* completed successfully with a result (if provided). The result appears in the
* ActivityTaskCompleted event in the workflow history.
*
*
*
* If the requested task doesn't complete successfully, use RespondActivityTaskFailed instead. If the worker
* finds that the task is canceled through the canceled flag returned by
* RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call
* RespondActivityTaskCanceled.
*
*
*
* A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as
* open while a worker is processing it. A task is closed after it has been specified in a call to
* RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task
* has timed
* out.
*
*
* Access Control
*
*
* You can use IAM policies to control this action's access to Amazon SWF resources as follows:
*
*
* -
*
* Use a Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param respondActivityTaskCompletedRequest
* @return A Java Future containing the result of the RespondActivityTaskCompleted operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.RespondActivityTaskCompleted
*/
default CompletableFuture respondActivityTaskCompleted(
RespondActivityTaskCompletedRequest respondActivityTaskCompletedRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Used by workers to tell the service that the ActivityTask identified by the taskToken
* completed successfully with a result (if provided). The result appears in the
* ActivityTaskCompleted event in the workflow history.
*
*
*
* If the requested task doesn't complete successfully, use RespondActivityTaskFailed instead. If the worker
* finds that the task is canceled through the canceled flag returned by
* RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call
* RespondActivityTaskCanceled.
*
*
*
* A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as
* open while a worker is processing it. A task is closed after it has been specified in a call to
* RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task
* has timed
* out.
*
*
* Access Control
*
*
* You can use IAM policies to control this action's access to Amazon SWF resources as follows:
*
*
* -
*
* Use a Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_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 {@link RespondActivityTaskCompletedRequest.Builder}
* avoiding the need to create one manually via {@link RespondActivityTaskCompletedRequest#builder()}
*
*
* @param respondActivityTaskCompletedRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.RespondActivityTaskCompletedRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the RespondActivityTaskCompleted operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.RespondActivityTaskCompleted
*/
default CompletableFuture respondActivityTaskCompleted(
Consumer respondActivityTaskCompletedRequest) {
return respondActivityTaskCompleted(RespondActivityTaskCompletedRequest.builder()
.applyMutation(respondActivityTaskCompletedRequest).build());
}
/**
*
* Used by workers to tell the service that the ActivityTask identified by the taskToken has
* failed with reason (if specified). The reason and details appear in the
* ActivityTaskFailed event added to the workflow history.
*
*
* A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as
* open while a worker is processing it. A task is closed after it has been specified in a call to
* RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task
* has timed
* out.
*
*
* Access Control
*
*
* You can use IAM policies to control this action's access to Amazon SWF resources as follows:
*
*
* -
*
* Use a Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param respondActivityTaskFailedRequest
* @return A Java Future containing the result of the RespondActivityTaskFailed operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.RespondActivityTaskFailed
*/
default CompletableFuture respondActivityTaskFailed(
RespondActivityTaskFailedRequest respondActivityTaskFailedRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Used by workers to tell the service that the ActivityTask identified by the taskToken has
* failed with reason (if specified). The reason and details appear in the
* ActivityTaskFailed event added to the workflow history.
*
*
* A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as
* open while a worker is processing it. A task is closed after it has been specified in a call to
* RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task
* has timed
* out.
*
*
* Access Control
*
*
* You can use IAM policies to control this action's access to Amazon SWF resources as follows:
*
*
* -
*
* Use a Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_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 {@link RespondActivityTaskFailedRequest.Builder} avoiding
* the need to create one manually via {@link RespondActivityTaskFailedRequest#builder()}
*
*
* @param respondActivityTaskFailedRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.RespondActivityTaskFailedRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the RespondActivityTaskFailed operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.RespondActivityTaskFailed
*/
default CompletableFuture respondActivityTaskFailed(
Consumer respondActivityTaskFailedRequest) {
return respondActivityTaskFailed(RespondActivityTaskFailedRequest.builder()
.applyMutation(respondActivityTaskFailedRequest).build());
}
/**
*
* Used by deciders to tell the service that the DecisionTask identified by the taskToken has
* successfully completed. The decisions argument specifies the list of decisions made while processing
* the task.
*
*
* A DecisionTaskCompleted event is added to the workflow history. The executionContext
* specified is attached to the event in the workflow execution history.
*
*
* Access Control
*
*
* If an IAM policy grants permission to use RespondDecisionTaskCompleted, it can express permissions
* for the list of decisions in the decisions parameter. Each of the decisions has one or more
* parameters, much like a regular API call. To allow for policies to be as readable as possible, you can express
* permissions on decisions as if they were actual API calls, including applying conditions to some parameters. For
* more information, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param respondDecisionTaskCompletedRequest
* Input data for a TaskCompleted response to a decision task.
* @return A Java Future containing the result of the RespondDecisionTaskCompleted operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.RespondDecisionTaskCompleted
*/
default CompletableFuture respondDecisionTaskCompleted(
RespondDecisionTaskCompletedRequest respondDecisionTaskCompletedRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Used by deciders to tell the service that the DecisionTask identified by the taskToken has
* successfully completed. The decisions argument specifies the list of decisions made while processing
* the task.
*
*
* A DecisionTaskCompleted event is added to the workflow history. The executionContext
* specified is attached to the event in the workflow execution history.
*
*
* Access Control
*
*
* If an IAM policy grants permission to use RespondDecisionTaskCompleted, it can express permissions
* for the list of decisions in the decisions parameter. Each of the decisions has one or more
* parameters, much like a regular API call. To allow for policies to be as readable as possible, you can express
* permissions on decisions as if they were actual API calls, including applying conditions to some parameters. For
* more information, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
*
* This is a convenience which creates an instance of the {@link RespondDecisionTaskCompletedRequest.Builder}
* avoiding the need to create one manually via {@link RespondDecisionTaskCompletedRequest#builder()}
*
*
* @param respondDecisionTaskCompletedRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.RespondDecisionTaskCompletedRequest.Builder} to create a
* request. Input data for a TaskCompleted response to a decision task.
* @return A Java Future containing the result of the RespondDecisionTaskCompleted operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.RespondDecisionTaskCompleted
*/
default CompletableFuture respondDecisionTaskCompleted(
Consumer respondDecisionTaskCompletedRequest) {
return respondDecisionTaskCompleted(RespondDecisionTaskCompletedRequest.builder()
.applyMutation(respondDecisionTaskCompletedRequest).build());
}
/**
*
* Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision
* task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with
* the specified user defined signalName and input (if provided).
*
*
*
* If a runId isn't specified, then the WorkflowExecutionSignaled event 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param signalWorkflowExecutionRequest
* @return A Java Future containing the result of the SignalWorkflowExecution operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.SignalWorkflowExecution
*/
default CompletableFuture signalWorkflowExecution(
SignalWorkflowExecutionRequest signalWorkflowExecutionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision
* task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with
* the specified user defined signalName and input (if provided).
*
*
*
* If a runId isn't specified, then the WorkflowExecutionSignaled event 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_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 {@link SignalWorkflowExecutionRequest.Builder} avoiding
* the need to create one manually via {@link SignalWorkflowExecutionRequest#builder()}
*
*
* @param signalWorkflowExecutionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.SignalWorkflowExecutionRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the SignalWorkflowExecution operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.SignalWorkflowExecution
*/
default CompletableFuture signalWorkflowExecution(
Consumer signalWorkflowExecutionRequest) {
return signalWorkflowExecution(SignalWorkflowExecutionRequest.builder().applyMutation(signalWorkflowExecutionRequest)
.build());
}
/**
*
* Starts an execution of the workflow type in the specified domain using the provided workflowId and
* input data.
*
*
* This action returns the newly started workflow execution.
*
*
* Access Control
*
*
* You can use IAM policies to control this action's access to Amazon SWF resources as follows:
*
*
* -
*
* Use a Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* tagList.member.0: The key is swf:tagList.member.0.
*
*
* -
*
* tagList.member.1: The key is swf:tagList.member.1.
*
*
* -
*
* tagList.member.2: The key is swf:tagList.member.2.
*
*
* -
*
* tagList.member.3: The key is swf:tagList.member.3.
*
*
* -
*
* tagList.member.4: The key is swf:tagList.member.4.
*
*
* -
*
* taskList: String constraint. The key is swf:taskList.name.
*
*
* -
*
* workflowType.name: String constraint. The key is swf:workflowType.name.
*
*
* -
*
* workflowType.version: String constraint. The key is swf:workflowType.version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param startWorkflowExecutionRequest
* @return A Java Future containing the result of the StartWorkflowExecution operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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 The
StartWorkflowExecution API 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 the StartWorkflowExecution call
* 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.
*
* @sample SwfAsyncClient.StartWorkflowExecution
*/
default CompletableFuture startWorkflowExecution(
StartWorkflowExecutionRequest startWorkflowExecutionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Starts an execution of the workflow type in the specified domain using the provided workflowId and
* input data.
*
*
* This action returns the newly started workflow execution.
*
*
* Access Control
*
*
* You can use IAM policies to control this action's access to Amazon SWF resources as follows:
*
*
* -
*
* Use a Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* tagList.member.0: The key is swf:tagList.member.0.
*
*
* -
*
* tagList.member.1: The key is swf:tagList.member.1.
*
*
* -
*
* tagList.member.2: The key is swf:tagList.member.2.
*
*
* -
*
* tagList.member.3: The key is swf:tagList.member.3.
*
*
* -
*
* tagList.member.4: The key is swf:tagList.member.4.
*
*
* -
*
* taskList: String constraint. The key is swf:taskList.name.
*
*
* -
*
* workflowType.name: String constraint. The key is swf:workflowType.name.
*
*
* -
*
* workflowType.version: String constraint. The key is swf:workflowType.version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_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 {@link StartWorkflowExecutionRequest.Builder} avoiding the
* need to create one manually via {@link StartWorkflowExecutionRequest#builder()}
*
*
* @param startWorkflowExecutionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.StartWorkflowExecutionRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the StartWorkflowExecution operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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 The
StartWorkflowExecution API 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 the StartWorkflowExecution call
* 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.
*
* @sample SwfAsyncClient.StartWorkflowExecution
*/
default CompletableFuture startWorkflowExecution(
Consumer startWorkflowExecutionRequest) {
return startWorkflowExecution(StartWorkflowExecutionRequest.builder().applyMutation(startWorkflowExecutionRequest)
.build());
}
/**
*
* Add a tag to a Amazon SWF domain.
*
*
*
* Amazon SWF supports a maximum of 50 tags per resource.
*
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.TagResource
*/
default CompletableFuture tagResource(TagResourceRequest tagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link TagResourceRequest.Builder} avoiding the need to
* create one manually via {@link TagResourceRequest#builder()}
*
*
* @param tagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.TagResourceRequest.Builder} to create a request.
* @return A Java Future containing the result of the TagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.TagResource
*/
default CompletableFuture tagResource(Consumer tagResourceRequest) {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified
* by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when
* starting this execution, is applied to any open child workflow executions of this workflow execution.
*
*
*
* If the identified workflow execution was in progress, it is terminated immediately.
*
*
*
* If a runId isn't specified, then the WorkflowExecutionTerminated event 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param terminateWorkflowExecutionRequest
* @return A Java Future containing the result of the TerminateWorkflowExecution operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.TerminateWorkflowExecution
*/
default CompletableFuture terminateWorkflowExecution(
TerminateWorkflowExecutionRequest terminateWorkflowExecutionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified
* by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when
* starting this execution, is applied to any open child workflow executions of this workflow execution.
*
*
*
* If the identified workflow execution was in progress, it is terminated immediately.
*
*
*
* If a runId isn't specified, then the WorkflowExecutionTerminated event 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_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 {@link TerminateWorkflowExecutionRequest.Builder} avoiding
* the need to create one manually via {@link TerminateWorkflowExecutionRequest#builder()}
*
*
* @param terminateWorkflowExecutionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.TerminateWorkflowExecutionRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the TerminateWorkflowExecution operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.TerminateWorkflowExecution
*/
default CompletableFuture terminateWorkflowExecution(
Consumer terminateWorkflowExecutionRequest) {
return terminateWorkflowExecution(TerminateWorkflowExecutionRequest.builder()
.applyMutation(terminateWorkflowExecutionRequest).build());
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* activityType.name: String constraint. The key is swf:activityType.name.
*
*
* -
*
* activityType.version: String constraint. The key is swf:activityType.version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param undeprecateActivityTypeRequest
* @return A Java Future containing the result of the UndeprecateActivityType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.UndeprecateActivityType
*/
default CompletableFuture undeprecateActivityType(
UndeprecateActivityTypeRequest undeprecateActivityTypeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* activityType.name: String constraint. The key is swf:activityType.name.
*
*
* -
*
* activityType.version: String constraint. The key is swf:activityType.version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_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 {@link UndeprecateActivityTypeRequest.Builder} avoiding
* the need to create one manually via {@link UndeprecateActivityTypeRequest#builder()}
*
*
* @param undeprecateActivityTypeRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.UndeprecateActivityTypeRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the UndeprecateActivityType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.UndeprecateActivityType
*/
default CompletableFuture undeprecateActivityType(
Consumer undeprecateActivityTypeRequest) {
return undeprecateActivityType(UndeprecateActivityTypeRequest.builder().applyMutation(undeprecateActivityTypeRequest)
.build());
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param undeprecateDomainRequest
* @return A Java Future containing the result of the UndeprecateDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.UndeprecateDomain
*/
default CompletableFuture undeprecateDomain(UndeprecateDomainRequest undeprecateDomainRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element 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 cause parameter is set to
* OPERATION_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 {@link UndeprecateDomainRequest.Builder} avoiding the need
* to create one manually via {@link UndeprecateDomainRequest#builder()}
*
*
* @param undeprecateDomainRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.UndeprecateDomainRequest.Builder} to create a request.
* @return A Java Future containing the result of the UndeprecateDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.UndeprecateDomain
*/
default CompletableFuture undeprecateDomain(
Consumer undeprecateDomainRequest) {
return undeprecateDomain(UndeprecateDomainRequest.builder().applyMutation(undeprecateDomainRequest).build());
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* workflowType.name: String constraint. The key is swf:workflowType.name.
*
*
* -
*
* workflowType.version: String constraint. The key is swf:workflowType.version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @param undeprecateWorkflowTypeRequest
* @return A Java Future containing the result of the UndeprecateWorkflowType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.UndeprecateWorkflowType
*/
default CompletableFuture undeprecateWorkflowType(
UndeprecateWorkflowTypeRequest undeprecateWorkflowTypeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 Resource element with the domain name to limit the action to only specified domains.
*
*
* -
*
* Use an Action element to allow or deny permission to call this action.
*
*
* -
*
* Constrain the following parameters by using a Condition element with the appropriate keys.
*
*
* -
*
* workflowType.name: String constraint. The key is swf:workflowType.name.
*
*
* -
*
* workflowType.version: String constraint. The key is swf:workflowType.version.
*
*
*
*
*
*
* If the caller 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 cause parameter is set to
* OPERATION_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 {@link UndeprecateWorkflowTypeRequest.Builder} avoiding
* the need to create one manually via {@link UndeprecateWorkflowTypeRequest#builder()}
*
*
* @param undeprecateWorkflowTypeRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.UndeprecateWorkflowTypeRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the UndeprecateWorkflowType operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.UndeprecateWorkflowType
*/
default CompletableFuture undeprecateWorkflowType(
Consumer undeprecateWorkflowTypeRequest) {
return undeprecateWorkflowType(UndeprecateWorkflowTypeRequest.builder().applyMutation(undeprecateWorkflowTypeRequest)
.build());
}
/**
*
* Remove a tag from a Amazon SWF domain.
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.UntagResource
*/
default CompletableFuture untagResource(UntagResourceRequest untagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Remove a tag from a Amazon SWF domain.
*
*
*
* This is a convenience which creates an instance of the {@link UntagResourceRequest.Builder} avoiding the need to
* create one manually via {@link UntagResourceRequest#builder()}
*
*
* @param untagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.swf.model.UntagResourceRequest.Builder} to create a request.
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample SwfAsyncClient.UntagResource
*/
default CompletableFuture untagResource(Consumer untagResourceRequest) {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
@Override
default SwfServiceClientConfiguration serviceClientConfiguration() {
throw new UnsupportedOperationException();
}
/**
* Create a {@link SwfAsyncClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static SwfAsyncClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link SwfAsyncClient}.
*/
static SwfAsyncClientBuilder builder() {
return new DefaultSwfAsyncClientBuilder();
}
}