Interface SwfAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface SwfAsyncClient extends AwsClient
Service client for accessing Amazon SWF asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any 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 .

  • Field Details

  • Method Details

    • countClosedWorkflowExecutions

      default CompletableFuture<CountClosedWorkflowExecutionsResponse> countClosedWorkflowExecutions(CountClosedWorkflowExecutionsRequest countClosedWorkflowExecutionsRequest)

      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.

      Parameters:
      countClosedWorkflowExecutionsRequest -
      Returns:
      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 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.

    • countClosedWorkflowExecutions

      default CompletableFuture<CountClosedWorkflowExecutionsResponse> countClosedWorkflowExecutions(Consumer<CountClosedWorkflowExecutionsRequest.Builder> countClosedWorkflowExecutionsRequest)

      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 CountClosedWorkflowExecutionsRequest.Builder avoiding the need to create one manually via CountClosedWorkflowExecutionsRequest.builder()

      Parameters:
      countClosedWorkflowExecutionsRequest - A Consumer that will call methods on CountClosedWorkflowExecutionsRequest.Builder to create a request.
      Returns:
      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 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.

    • countOpenWorkflowExecutions

      default CompletableFuture<CountOpenWorkflowExecutionsResponse> countOpenWorkflowExecutions(CountOpenWorkflowExecutionsRequest countOpenWorkflowExecutionsRequest)

      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.

      Parameters:
      countOpenWorkflowExecutionsRequest -
      Returns:
      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 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.

    • countOpenWorkflowExecutions

      default CompletableFuture<CountOpenWorkflowExecutionsResponse> countOpenWorkflowExecutions(Consumer<CountOpenWorkflowExecutionsRequest.Builder> countOpenWorkflowExecutionsRequest)

      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 CountOpenWorkflowExecutionsRequest.Builder avoiding the need to create one manually via CountOpenWorkflowExecutionsRequest.builder()

      Parameters:
      countOpenWorkflowExecutionsRequest - A Consumer that will call methods on CountOpenWorkflowExecutionsRequest.Builder to create a request.
      Returns:
      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 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.

    • countPendingActivityTasks

      default CompletableFuture<CountPendingActivityTasksResponse> countPendingActivityTasks(CountPendingActivityTasksRequest countPendingActivityTasksRequest)

      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.

      Parameters:
      countPendingActivityTasksRequest -
      Returns:
      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 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.

    • countPendingActivityTasks

      default CompletableFuture<CountPendingActivityTasksResponse> countPendingActivityTasks(Consumer<CountPendingActivityTasksRequest.Builder> countPendingActivityTasksRequest)

      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 CountPendingActivityTasksRequest.Builder avoiding the need to create one manually via CountPendingActivityTasksRequest.builder()

      Parameters:
      countPendingActivityTasksRequest - A Consumer that will call methods on CountPendingActivityTasksRequest.Builder to create a request.
      Returns:
      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 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.

    • countPendingDecisionTasks

      default CompletableFuture<CountPendingDecisionTasksResponse> countPendingDecisionTasks(CountPendingDecisionTasksRequest countPendingDecisionTasksRequest)

      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.

      Parameters:
      countPendingDecisionTasksRequest -
      Returns:
      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 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.

    • countPendingDecisionTasks

      default CompletableFuture<CountPendingDecisionTasksResponse> countPendingDecisionTasks(Consumer<CountPendingDecisionTasksRequest.Builder> countPendingDecisionTasksRequest)

      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 CountPendingDecisionTasksRequest.Builder avoiding the need to create one manually via CountPendingDecisionTasksRequest.builder()

      Parameters:
      countPendingDecisionTasksRequest - A Consumer that will call methods on CountPendingDecisionTasksRequest.Builder to create a request.
      Returns:
      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 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.

    • deleteActivityType

      default CompletableFuture<DeleteActivityTypeResponse> deleteActivityType(DeleteActivityTypeRequest deleteActivityTypeRequest)

      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.

      Parameters:
      deleteActivityTypeRequest -
      Returns:
      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 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.

    • deleteActivityType

      default CompletableFuture<DeleteActivityTypeResponse> deleteActivityType(Consumer<DeleteActivityTypeRequest.Builder> deleteActivityTypeRequest)

      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 DeleteActivityTypeRequest.Builder avoiding the need to create one manually via DeleteActivityTypeRequest.builder()

      Parameters:
      deleteActivityTypeRequest - A Consumer that will call methods on DeleteActivityTypeRequest.Builder to create a request.
      Returns:
      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 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.

    • deleteWorkflowType

      default CompletableFuture<DeleteWorkflowTypeResponse> deleteWorkflowType(DeleteWorkflowTypeRequest deleteWorkflowTypeRequest)

      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.

      Parameters:
      deleteWorkflowTypeRequest -
      Returns:
      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 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.

    • deleteWorkflowType

      default CompletableFuture<DeleteWorkflowTypeResponse> deleteWorkflowType(Consumer<DeleteWorkflowTypeRequest.Builder> deleteWorkflowTypeRequest)

      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 DeleteWorkflowTypeRequest.Builder avoiding the need to create one manually via DeleteWorkflowTypeRequest.builder()

      Parameters:
      deleteWorkflowTypeRequest - A Consumer that will call methods on DeleteWorkflowTypeRequest.Builder to create a request.
      Returns:
      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 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.

    • deprecateActivityType

      default CompletableFuture<DeprecateActivityTypeResponse> deprecateActivityType(DeprecateActivityTypeRequest deprecateActivityTypeRequest)

      Deprecates the specified activity type. After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type that were scheduled before the type was deprecated 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.

      Parameters:
      deprecateActivityTypeRequest -
      Returns:
      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 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.

    • deprecateActivityType

      default CompletableFuture<DeprecateActivityTypeResponse> deprecateActivityType(Consumer<DeprecateActivityTypeRequest.Builder> deprecateActivityTypeRequest)

      Deprecates the specified activity type. After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type that were scheduled before the type was deprecated 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 DeprecateActivityTypeRequest.Builder avoiding the need to create one manually via DeprecateActivityTypeRequest.builder()

      Parameters:
      deprecateActivityTypeRequest - A Consumer that will call methods on DeprecateActivityTypeRequest.Builder to create a request.
      Returns:
      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 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.

    • deprecateDomain

      default CompletableFuture<DeprecateDomainResponse> deprecateDomain(DeprecateDomainRequest deprecateDomainRequest)

      Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain. Executions that were started before the domain was deprecated 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.

      Parameters:
      deprecateDomainRequest -
      Returns:
      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 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.

    • deprecateDomain

      default CompletableFuture<DeprecateDomainResponse> deprecateDomain(Consumer<DeprecateDomainRequest.Builder> deprecateDomainRequest)

      Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain. Executions that were started before the domain was deprecated 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 DeprecateDomainRequest.Builder avoiding the need to create one manually via DeprecateDomainRequest.builder()

      Parameters:
      deprecateDomainRequest - A Consumer that will call methods on DeprecateDomainRequest.Builder to create a request.
      Returns:
      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 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.

    • deprecateWorkflowType

      default CompletableFuture<DeprecateWorkflowTypeResponse> deprecateWorkflowType(DeprecateWorkflowTypeRequest deprecateWorkflowTypeRequest)

      Deprecates the specified workflow type. After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated 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.

      Parameters:
      deprecateWorkflowTypeRequest -
      Returns:
      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 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.

    • deprecateWorkflowType

      default CompletableFuture<DeprecateWorkflowTypeResponse> deprecateWorkflowType(Consumer<DeprecateWorkflowTypeRequest.Builder> deprecateWorkflowTypeRequest)

      Deprecates the specified workflow type. After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated 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 DeprecateWorkflowTypeRequest.Builder avoiding the need to create one manually via DeprecateWorkflowTypeRequest.builder()

      Parameters:
      deprecateWorkflowTypeRequest - A Consumer that will call methods on DeprecateWorkflowTypeRequest.Builder to create a request.
      Returns:
      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 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.

    • describeActivityType

      default CompletableFuture<DescribeActivityTypeResponse> describeActivityType(DescribeActivityTypeRequest describeActivityTypeRequest)

      Returns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type.

      Access Control

      You can use IAM policies to control this action's access to Amazon SWF resources as follows:

      • 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.

      Parameters:
      describeActivityTypeRequest -
      Returns:
      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 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.

    • describeActivityType

      default CompletableFuture<DescribeActivityTypeResponse> describeActivityType(Consumer<DescribeActivityTypeRequest.Builder> describeActivityTypeRequest)

      Returns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type.

      Access Control

      You can use IAM policies to control this action's access to Amazon SWF resources as follows:

      • 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 DescribeActivityTypeRequest.Builder avoiding the need to create one manually via DescribeActivityTypeRequest.builder()

      Parameters:
      describeActivityTypeRequest - A Consumer that will call methods on DescribeActivityTypeRequest.Builder to create a request.
      Returns:
      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 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.

    • describeDomain

      default CompletableFuture<DescribeDomainResponse> describeDomain(DescribeDomainRequest describeDomainRequest)

      Returns information about the specified domain, including description and status.

      Access Control

      You can use IAM policies to control this action's access to Amazon SWF resources as follows:

      • 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.

      Parameters:
      describeDomainRequest -
      Returns:
      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 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.

    • describeDomain

      default CompletableFuture<DescribeDomainResponse> describeDomain(Consumer<DescribeDomainRequest.Builder> describeDomainRequest)

      Returns information about the specified domain, including description and status.

      Access Control

      You can use IAM policies to control this action's access to Amazon SWF resources as follows:

      • 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 DescribeDomainRequest.Builder avoiding the need to create one manually via DescribeDomainRequest.builder()

      Parameters:
      describeDomainRequest - A Consumer that will call methods on DescribeDomainRequest.Builder to create a request.
      Returns:
      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 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.

    • describeWorkflowExecution

      default CompletableFuture<DescribeWorkflowExecutionResponse> describeWorkflowExecution(DescribeWorkflowExecutionRequest describeWorkflowExecutionRequest)

      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.

      Parameters:
      describeWorkflowExecutionRequest -
      Returns:
      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 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.

    • describeWorkflowExecution

      default CompletableFuture<DescribeWorkflowExecutionResponse> describeWorkflowExecution(Consumer<DescribeWorkflowExecutionRequest.Builder> describeWorkflowExecutionRequest)

      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 DescribeWorkflowExecutionRequest.Builder avoiding the need to create one manually via DescribeWorkflowExecutionRequest.builder()

      Parameters:
      describeWorkflowExecutionRequest - A Consumer that will call methods on DescribeWorkflowExecutionRequest.Builder to create a request.
      Returns:
      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 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.

    • describeWorkflowType

      default CompletableFuture<DescribeWorkflowTypeResponse> describeWorkflowType(DescribeWorkflowTypeRequest describeWorkflowTypeRequest)

      Returns information about the specified workflow type. This includes configuration settings specified when the type was registered and other information such as creation date, current status, etc.

      Access Control

      You can use IAM policies to control this action's access to Amazon SWF resources as follows:

      • 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.

      Parameters:
      describeWorkflowTypeRequest -
      Returns:
      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 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.

    • describeWorkflowType

      default CompletableFuture<DescribeWorkflowTypeResponse> describeWorkflowType(Consumer<DescribeWorkflowTypeRequest.Builder> describeWorkflowTypeRequest)

      Returns information about the specified workflow type. This includes configuration settings specified when the type was registered and other information such as creation date, current status, etc.

      Access Control

      You can use IAM policies to control this action's access to Amazon SWF resources as follows:

      • 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 DescribeWorkflowTypeRequest.Builder avoiding the need to create one manually via DescribeWorkflowTypeRequest.builder()

      Parameters:
      describeWorkflowTypeRequest - A Consumer that will call methods on DescribeWorkflowTypeRequest.Builder to create a request.
      Returns:
      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 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.

    • getWorkflowExecutionHistory

      default CompletableFuture<GetWorkflowExecutionHistoryResponse> getWorkflowExecutionHistory(GetWorkflowExecutionHistoryRequest getWorkflowExecutionHistoryRequest)

      Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

      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.

      Parameters:
      getWorkflowExecutionHistoryRequest -
      Returns:
      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 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.

    • getWorkflowExecutionHistory

      default CompletableFuture<GetWorkflowExecutionHistoryResponse> getWorkflowExecutionHistory(Consumer<GetWorkflowExecutionHistoryRequest.Builder> getWorkflowExecutionHistoryRequest)

      Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

      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 GetWorkflowExecutionHistoryRequest.Builder avoiding the need to create one manually via GetWorkflowExecutionHistoryRequest.builder()

      Parameters:
      getWorkflowExecutionHistoryRequest - A Consumer that will call methods on GetWorkflowExecutionHistoryRequest.Builder to create a request.
      Returns:
      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 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.

    • getWorkflowExecutionHistoryPaginator

      default GetWorkflowExecutionHistoryPublisher getWorkflowExecutionHistoryPaginator(GetWorkflowExecutionHistoryRequest getWorkflowExecutionHistoryRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new 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 
       
 software.amazon.awssdk.services.swf.paginators.GetWorkflowExecutionHistoryPublisher publisher = client.getWorkflowExecutionHistoryPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.swf.paginators.GetWorkflowExecutionHistoryPublisher publisher = client.getWorkflowExecutionHistoryPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryResponse>() {
 
 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 getWorkflowExecutionHistory(software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryRequest) operation.

      Parameters:
      getWorkflowExecutionHistoryRequest -
      Returns:
      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 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.

    • getWorkflowExecutionHistoryPaginator

      default GetWorkflowExecutionHistoryPublisher getWorkflowExecutionHistoryPaginator(Consumer<GetWorkflowExecutionHistoryRequest.Builder> getWorkflowExecutionHistoryRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new 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 
       
 software.amazon.awssdk.services.swf.paginators.GetWorkflowExecutionHistoryPublisher publisher = client.getWorkflowExecutionHistoryPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.swf.paginators.GetWorkflowExecutionHistoryPublisher publisher = client.getWorkflowExecutionHistoryPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryResponse>() {
 
 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 getWorkflowExecutionHistory(software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryRequest) operation.


      This is a convenience which creates an instance of the GetWorkflowExecutionHistoryRequest.Builder avoiding the need to create one manually via GetWorkflowExecutionHistoryRequest.builder()

      Parameters:
      getWorkflowExecutionHistoryRequest - A Consumer that will call methods on GetWorkflowExecutionHistoryRequest.Builder to create a request.
      Returns:
      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 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.

    • listActivityTypes

      default CompletableFuture<ListActivityTypesResponse> listActivityTypes(ListActivityTypesRequest listActivityTypesRequest)

      Returns information about all activities registered in the specified domain that match the specified name and registration status. The result includes information like creation date, current status of the activity, etc. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

      Access Control

      You can use IAM policies to control this action's access to Amazon SWF resources as follows:

      • 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.

      Parameters:
      listActivityTypesRequest -
      Returns:
      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 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.

    • listActivityTypes

      default CompletableFuture<ListActivityTypesResponse> listActivityTypes(Consumer<ListActivityTypesRequest.Builder> listActivityTypesRequest)

      Returns information about all activities registered in the specified domain that match the specified name and registration status. The result includes information like creation date, current status of the activity, etc. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

      Access Control

      You can use IAM policies to control this action's access to Amazon SWF resources as follows:

      • 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 ListActivityTypesRequest.Builder avoiding the need to create one manually via ListActivityTypesRequest.builder()

      Parameters:
      listActivityTypesRequest - A Consumer that will call methods on ListActivityTypesRequest.Builder to create a request.
      Returns:
      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 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.

    • listActivityTypesPaginator

      default ListActivityTypesPublisher listActivityTypesPaginator(ListActivityTypesRequest listActivityTypesRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new 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 
       
 software.amazon.awssdk.services.swf.paginators.ListActivityTypesPublisher publisher = client.listActivityTypesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.swf.paginators.ListActivityTypesPublisher publisher = client.listActivityTypesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.swf.model.ListActivityTypesResponse>() {
 
 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 listActivityTypes(software.amazon.awssdk.services.swf.model.ListActivityTypesRequest) operation.

      Parameters:
      listActivityTypesRequest -
      Returns:
      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 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.

    • listActivityTypesPaginator

      default ListActivityTypesPublisher listActivityTypesPaginator(Consumer<ListActivityTypesRequest.Builder> listActivityTypesRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new 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 
       
 software.amazon.awssdk.services.swf.paginators.ListActivityTypesPublisher publisher = client.listActivityTypesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.swf.paginators.ListActivityTypesPublisher publisher = client.listActivityTypesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.swf.model.ListActivityTypesResponse>() {
 
 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 listActivityTypes(software.amazon.awssdk.services.swf.model.ListActivityTypesRequest) operation.


      This is a convenience which creates an instance of the ListActivityTypesRequest.Builder avoiding the need to create one manually via ListActivityTypesRequest.builder()

      Parameters:
      listActivityTypesRequest - A Consumer that will call methods on ListActivityTypesRequest.Builder to create a request.
      Returns:
      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 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.

    • listClosedWorkflowExecutions

      default CompletableFuture<ListClosedWorkflowExecutionsResponse> listClosedWorkflowExecutions(ListClosedWorkflowExecutionsRequest listClosedWorkflowExecutionsRequest)

      Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

      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.

      Parameters:
      listClosedWorkflowExecutionsRequest -
      Returns:
      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 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.

    • listClosedWorkflowExecutions

      default CompletableFuture<ListClosedWorkflowExecutionsResponse> listClosedWorkflowExecutions(Consumer<ListClosedWorkflowExecutionsRequest.Builder> listClosedWorkflowExecutionsRequest)

      Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

      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 ListClosedWorkflowExecutionsRequest.Builder avoiding the need to create one manually via ListClosedWorkflowExecutionsRequest.builder()

      Parameters:
      listClosedWorkflowExecutionsRequest - A Consumer that will call methods on ListClosedWorkflowExecutionsRequest.Builder to create a request.
      Returns:
      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 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.

    • listClosedWorkflowExecutionsPaginator

      default ListClosedWorkflowExecutionsPublisher listClosedWorkflowExecutionsPaginator(ListClosedWorkflowExecutionsRequest listClosedWorkflowExecutionsRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new 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 
       
 software.amazon.awssdk.services.swf.paginators.ListClosedWorkflowExecutionsPublisher publisher = client.listClosedWorkflowExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.swf.paginators.ListClosedWorkflowExecutionsPublisher publisher = client.listClosedWorkflowExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsResponse>() {
 
 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 listClosedWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsRequest) operation.

      Parameters:
      listClosedWorkflowExecutionsRequest -
      Returns:
      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 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.

    • listClosedWorkflowExecutionsPaginator

      default ListClosedWorkflowExecutionsPublisher listClosedWorkflowExecutionsPaginator(Consumer<ListClosedWorkflowExecutionsRequest.Builder> listClosedWorkflowExecutionsRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new 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 
       
 software.amazon.awssdk.services.swf.paginators.ListClosedWorkflowExecutionsPublisher publisher = client.listClosedWorkflowExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.swf.paginators.ListClosedWorkflowExecutionsPublisher publisher = client.listClosedWorkflowExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsResponse>() {
 
 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 listClosedWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsRequest) operation.


      This is a convenience which creates an instance of the ListClosedWorkflowExecutionsRequest.Builder avoiding the need to create one manually via ListClosedWorkflowExecutionsRequest.builder()

      Parameters:
      listClosedWorkflowExecutionsRequest - A Consumer that will call methods on ListClosedWorkflowExecutionsRequest.Builder to create a request.
      Returns:
      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 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.

    • listDomains

      default CompletableFuture<ListDomainsResponse> listDomains(ListDomainsRequest listDomainsRequest)

      Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

      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.

      Parameters:
      listDomainsRequest -
      Returns:
      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 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.

    • listDomains

      default CompletableFuture<ListDomainsResponse> listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest)

      Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

      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 ListDomainsRequest.Builder avoiding the need to create one manually via ListDomainsRequest.builder()

      Parameters:
      listDomainsRequest - A Consumer that will call methods on ListDomainsRequest.Builder to create a request.
      Returns:
      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 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.

    • listDomainsPaginator

      default ListDomainsPublisher listDomainsPaginator(ListDomainsRequest listDomainsRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new 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 
       
 software.amazon.awssdk.services.swf.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.swf.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.swf.model.ListDomainsResponse>() {
 
 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 listDomains(software.amazon.awssdk.services.swf.model.ListDomainsRequest) operation.

      Parameters:
      listDomainsRequest -
      Returns:
      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 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.

    • listDomainsPaginator

      default ListDomainsPublisher listDomainsPaginator(Consumer<ListDomainsRequest.Builder> listDomainsRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new 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 
       
 software.amazon.awssdk.services.swf.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.swf.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.swf.model.ListDomainsResponse>() {
 
 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 listDomains(software.amazon.awssdk.services.swf.model.ListDomainsRequest) operation.


      This is a convenience which creates an instance of the ListDomainsRequest.Builder avoiding the need to create one manually via ListDomainsRequest.builder()

      Parameters:
      listDomainsRequest - A Consumer that will call methods on ListDomainsRequest.Builder to create a request.
      Returns:
      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 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.

    • listOpenWorkflowExecutions

      default CompletableFuture<ListOpenWorkflowExecutionsResponse> listOpenWorkflowExecutions(ListOpenWorkflowExecutionsRequest listOpenWorkflowExecutionsRequest)

      Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

      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.

      Parameters:
      listOpenWorkflowExecutionsRequest -
      Returns:
      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 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.

    • listOpenWorkflowExecutions

      default CompletableFuture<ListOpenWorkflowExecutionsResponse> listOpenWorkflowExecutions(Consumer<ListOpenWorkflowExecutionsRequest.Builder> listOpenWorkflowExecutionsRequest)

      Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

      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 ListOpenWorkflowExecutionsRequest.Builder avoiding the need to create one manually via ListOpenWorkflowExecutionsRequest.builder()

      Parameters:
      listOpenWorkflowExecutionsRequest - A Consumer that will call methods on ListOpenWorkflowExecutionsRequest.Builder to create a request.
      Returns:
      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 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.

    • listOpenWorkflowExecutionsPaginator

      default ListOpenWorkflowExecutionsPublisher listOpenWorkflowExecutionsPaginator(ListOpenWorkflowExecutionsRequest listOpenWorkflowExecutionsRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new 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 
       
 software.amazon.awssdk.services.swf.paginators.ListOpenWorkflowExecutionsPublisher publisher = client.listOpenWorkflowExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.swf.paginators.ListOpenWorkflowExecutionsPublisher publisher = client.listOpenWorkflowExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsResponse>() {
 
 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 listOpenWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsRequest) operation.

      Parameters:
      listOpenWorkflowExecutionsRequest -
      Returns:
      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 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.

    • listOpenWorkflowExecutionsPaginator

      default ListOpenWorkflowExecutionsPublisher listOpenWorkflowExecutionsPaginator(Consumer<ListOpenWorkflowExecutionsRequest.Builder> listOpenWorkflowExecutionsRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new 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 
       
 software.amazon.awssdk.services.swf.paginators.ListOpenWorkflowExecutionsPublisher publisher = client.listOpenWorkflowExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.swf.paginators.ListOpenWorkflowExecutionsPublisher publisher = client.listOpenWorkflowExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsResponse>() {
 
 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 listOpenWorkflowExecutions(software.amazon.awssdk.services.swf.model.ListOpenWorkflowExecutionsRequest) operation.


      This is a convenience which creates an instance of the ListOpenWorkflowExecutionsRequest.Builder avoiding the need to create one manually via ListOpenWorkflowExecutionsRequest.builder()

      Parameters:
      listOpenWorkflowExecutionsRequest - A Consumer that will call methods on ListOpenWorkflowExecutionsRequest.Builder to create a request.
      Returns:
      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 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.

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      List tags for a given domain.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      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 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.

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      List tags for a given domain.


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      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 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.

    • listWorkflowTypes

      default CompletableFuture<ListWorkflowTypesResponse> listWorkflowTypes(ListWorkflowTypesRequest listWorkflowTypesRequest)

      Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly.

      Access Control

      You can use IAM policies to control this action's access to Amazon SWF resources as follows:

      • 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.

      Parameters:
      listWorkflowTypesRequest -
      Returns:
      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 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.

    • listWorkflowTypes

      default CompletableFuture<ListWorkflowTypesResponse> listWorkflowTypes(Consumer<ListWorkflowTypesRequest.Builder> listWorkflowTypesRequest)

      Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly.

      Access Control

      You can use IAM policies to control this action's access to Amazon SWF resources as follows:

      • 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 ListWorkflowTypesRequest.Builder avoiding the need to create one manually via ListWorkflowTypesRequest.builder()

      Parameters:
      listWorkflowTypesRequest - A Consumer that will call methods on ListWorkflowTypesRequest.Builder to create a request.
      Returns:
      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 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.

    • listWorkflowTypesPaginator

      default ListWorkflowTypesPublisher listWorkflowTypesPaginator(ListWorkflowTypesRequest listWorkflowTypesRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new 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 
       
 software.amazon.awssdk.services.swf.paginators.ListWorkflowTypesPublisher publisher = client.listWorkflowTypesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.swf.paginators.ListWorkflowTypesPublisher publisher = client.listWorkflowTypesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.swf.model.ListWorkflowTypesResponse>() {
 
 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 listWorkflowTypes(software.amazon.awssdk.services.swf.model.ListWorkflowTypesRequest) operation.

      Parameters:
      listWorkflowTypesRequest -
      Returns:
      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 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.

    • listWorkflowTypesPaginator

      default ListWorkflowTypesPublisher listWorkflowTypesPaginator(Consumer<ListWorkflowTypesRequest.Builder> listWorkflowTypesRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new 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 
       
 software.amazon.awssdk.services.swf.paginators.ListWorkflowTypesPublisher publisher = client.listWorkflowTypesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.swf.paginators.ListWorkflowTypesPublisher publisher = client.listWorkflowTypesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.swf.model.ListWorkflowTypesResponse>() {
 
 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 listWorkflowTypes(software.amazon.awssdk.services.swf.model.ListWorkflowTypesRequest) operation.


      This is a convenience which creates an instance of the ListWorkflowTypesRequest.Builder avoiding the need to create one manually via ListWorkflowTypesRequest.builder()

      Parameters:
      listWorkflowTypesRequest - A Consumer that will call methods on ListWorkflowTypesRequest.Builder to create a request.
      Returns:
      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 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.

    • pollForActivityTask

      default CompletableFuture<PollForActivityTaskResponse> pollForActivityTask(PollForActivityTaskRequest pollForActivityTaskRequest)

      Used by workers to get an ActivityTask from the specified activity taskList. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available. The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll 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.

      Parameters:
      pollForActivityTaskRequest -
      Returns:
      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 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.

    • pollForActivityTask

      default CompletableFuture<PollForActivityTaskResponse> pollForActivityTask(Consumer<PollForActivityTaskRequest.Builder> pollForActivityTaskRequest)

      Used by workers to get an ActivityTask from the specified activity taskList. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available. The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll 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 PollForActivityTaskRequest.Builder avoiding the need to create one manually via PollForActivityTaskRequest.builder()

      Parameters:
      pollForActivityTaskRequest - A Consumer that will call methods on PollForActivityTaskRequest.Builder to create a request.
      Returns:
      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 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.

    • pollForDecisionTask

      default CompletableFuture<PollForDecisionTaskResponse> pollForDecisionTask(PollForDecisionTaskRequest pollForDecisionTaskRequest)

      Used by deciders to get a DecisionTask from the specified decision taskList. A decision task may be returned for any open workflow execution that is using the specified task list. The task includes a paginated view of the history of the workflow execution. The decider should use the workflow type and the history to determine how to properly handle the task.

      This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned, but that the value of taskToken is an empty string.

      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.

      Parameters:
      pollForDecisionTaskRequest -
      Returns:
      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 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.

    • pollForDecisionTask

      default CompletableFuture<PollForDecisionTaskResponse> pollForDecisionTask(Consumer<PollForDecisionTaskRequest.Builder> pollForDecisionTaskRequest)

      Used by deciders to get a DecisionTask from the specified decision taskList. A decision task may be returned for any open workflow execution that is using the specified task list. The task includes a paginated view of the history of the workflow execution. The decider should use the workflow type and the history to determine how to properly handle the task.

      This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned, but that the value of taskToken is an empty string.

      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 PollForDecisionTaskRequest.Builder avoiding the need to create one manually via PollForDecisionTaskRequest.builder()

      Parameters:
      pollForDecisionTaskRequest - A Consumer that will call methods on PollForDecisionTaskRequest.Builder to create a request.
      Returns:
      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 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.

    • pollForDecisionTaskPaginator

      default PollForDecisionTaskPublisher pollForDecisionTaskPaginator(PollForDecisionTaskRequest pollForDecisionTaskRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new 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 
       
 software.amazon.awssdk.services.swf.paginators.PollForDecisionTaskPublisher publisher = client.pollForDecisionTaskPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.swf.paginators.PollForDecisionTaskPublisher publisher = client.pollForDecisionTaskPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.swf.model.PollForDecisionTaskResponse>() {
 
 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 pollForDecisionTask(software.amazon.awssdk.services.swf.model.PollForDecisionTaskRequest) operation.

      Parameters:
      pollForDecisionTaskRequest -
      Returns:
      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 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.

    • pollForDecisionTaskPaginator

      default PollForDecisionTaskPublisher pollForDecisionTaskPaginator(Consumer<PollForDecisionTaskRequest.Builder> pollForDecisionTaskRequest)

      This is a variant of 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 Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new 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 
       
 software.amazon.awssdk.services.swf.paginators.PollForDecisionTaskPublisher publisher = client.pollForDecisionTaskPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.swf.paginators.PollForDecisionTaskPublisher publisher = client.pollForDecisionTaskPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.swf.model.PollForDecisionTaskResponse>() {
 
 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 pollForDecisionTask(software.amazon.awssdk.services.swf.model.PollForDecisionTaskRequest) operation.


      This is a convenience which creates an instance of the PollForDecisionTaskRequest.Builder avoiding the need to create one manually via PollForDecisionTaskRequest.builder()

      Parameters:
      pollForDecisionTaskRequest - A Consumer that will call methods on PollForDecisionTaskRequest.Builder to create a request.
      Returns:
      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 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.

    • recordActivityTaskHeartbeat

      default CompletableFuture<RecordActivityTaskHeartbeatResponse> recordActivityTaskHeartbeat(RecordActivityTaskHeartbeatRequest recordActivityTaskHeartbeatRequest)

      Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress. 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.

      Parameters:
      recordActivityTaskHeartbeatRequest -
      Returns:
      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 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.

    • recordActivityTaskHeartbeat

      default CompletableFuture<RecordActivityTaskHeartbeatResponse> recordActivityTaskHeartbeat(Consumer<RecordActivityTaskHeartbeatRequest.Builder> recordActivityTaskHeartbeatRequest)

      Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress. The worker can also 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 RecordActivityTaskHeartbeatRequest.Builder avoiding the need to create one manually via RecordActivityTaskHeartbeatRequest.builder()

      Parameters:
      recordActivityTaskHeartbeatRequest - A Consumer that will call methods on RecordActivityTaskHeartbeatRequest.Builder to create a request.
      Returns:
      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 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.

    • registerActivityType

      default CompletableFuture<RegisterActivityTypeResponse> registerActivityType(RegisterActivityTypeRequest registerActivityTypeRequest)

      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.

      Parameters:
      registerActivityTypeRequest -
      Returns:
      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 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.

    • registerActivityType

      default CompletableFuture<RegisterActivityTypeResponse> registerActivityType(Consumer<RegisterActivityTypeRequest.Builder> registerActivityTypeRequest)

      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 RegisterActivityTypeRequest.Builder avoiding the need to create one manually via RegisterActivityTypeRequest.builder()

      Parameters:
      registerActivityTypeRequest - A Consumer that will call methods on RegisterActivityTypeRequest.Builder to create a request.
      Returns:
      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 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.

    • registerDomain

      default CompletableFuture<RegisterDomainResponse> registerDomain(RegisterDomainRequest registerDomainRequest)

      Registers a new domain.

      Access Control

      You can use IAM policies to control this action's access to Amazon SWF resources as follows:

      • 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.

      Parameters:
      registerDomainRequest -
      Returns:
      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 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.

    • registerDomain

      default CompletableFuture<RegisterDomainResponse> registerDomain(Consumer<RegisterDomainRequest.Builder> registerDomainRequest)

      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 RegisterDomainRequest.Builder avoiding the need to create one manually via RegisterDomainRequest.builder()

      Parameters:
      registerDomainRequest - A Consumer that will call methods on RegisterDomainRequest.Builder to create a request.
      Returns:
      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 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.

    • registerWorkflowType

      default CompletableFuture<RegisterWorkflowTypeResponse> registerWorkflowType(RegisterWorkflowTypeRequest registerWorkflowTypeRequest)

      Registers a new workflow type and its configuration settings in the specified domain.

      The retention period for the workflow history is set by the RegisterDomain action.

      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.

      Parameters:
      registerWorkflowTypeRequest -
      Returns:
      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 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.

    • registerWorkflowType

      default CompletableFuture<RegisterWorkflowTypeResponse> registerWorkflowType(Consumer<RegisterWorkflowTypeRequest.Builder> registerWorkflowTypeRequest)

      Registers a new workflow type and its configuration settings in the specified domain.

      The retention period for the workflow history is set by the RegisterDomain action.

      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 RegisterWorkflowTypeRequest.Builder avoiding the need to create one manually via RegisterWorkflowTypeRequest.builder()

      Parameters:
      registerWorkflowTypeRequest - A Consumer that will call methods on RegisterWorkflowTypeRequest.Builder to create a request.
      Returns:
      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 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.

    • requestCancelWorkflowExecution

      default CompletableFuture<RequestCancelWorkflowExecutionResponse> requestCancelWorkflowExecution(RequestCancelWorkflowExecutionRequest requestCancelWorkflowExecutionRequest)

      Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event.

      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.

      Parameters:
      requestCancelWorkflowExecutionRequest -
      Returns:
      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 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.

    • requestCancelWorkflowExecution

      default CompletableFuture<RequestCancelWorkflowExecutionResponse> requestCancelWorkflowExecution(Consumer<RequestCancelWorkflowExecutionRequest.Builder> requestCancelWorkflowExecutionRequest)

      Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event.

      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 RequestCancelWorkflowExecutionRequest.Builder avoiding the need to create one manually via RequestCancelWorkflowExecutionRequest.builder()

      Parameters:
      requestCancelWorkflowExecutionRequest - A Consumer that will call methods on RequestCancelWorkflowExecutionRequest.Builder to create a request.
      Returns:
      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 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.

    • respondActivityTaskCanceled

      default CompletableFuture<RespondActivityTaskCanceledResponse> respondActivityTaskCanceled(RespondActivityTaskCanceledRequest respondActivityTaskCanceledRequest)

      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.

      Parameters:
      respondActivityTaskCanceledRequest -
      Returns:
      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 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.

    • respondActivityTaskCanceled

      default CompletableFuture<RespondActivityTaskCanceledResponse> respondActivityTaskCanceled(Consumer<RespondActivityTaskCanceledRequest.Builder> respondActivityTaskCanceledRequest)

      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 RespondActivityTaskCanceledRequest.Builder avoiding the need to create one manually via RespondActivityTaskCanceledRequest.builder()

      Parameters:
      respondActivityTaskCanceledRequest - A Consumer that will call methods on RespondActivityTaskCanceledRequest.Builder to create a request.
      Returns:
      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 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.

    • respondActivityTaskCompleted

      default CompletableFuture<RespondActivityTaskCompletedResponse> respondActivityTaskCompleted(RespondActivityTaskCompletedRequest respondActivityTaskCompletedRequest)

      Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided). 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.

      Parameters:
      respondActivityTaskCompletedRequest -
      Returns:
      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 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.

    • respondActivityTaskCompleted

      default CompletableFuture<RespondActivityTaskCompletedResponse> respondActivityTaskCompleted(Consumer<RespondActivityTaskCompletedRequest.Builder> respondActivityTaskCompletedRequest)

      Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided). The result appears in the ActivityTaskCompleted event in the workflow history.

      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 RespondActivityTaskCompletedRequest.Builder avoiding the need to create one manually via RespondActivityTaskCompletedRequest.builder()

      Parameters:
      respondActivityTaskCompletedRequest - A Consumer that will call methods on RespondActivityTaskCompletedRequest.Builder to create a request.
      Returns:
      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 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.

    • respondActivityTaskFailed

      default CompletableFuture<RespondActivityTaskFailedResponse> respondActivityTaskFailed(RespondActivityTaskFailedRequest respondActivityTaskFailedRequest)

      Used by workers to tell the service that the ActivityTask identified by the taskToken has failed with reason (if specified). The reason and details appear in the ActivityTaskFailed event added to the workflow history.

      A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.

      Access Control

      You can use IAM policies to control this action's access to Amazon SWF resources as follows:

      • 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.

      Parameters:
      respondActivityTaskFailedRequest -
      Returns:
      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 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.

    • respondActivityTaskFailed

      default CompletableFuture<RespondActivityTaskFailedResponse> respondActivityTaskFailed(Consumer<RespondActivityTaskFailedRequest.Builder> respondActivityTaskFailedRequest)

      Used by workers to tell the service that the ActivityTask identified by the taskToken has failed with reason (if specified). The reason and details appear in the ActivityTaskFailed event added to the workflow history.

      A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.

      Access Control

      You can use IAM policies to control this action's access to Amazon SWF resources as follows:

      • 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 RespondActivityTaskFailedRequest.Builder avoiding the need to create one manually via RespondActivityTaskFailedRequest.builder()

      Parameters:
      respondActivityTaskFailedRequest - A Consumer that will call methods on RespondActivityTaskFailedRequest.Builder to create a request.
      Returns:
      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 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.

    • respondDecisionTaskCompleted

      default CompletableFuture<RespondDecisionTaskCompletedResponse> respondDecisionTaskCompleted(RespondDecisionTaskCompletedRequest respondDecisionTaskCompletedRequest)

      Used by deciders to tell the service that the DecisionTask identified by the taskToken has successfully completed. The decisions argument specifies the list of decisions made while processing the task.

      A DecisionTaskCompleted event is added to the workflow history. The executionContext specified is attached to the event in the workflow execution history.

      Access Control

      If an IAM policy grants permission to use RespondDecisionTaskCompleted, it can express permissions for the list of decisions in the decisions parameter. Each of the decisions has one or more parameters, much like a regular API call. To allow for policies to be as readable as possible, you can express permissions on decisions as if they were actual API calls, including applying conditions to some parameters. For more information, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

      Parameters:
      respondDecisionTaskCompletedRequest - Input data for a TaskCompleted response to a decision task.
      Returns:
      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 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.

    • respondDecisionTaskCompleted

      default CompletableFuture<RespondDecisionTaskCompletedResponse> respondDecisionTaskCompleted(Consumer<RespondDecisionTaskCompletedRequest.Builder> respondDecisionTaskCompletedRequest)

      Used by deciders to tell the service that the DecisionTask identified by the taskToken has successfully completed. The decisions argument specifies the list of decisions made while processing the task.

      A DecisionTaskCompleted event is added to the workflow history. The executionContext specified is attached to the event in the workflow execution history.

      Access Control

      If an IAM policy grants permission to use RespondDecisionTaskCompleted, it can express permissions for the list of decisions in the decisions parameter. Each of the decisions has one or more parameters, much like a regular API call. To allow for policies to be as readable as possible, you can express permissions on decisions as if they were actual API calls, including applying conditions to some parameters. For more information, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.


      This is a convenience which creates an instance of the RespondDecisionTaskCompletedRequest.Builder avoiding the need to create one manually via RespondDecisionTaskCompletedRequest.builder()

      Parameters:
      respondDecisionTaskCompletedRequest - A Consumer that will call methods on RespondDecisionTaskCompletedRequest.Builder to create a request. Input data for a TaskCompleted response to a decision task.
      Returns:
      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 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.

    • signalWorkflowExecution

      default CompletableFuture<SignalWorkflowExecutionResponse> signalWorkflowExecution(SignalWorkflowExecutionRequest signalWorkflowExecutionRequest)

      Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. 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.

      Parameters:
      signalWorkflowExecutionRequest -
      Returns:
      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 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.

    • signalWorkflowExecution

      default CompletableFuture<SignalWorkflowExecutionResponse> signalWorkflowExecution(Consumer<SignalWorkflowExecutionRequest.Builder> signalWorkflowExecutionRequest)

      Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided).

      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 SignalWorkflowExecutionRequest.Builder avoiding the need to create one manually via SignalWorkflowExecutionRequest.builder()

      Parameters:
      signalWorkflowExecutionRequest - A Consumer that will call methods on SignalWorkflowExecutionRequest.Builder to create a request.
      Returns:
      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 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.

    • startWorkflowExecution

      default CompletableFuture<StartWorkflowExecutionResponse> startWorkflowExecution(StartWorkflowExecutionRequest startWorkflowExecutionRequest)

      Starts an execution of the workflow type in the specified domain using the provided workflowId and input data.

      This action returns the newly started workflow execution.

      Access Control

      You can use IAM policies to control this action's access to Amazon SWF resources as follows:

      • 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.

      Parameters:
      startWorkflowExecutionRequest -
      Returns:
      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 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.

    • startWorkflowExecution

      default CompletableFuture<StartWorkflowExecutionResponse> startWorkflowExecution(Consumer<StartWorkflowExecutionRequest.Builder> startWorkflowExecutionRequest)

      Starts an execution of the workflow type in the specified domain using the provided workflowId and input data.

      This action returns the newly started workflow execution.

      Access Control

      You can use IAM policies to control this action's access to Amazon SWF resources as follows:

      • 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 StartWorkflowExecutionRequest.Builder avoiding the need to create one manually via StartWorkflowExecutionRequest.builder()

      Parameters:
      startWorkflowExecutionRequest - A Consumer that will call methods on StartWorkflowExecutionRequest.Builder to create a request.
      Returns:
      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 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.

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Add a tag to a Amazon SWF domain.

      Amazon SWF supports a maximum of 50 tags per resource.

      Parameters:
      tagResourceRequest -
      Returns:
      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 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.

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      Add a tag to a Amazon SWF domain.

      Amazon SWF supports a maximum of 50 tags per resource.


      This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      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 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.

    • terminateWorkflowExecution

      default CompletableFuture<TerminateWorkflowExecutionResponse> terminateWorkflowExecution(TerminateWorkflowExecutionRequest terminateWorkflowExecutionRequest)

      Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution.

      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.

      Parameters:
      terminateWorkflowExecutionRequest -
      Returns:
      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 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.

    • terminateWorkflowExecution

      default CompletableFuture<TerminateWorkflowExecutionResponse> terminateWorkflowExecution(Consumer<TerminateWorkflowExecutionRequest.Builder> terminateWorkflowExecutionRequest)

      Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution.

      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 TerminateWorkflowExecutionRequest.Builder avoiding the need to create one manually via TerminateWorkflowExecutionRequest.builder()

      Parameters:
      terminateWorkflowExecutionRequest - A Consumer that will call methods on TerminateWorkflowExecutionRequest.Builder to create a request.
      Returns:
      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 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.

    • undeprecateActivityType

      default CompletableFuture<UndeprecateActivityTypeResponse> undeprecateActivityType(UndeprecateActivityTypeRequest undeprecateActivityTypeRequest)

      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.

      Parameters:
      undeprecateActivityTypeRequest -
      Returns:
      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 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.

    • undeprecateActivityType

      default CompletableFuture<UndeprecateActivityTypeResponse> undeprecateActivityType(Consumer<UndeprecateActivityTypeRequest.Builder> undeprecateActivityTypeRequest)

      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 UndeprecateActivityTypeRequest.Builder avoiding the need to create one manually via UndeprecateActivityTypeRequest.builder()

      Parameters:
      undeprecateActivityTypeRequest - A Consumer that will call methods on UndeprecateActivityTypeRequest.Builder to create a request.
      Returns:
      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 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.

    • undeprecateDomain

      default CompletableFuture<UndeprecateDomainResponse> undeprecateDomain(UndeprecateDomainRequest undeprecateDomainRequest)

      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.

      Parameters:
      undeprecateDomainRequest -
      Returns:
      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 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.

    • undeprecateDomain

      default CompletableFuture<UndeprecateDomainResponse> undeprecateDomain(Consumer<UndeprecateDomainRequest.Builder> undeprecateDomainRequest)

      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 UndeprecateDomainRequest.Builder avoiding the need to create one manually via UndeprecateDomainRequest.builder()

      Parameters:
      undeprecateDomainRequest - A Consumer that will call methods on UndeprecateDomainRequest.Builder to create a request.
      Returns:
      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 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.

    • undeprecateWorkflowType

      default CompletableFuture<UndeprecateWorkflowTypeResponse> undeprecateWorkflowType(UndeprecateWorkflowTypeRequest undeprecateWorkflowTypeRequest)

      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.

      Parameters:
      undeprecateWorkflowTypeRequest -
      Returns:
      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 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.

    • undeprecateWorkflowType

      default CompletableFuture<UndeprecateWorkflowTypeResponse> undeprecateWorkflowType(Consumer<UndeprecateWorkflowTypeRequest.Builder> undeprecateWorkflowTypeRequest)

      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 UndeprecateWorkflowTypeRequest.Builder avoiding the need to create one manually via UndeprecateWorkflowTypeRequest.builder()

      Parameters:
      undeprecateWorkflowTypeRequest - A Consumer that will call methods on UndeprecateWorkflowTypeRequest.Builder to create a request.
      Returns:
      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 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.

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Remove a tag from a Amazon SWF domain.

      Parameters:
      untagResourceRequest -
      Returns:
      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 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.

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Remove a tag from a Amazon SWF domain.


      This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      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 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.

    • serviceClientConfiguration

      default SwfServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static SwfAsyncClient create()
      Create a SwfAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static SwfAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a SwfAsyncClient.