software.amazon.awssdk.services.sfn.SFNAsyncClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of stepfunctions Show documentation
Show all versions of stepfunctions Show documentation
The AWS Java SDK for AWS Step Functions module holds the client classes that are used for communicating
with AWS Step Functions.
/*
* Copyright 2012-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.sfn;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import javax.annotation.Generated;
import software.amazon.awssdk.services.sfn.model.CreateActivityRequest;
import software.amazon.awssdk.services.sfn.model.CreateActivityResponse;
import software.amazon.awssdk.services.sfn.model.CreateStateMachineRequest;
import software.amazon.awssdk.services.sfn.model.CreateStateMachineResponse;
import software.amazon.awssdk.services.sfn.model.DeleteActivityRequest;
import software.amazon.awssdk.services.sfn.model.DeleteActivityResponse;
import software.amazon.awssdk.services.sfn.model.DeleteStateMachineRequest;
import software.amazon.awssdk.services.sfn.model.DeleteStateMachineResponse;
import software.amazon.awssdk.services.sfn.model.DescribeActivityRequest;
import software.amazon.awssdk.services.sfn.model.DescribeActivityResponse;
import software.amazon.awssdk.services.sfn.model.DescribeExecutionRequest;
import software.amazon.awssdk.services.sfn.model.DescribeExecutionResponse;
import software.amazon.awssdk.services.sfn.model.DescribeStateMachineForExecutionRequest;
import software.amazon.awssdk.services.sfn.model.DescribeStateMachineForExecutionResponse;
import software.amazon.awssdk.services.sfn.model.DescribeStateMachineRequest;
import software.amazon.awssdk.services.sfn.model.DescribeStateMachineResponse;
import software.amazon.awssdk.services.sfn.model.GetActivityTaskRequest;
import software.amazon.awssdk.services.sfn.model.GetActivityTaskResponse;
import software.amazon.awssdk.services.sfn.model.GetExecutionHistoryRequest;
import software.amazon.awssdk.services.sfn.model.GetExecutionHistoryResponse;
import software.amazon.awssdk.services.sfn.model.ListActivitiesRequest;
import software.amazon.awssdk.services.sfn.model.ListActivitiesResponse;
import software.amazon.awssdk.services.sfn.model.ListExecutionsRequest;
import software.amazon.awssdk.services.sfn.model.ListExecutionsResponse;
import software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest;
import software.amazon.awssdk.services.sfn.model.ListStateMachinesResponse;
import software.amazon.awssdk.services.sfn.model.SendTaskFailureRequest;
import software.amazon.awssdk.services.sfn.model.SendTaskFailureResponse;
import software.amazon.awssdk.services.sfn.model.SendTaskHeartbeatRequest;
import software.amazon.awssdk.services.sfn.model.SendTaskHeartbeatResponse;
import software.amazon.awssdk.services.sfn.model.SendTaskSuccessRequest;
import software.amazon.awssdk.services.sfn.model.SendTaskSuccessResponse;
import software.amazon.awssdk.services.sfn.model.StartExecutionRequest;
import software.amazon.awssdk.services.sfn.model.StartExecutionResponse;
import software.amazon.awssdk.services.sfn.model.StopExecutionRequest;
import software.amazon.awssdk.services.sfn.model.StopExecutionResponse;
import software.amazon.awssdk.services.sfn.model.UpdateStateMachineRequest;
import software.amazon.awssdk.services.sfn.model.UpdateStateMachineResponse;
import software.amazon.awssdk.utils.SdkAutoCloseable;
/**
* Service client for accessing AWS SFN asynchronously. This can be created using the static {@link #builder()} method.
*
* AWS Step Functions
*
* AWS Step Functions is a service that lets you coordinate the components of distributed applications and microservices
* using visual workflows.
*
*
* You can use Step Functions to build applications from individual components, each of which performs a discrete
* function, or task, allowing you to scale and change applications quickly. Step Functions provides a console
* that helps visualize the components of your application as a series of steps. Step Functions automatically triggers
* and tracks each step, and retries steps when there are errors, so your application executes predictably and in the
* right order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any issues.
*
*
* Step Functions manages operations and underlying infrastructure to ensure your application is available at any scale.
* You can run tasks on AWS, your own servers, or any system that has access to AWS. You can access and use Step
* Functions using the console, the AWS SDKs, or an HTTP API. For more information about Step Functions, see the AWS Step Functions Developer Guide .
*
*/
@Generated("software.amazon.awssdk:codegen")
public interface SFNAsyncClient extends SdkAutoCloseable {
/**
* Create a {@link SFNAsyncClient} with the region loaded from the
* {@link software.amazon.awssdk.core.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from
* the {@link software.amazon.awssdk.core.auth.DefaultCredentialsProvider}.
*/
static SFNAsyncClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link SFNAsyncClient}.
*/
static SFNAsyncClientBuilder builder() {
return new DefaultSFNAsyncClientBuilder();
}
/**
*
* Creates an activity. An activity is a task which you write in any programming language and host on any machine
* which has access to AWS Step Functions. Activities must poll Step Functions using the
* GetActivityTask API action and respond using SendTask* API actions. This function lets
* Step Functions know the existence of your activity and returns an identifier for use in a state machine and when
* polling from the activity.
*
*
* @param createActivityRequest
* @return A Java Future containing the result of the CreateActivity operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ActivityLimitExceededException The maximum number of activities has been reached. Existing activities
* must be deleted before a new activity can be created.
* - InvalidNameException The provided name is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.CreateActivity
* @see AWS API
* Documentation
*/
default CompletableFuture createActivity(CreateActivityRequest createActivityRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates an activity. An activity is a task which you write in any programming language and host on any machine
* which has access to AWS Step Functions. Activities must poll Step Functions using the
* GetActivityTask API action and respond using SendTask* API actions. This function lets
* Step Functions know the existence of your activity and returns an identifier for use in a state machine and when
* polling from the activity.
*
*
* This is a convenience which creates an instance of the {@link CreateActivityRequest.Builder} avoiding the need to
* create one manually via {@link CreateActivityRequest#builder()}
*
* @param createActivityRequest
* a {@link Consumer} that will call methods on {@link CreateActivityInput.Builder}.
* @return A Java Future containing the result of the CreateActivity operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ActivityLimitExceededException The maximum number of activities has been reached. Existing activities
* must be deleted before a new activity can be created.
* - InvalidNameException The provided name is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.CreateActivity
* @see AWS API
* Documentation
*/
default CompletableFuture createActivity(Consumer createActivityRequest) {
return createActivity(CreateActivityRequest.builder().apply(createActivityRequest).build());
}
/**
*
* Creates a state machine. A state machine consists of a collection of states that can do work (Task
* states), determine to which states to transition next (Choice states), stop an execution with an
* error (Fail states), and so on. State machines are specified using a JSON-based, structured
* language.
*
*
* @param createStateMachineRequest
* @return A Java Future containing the result of the CreateStateMachine operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidArnException The provided Amazon Resource Name (ARN) is invalid.
* - InvalidDefinitionException The provided Amazon States Language definition is invalid.
* - InvalidNameException The provided name is invalid.
* - StateMachineAlreadyExistsException A state machine with the same name but a different definition or
* role ARN already exists.
* - StateMachineDeletingException The specified state machine is being deleted.
* - StateMachineLimitExceededException The maximum number of state machines has been reached. Existing
* state machines must be deleted before a new state machine can be created.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.CreateStateMachine
* @see AWS API
* Documentation
*/
default CompletableFuture createStateMachine(CreateStateMachineRequest createStateMachineRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a state machine. A state machine consists of a collection of states that can do work (Task
* states), determine to which states to transition next (Choice states), stop an execution with an
* error (Fail states), and so on. State machines are specified using a JSON-based, structured
* language.
*
*
* This is a convenience which creates an instance of the {@link CreateStateMachineRequest.Builder} avoiding the
* need to create one manually via {@link CreateStateMachineRequest#builder()}
*
* @param createStateMachineRequest
* a {@link Consumer} that will call methods on {@link CreateStateMachineInput.Builder}.
* @return A Java Future containing the result of the CreateStateMachine operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidArnException The provided Amazon Resource Name (ARN) is invalid.
* - InvalidDefinitionException The provided Amazon States Language definition is invalid.
* - InvalidNameException The provided name is invalid.
* - StateMachineAlreadyExistsException A state machine with the same name but a different definition or
* role ARN already exists.
* - StateMachineDeletingException The specified state machine is being deleted.
* - StateMachineLimitExceededException The maximum number of state machines has been reached. Existing
* state machines must be deleted before a new state machine can be created.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.CreateStateMachine
* @see AWS API
* Documentation
*/
default CompletableFuture createStateMachine(
Consumer createStateMachineRequest) {
return createStateMachine(CreateStateMachineRequest.builder().apply(createStateMachineRequest).build());
}
/**
*
* Deletes an activity.
*
*
* @param deleteActivityRequest
* @return A Java Future containing the result of the DeleteActivity operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidArnException The provided Amazon Resource Name (ARN) is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.DeleteActivity
* @see AWS API
* Documentation
*/
default CompletableFuture deleteActivity(DeleteActivityRequest deleteActivityRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an activity.
*
*
* This is a convenience which creates an instance of the {@link DeleteActivityRequest.Builder} avoiding the need to
* create one manually via {@link DeleteActivityRequest#builder()}
*
* @param deleteActivityRequest
* a {@link Consumer} that will call methods on {@link DeleteActivityInput.Builder}.
* @return A Java Future containing the result of the DeleteActivity operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidArnException The provided Amazon Resource Name (ARN) is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.DeleteActivity
* @see AWS API
* Documentation
*/
default CompletableFuture deleteActivity(Consumer deleteActivityRequest) {
return deleteActivity(DeleteActivityRequest.builder().apply(deleteActivityRequest).build());
}
/**
*
* Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to
* DELETING and begins the deletion process. Each state machine execution is deleted the next time it
* makes a state transition.
*
*
*
* The state machine itself is deleted after all executions are completed or deleted.
*
*
*
* @param deleteStateMachineRequest
* @return A Java Future containing the result of the DeleteStateMachine operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidArnException The provided Amazon Resource Name (ARN) is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.DeleteStateMachine
* @see AWS API
* Documentation
*/
default CompletableFuture deleteStateMachine(DeleteStateMachineRequest deleteStateMachineRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to
* DELETING and begins the deletion process. Each state machine execution is deleted the next time it
* makes a state transition.
*
*
*
* The state machine itself is deleted after all executions are completed or deleted.
*
*
* This is a convenience which creates an instance of the {@link DeleteStateMachineRequest.Builder} avoiding the
* need to create one manually via {@link DeleteStateMachineRequest#builder()}
*
* @param deleteStateMachineRequest
* a {@link Consumer} that will call methods on {@link DeleteStateMachineInput.Builder}.
* @return A Java Future containing the result of the DeleteStateMachine operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidArnException The provided Amazon Resource Name (ARN) is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.DeleteStateMachine
* @see AWS API
* Documentation
*/
default CompletableFuture deleteStateMachine(
Consumer deleteStateMachineRequest) {
return deleteStateMachine(DeleteStateMachineRequest.builder().apply(deleteStateMachineRequest).build());
}
/**
*
* Describes an activity.
*
*
* @param describeActivityRequest
* @return A Java Future containing the result of the DescribeActivity operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ActivityDoesNotExistException The specified activity does not exist.
* - InvalidArnException The provided Amazon Resource Name (ARN) is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.DescribeActivity
* @see AWS API
* Documentation
*/
default CompletableFuture describeActivity(DescribeActivityRequest describeActivityRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes an activity.
*
*
* This is a convenience which creates an instance of the {@link DescribeActivityRequest.Builder} avoiding the need
* to create one manually via {@link DescribeActivityRequest#builder()}
*
* @param describeActivityRequest
* a {@link Consumer} that will call methods on {@link DescribeActivityInput.Builder}.
* @return A Java Future containing the result of the DescribeActivity operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ActivityDoesNotExistException The specified activity does not exist.
* - InvalidArnException The provided Amazon Resource Name (ARN) is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.DescribeActivity
* @see AWS API
* Documentation
*/
default CompletableFuture describeActivity(
Consumer describeActivityRequest) {
return describeActivity(DescribeActivityRequest.builder().apply(describeActivityRequest).build());
}
/**
*
* Describes an execution.
*
*
* @param describeExecutionRequest
* @return A Java Future containing the result of the DescribeExecution operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ExecutionDoesNotExistException The specified execution does not exist.
* - InvalidArnException The provided Amazon Resource Name (ARN) is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.DescribeExecution
* @see AWS API
* Documentation
*/
default CompletableFuture describeExecution(DescribeExecutionRequest describeExecutionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes an execution.
*
*
* This is a convenience which creates an instance of the {@link DescribeExecutionRequest.Builder} avoiding the need
* to create one manually via {@link DescribeExecutionRequest#builder()}
*
* @param describeExecutionRequest
* a {@link Consumer} that will call methods on {@link DescribeExecutionInput.Builder}.
* @return A Java Future containing the result of the DescribeExecution operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ExecutionDoesNotExistException The specified execution does not exist.
* - InvalidArnException The provided Amazon Resource Name (ARN) is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.DescribeExecution
* @see AWS API
* Documentation
*/
default CompletableFuture describeExecution(
Consumer describeExecutionRequest) {
return describeExecution(DescribeExecutionRequest.builder().apply(describeExecutionRequest).build());
}
/**
*
* Describes a state machine.
*
*
* @param describeStateMachineRequest
* @return A Java Future containing the result of the DescribeStateMachine operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidArnException The provided Amazon Resource Name (ARN) is invalid.
* - StateMachineDoesNotExistException The specified state machine does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.DescribeStateMachine
* @see AWS
* API Documentation
*/
default CompletableFuture describeStateMachine(
DescribeStateMachineRequest describeStateMachineRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes a state machine.
*
*
* This is a convenience which creates an instance of the {@link DescribeStateMachineRequest.Builder} avoiding the
* need to create one manually via {@link DescribeStateMachineRequest#builder()}
*
* @param describeStateMachineRequest
* a {@link Consumer} that will call methods on {@link DescribeStateMachineInput.Builder}.
* @return A Java Future containing the result of the DescribeStateMachine operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidArnException The provided Amazon Resource Name (ARN) is invalid.
* - StateMachineDoesNotExistException The specified state machine does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.DescribeStateMachine
* @see AWS
* API Documentation
*/
default CompletableFuture describeStateMachine(
Consumer describeStateMachineRequest) {
return describeStateMachine(DescribeStateMachineRequest.builder().apply(describeStateMachineRequest).build());
}
/**
*
* Describes the state machine associated with a specific execution.
*
*
* @param describeStateMachineForExecutionRequest
* @return A Java Future containing the result of the DescribeStateMachineForExecution operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ExecutionDoesNotExistException The specified execution does not exist.
* - InvalidArnException The provided Amazon Resource Name (ARN) is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.DescribeStateMachineForExecution
* @see AWS API Documentation
*/
default CompletableFuture describeStateMachineForExecution(
DescribeStateMachineForExecutionRequest describeStateMachineForExecutionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes the state machine associated with a specific execution.
*
*
* This is a convenience which creates an instance of the {@link DescribeStateMachineForExecutionRequest.Builder}
* avoiding the need to create one manually via {@link DescribeStateMachineForExecutionRequest#builder()}
*
* @param describeStateMachineForExecutionRequest
* a {@link Consumer} that will call methods on {@link DescribeStateMachineForExecutionInput.Builder}.
* @return A Java Future containing the result of the DescribeStateMachineForExecution operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ExecutionDoesNotExistException The specified execution does not exist.
* - InvalidArnException The provided Amazon Resource Name (ARN) is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.DescribeStateMachineForExecution
* @see AWS API Documentation
*/
default CompletableFuture describeStateMachineForExecution(
Consumer describeStateMachineForExecutionRequest) {
return describeStateMachineForExecution(DescribeStateMachineForExecutionRequest.builder()
.apply(describeStateMachineForExecutionRequest).build());
}
/**
*
* Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a
* running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds
* as soon as a task becomes available (i.e. an execution of a task of this type is needed.) 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 a taskToken with a null string.
*
*
*
* Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum
* time the service may hold the poll request).
*
*
*
* @param getActivityTaskRequest
* @return A Java Future containing the result of the GetActivityTask operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ActivityDoesNotExistException The specified activity does not exist.
* - ActivityWorkerLimitExceededException The maximum number of workers concurrently polling for activity
* tasks has been reached.
* - InvalidArnException The provided Amazon Resource Name (ARN) is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.GetActivityTask
* @see AWS API
* Documentation
*/
default CompletableFuture getActivityTask(GetActivityTaskRequest getActivityTaskRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a
* running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds
* as soon as a task becomes available (i.e. an execution of a task of this type is needed.) 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 a taskToken with a null string.
*
*
*
* Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum
* time the service may hold the poll request).
*
*
* This is a convenience which creates an instance of the {@link GetActivityTaskRequest.Builder} avoiding the need
* to create one manually via {@link GetActivityTaskRequest#builder()}
*
* @param getActivityTaskRequest
* a {@link Consumer} that will call methods on {@link GetActivityTaskInput.Builder}.
* @return A Java Future containing the result of the GetActivityTask operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ActivityDoesNotExistException The specified activity does not exist.
* - ActivityWorkerLimitExceededException The maximum number of workers concurrently polling for activity
* tasks has been reached.
* - InvalidArnException The provided Amazon Resource Name (ARN) is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.GetActivityTask
* @see AWS API
* Documentation
*/
default CompletableFuture getActivityTask(
Consumer getActivityTaskRequest) {
return getActivityTask(GetActivityTaskRequest.builder().apply(getActivityTaskRequest).build());
}
/**
*
* Returns the history of the specified execution as a list of events. By default, the results are returned in
* ascending order of the timeStamp of the events. Use the reverseOrder parameter to get
* the latest events first.
*
*
* If a nextToken is returned by a previous call, there are more results available. To retrieve the
* next page of results, make the call again using the returned token in nextToken. Keep all other
* arguments unchanged.
*
*
* @param getExecutionHistoryRequest
* @return A Java Future containing the result of the GetExecutionHistory operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ExecutionDoesNotExistException The specified execution does not exist.
* - InvalidArnException The provided Amazon Resource Name (ARN) is invalid.
* - InvalidTokenException The provided token is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.GetExecutionHistory
* @see AWS API
* Documentation
*/
default CompletableFuture getExecutionHistory(
GetExecutionHistoryRequest getExecutionHistoryRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the history of the specified execution as a list of events. By default, the results are returned in
* ascending order of the timeStamp of the events. Use the reverseOrder parameter to get
* the latest events first.
*
*
* If a nextToken is returned by a previous call, there are more results available. To retrieve the
* next page of results, make the call again using the returned token in nextToken. Keep all other
* arguments unchanged.
*
*
* This is a convenience which creates an instance of the {@link GetExecutionHistoryRequest.Builder} avoiding the
* need to create one manually via {@link GetExecutionHistoryRequest#builder()}
*
* @param getExecutionHistoryRequest
* a {@link Consumer} that will call methods on {@link GetExecutionHistoryInput.Builder}.
* @return A Java Future containing the result of the GetExecutionHistory operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ExecutionDoesNotExistException The specified execution does not exist.
* - InvalidArnException The provided Amazon Resource Name (ARN) is invalid.
* - InvalidTokenException The provided token is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.GetExecutionHistory
* @see AWS API
* Documentation
*/
default CompletableFuture getExecutionHistory(
Consumer getExecutionHistoryRequest) {
return getExecutionHistory(GetExecutionHistoryRequest.builder().apply(getExecutionHistoryRequest).build());
}
/**
*
* Lists the existing activities.
*
*
* If a nextToken is returned by a previous call, there are more results available. To retrieve the
* next page of results, make the call again using the returned token in nextToken. Keep all other
* arguments unchanged.
*
*
* @param listActivitiesRequest
* @return A Java Future containing the result of the ListActivities operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidTokenException The provided token is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.ListActivities
* @see AWS API
* Documentation
*/
default CompletableFuture listActivities(ListActivitiesRequest listActivitiesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the existing activities.
*
*
* If a nextToken is returned by a previous call, there are more results available. To retrieve the
* next page of results, make the call again using the returned token in nextToken. Keep all other
* arguments unchanged.
*
*
* @return A Java Future containing the result of the ListActivities operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidTokenException The provided token is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.ListActivities
* @see AWS API
* Documentation
*/
default CompletableFuture listActivities() {
return listActivities(ListActivitiesRequest.builder().build());
}
/**
*
* Lists the existing activities.
*
*
* If a nextToken is returned by a previous call, there are more results available. To retrieve the
* next page of results, make the call again using the returned token in nextToken. Keep all other
* arguments unchanged.
*
*
* This is a convenience which creates an instance of the {@link ListActivitiesRequest.Builder} avoiding the need to
* create one manually via {@link ListActivitiesRequest#builder()}
*
* @param listActivitiesRequest
* a {@link Consumer} that will call methods on {@link ListActivitiesInput.Builder}.
* @return A Java Future containing the result of the ListActivities operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidTokenException The provided token is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.ListActivities
* @see AWS API
* Documentation
*/
default CompletableFuture listActivities(Consumer listActivitiesRequest) {
return listActivities(ListActivitiesRequest.builder().apply(listActivitiesRequest).build());
}
/**
*
* Lists the executions of a state machine that meet the filtering criteria.
*
*
* If a nextToken is returned by a previous call, there are more results available. To retrieve the
* next page of results, make the call again using the returned token in nextToken. Keep all other
* arguments unchanged.
*
*
* @param listExecutionsRequest
* @return A Java Future containing the result of the ListExecutions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidArnException The provided Amazon Resource Name (ARN) is invalid.
* - InvalidTokenException The provided token is invalid.
* - StateMachineDoesNotExistException The specified state machine does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.ListExecutions
* @see AWS API
* Documentation
*/
default CompletableFuture listExecutions(ListExecutionsRequest listExecutionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the executions of a state machine that meet the filtering criteria.
*
*
* If a nextToken is returned by a previous call, there are more results available. To retrieve the
* next page of results, make the call again using the returned token in nextToken. Keep all other
* arguments unchanged.
*
*
* This is a convenience which creates an instance of the {@link ListExecutionsRequest.Builder} avoiding the need to
* create one manually via {@link ListExecutionsRequest#builder()}
*
* @param listExecutionsRequest
* a {@link Consumer} that will call methods on {@link ListExecutionsInput.Builder}.
* @return A Java Future containing the result of the ListExecutions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidArnException The provided Amazon Resource Name (ARN) is invalid.
* - InvalidTokenException The provided token is invalid.
* - StateMachineDoesNotExistException The specified state machine does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.ListExecutions
* @see AWS API
* Documentation
*/
default CompletableFuture listExecutions(Consumer listExecutionsRequest) {
return listExecutions(ListExecutionsRequest.builder().apply(listExecutionsRequest).build());
}
/**
*
* Lists the existing state machines.
*
*
* If a nextToken is returned by a previous call, there are more results available. To retrieve the
* next page of results, make the call again using the returned token in nextToken. Keep all other
* arguments unchanged.
*
*
* @param listStateMachinesRequest
* @return A Java Future containing the result of the ListStateMachines operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidTokenException The provided token is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.ListStateMachines
* @see AWS API
* Documentation
*/
default CompletableFuture listStateMachines(ListStateMachinesRequest listStateMachinesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the existing state machines.
*
*
* If a nextToken is returned by a previous call, there are more results available. To retrieve the
* next page of results, make the call again using the returned token in nextToken. Keep all other
* arguments unchanged.
*
*
* @return A Java Future containing the result of the ListStateMachines operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidTokenException The provided token is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.ListStateMachines
* @see AWS API
* Documentation
*/
default CompletableFuture listStateMachines() {
return listStateMachines(ListStateMachinesRequest.builder().build());
}
/**
*
* Lists the existing state machines.
*
*
* If a nextToken is returned by a previous call, there are more results available. To retrieve the
* next page of results, make the call again using the returned token in nextToken. Keep all other
* arguments unchanged.
*
*
* This is a convenience which creates an instance of the {@link ListStateMachinesRequest.Builder} avoiding the need
* to create one manually via {@link ListStateMachinesRequest#builder()}
*
* @param listStateMachinesRequest
* a {@link Consumer} that will call methods on {@link ListStateMachinesInput.Builder}.
* @return A Java Future containing the result of the ListStateMachines operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidTokenException The provided token is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.ListStateMachines
* @see AWS API
* Documentation
*/
default CompletableFuture listStateMachines(
Consumer listStateMachinesRequest) {
return listStateMachines(ListStateMachinesRequest.builder().apply(listStateMachinesRequest).build());
}
/**
*
* Used by workers to report that the task identified by the taskToken failed.
*
*
* @param sendTaskFailureRequest
* @return A Java Future containing the result of the SendTaskFailure operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - TaskDoesNotExistException
* - InvalidTokenException The provided token is invalid.
* - TaskTimedOutException
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.SendTaskFailure
* @see AWS API
* Documentation
*/
default CompletableFuture sendTaskFailure(SendTaskFailureRequest sendTaskFailureRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Used by workers to report that the task identified by the taskToken failed.
*
*
* This is a convenience which creates an instance of the {@link SendTaskFailureRequest.Builder} avoiding the need
* to create one manually via {@link SendTaskFailureRequest#builder()}
*
* @param sendTaskFailureRequest
* a {@link Consumer} that will call methods on {@link SendTaskFailureInput.Builder}.
* @return A Java Future containing the result of the SendTaskFailure operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - TaskDoesNotExistException
* - InvalidTokenException The provided token is invalid.
* - TaskTimedOutException
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.SendTaskFailure
* @see AWS API
* Documentation
*/
default CompletableFuture sendTaskFailure(
Consumer sendTaskFailureRequest) {
return sendTaskFailure(SendTaskFailureRequest.builder().apply(sendTaskFailureRequest).build());
}
/**
*
* Used by workers to report to the service that the task represented by the specified taskToken is
* still making progress. This action resets the Heartbeat clock. The Heartbeat threshold
* is specified in the state machine's Amazon States Language definition. This action does not in itself create an
* event in the execution history. However, if the task times out, the execution history contains an
* ActivityTimedOut event.
*
*
*
* The Timeout of a task, defined in the state machine's Amazon States Language definition, is its
* maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received.
*
*
*
* This operation is only useful for long-lived tasks to report the liveliness of the task.
*
*
*
* @param sendTaskHeartbeatRequest
* @return A Java Future containing the result of the SendTaskHeartbeat operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - TaskDoesNotExistException
* - InvalidTokenException The provided token is invalid.
* - TaskTimedOutException
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.SendTaskHeartbeat
* @see AWS API
* Documentation
*/
default CompletableFuture sendTaskHeartbeat(SendTaskHeartbeatRequest sendTaskHeartbeatRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Used by workers to report to the service that the task represented by the specified taskToken is
* still making progress. This action resets the Heartbeat clock. The Heartbeat threshold
* is specified in the state machine's Amazon States Language definition. This action does not in itself create an
* event in the execution history. However, if the task times out, the execution history contains an
* ActivityTimedOut event.
*
*
*
* The Timeout of a task, defined in the state machine's Amazon States Language definition, is its
* maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received.
*
*
*
* This operation is only useful for long-lived tasks to report the liveliness of the task.
*
*
* This is a convenience which creates an instance of the {@link SendTaskHeartbeatRequest.Builder} avoiding the need
* to create one manually via {@link SendTaskHeartbeatRequest#builder()}
*
* @param sendTaskHeartbeatRequest
* a {@link Consumer} that will call methods on {@link SendTaskHeartbeatInput.Builder}.
* @return A Java Future containing the result of the SendTaskHeartbeat operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - TaskDoesNotExistException
* - InvalidTokenException The provided token is invalid.
* - TaskTimedOutException
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.SendTaskHeartbeat
* @see AWS API
* Documentation
*/
default CompletableFuture sendTaskHeartbeat(
Consumer sendTaskHeartbeatRequest) {
return sendTaskHeartbeat(SendTaskHeartbeatRequest.builder().apply(sendTaskHeartbeatRequest).build());
}
/**
*
* Used by workers to report that the task identified by the taskToken completed successfully.
*
*
* @param sendTaskSuccessRequest
* @return A Java Future containing the result of the SendTaskSuccess operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - TaskDoesNotExistException
* - InvalidOutputException The provided JSON output data is invalid.
* - InvalidTokenException The provided token is invalid.
* - TaskTimedOutException
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.SendTaskSuccess
* @see AWS API
* Documentation
*/
default CompletableFuture sendTaskSuccess(SendTaskSuccessRequest sendTaskSuccessRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Used by workers to report that the task identified by the taskToken completed successfully.
*
*
* This is a convenience which creates an instance of the {@link SendTaskSuccessRequest.Builder} avoiding the need
* to create one manually via {@link SendTaskSuccessRequest#builder()}
*
* @param sendTaskSuccessRequest
* a {@link Consumer} that will call methods on {@link SendTaskSuccessInput.Builder}.
* @return A Java Future containing the result of the SendTaskSuccess operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - TaskDoesNotExistException
* - InvalidOutputException The provided JSON output data is invalid.
* - InvalidTokenException The provided token is invalid.
* - TaskTimedOutException
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.SendTaskSuccess
* @see AWS API
* Documentation
*/
default CompletableFuture sendTaskSuccess(
Consumer sendTaskSuccessRequest) {
return sendTaskSuccess(SendTaskSuccessRequest.builder().apply(sendTaskSuccessRequest).build());
}
/**
*
* Starts a state machine execution.
*
*
* @param startExecutionRequest
* @return A Java Future containing the result of the StartExecution operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ExecutionLimitExceededException The maximum number of running executions has been reached. Running
* executions must end or be stopped before a new execution can be started.
* - ExecutionAlreadyExistsException The execution has the same
name as another execution
* (but a different input).
*
* Executions with the same name and input are considered idempotent.
*
*
* - InvalidArnException The provided Amazon Resource Name (ARN) is invalid.
* - InvalidExecutionInputException The provided JSON input data is invalid.
* - InvalidNameException The provided name is invalid.
* - StateMachineDoesNotExistException The specified state machine does not exist.
* - StateMachineDeletingException The specified state machine is being deleted.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.StartExecution
* @see AWS API
* Documentation
*/
default CompletableFuture startExecution(StartExecutionRequest startExecutionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Starts a state machine execution.
*
*
* This is a convenience which creates an instance of the {@link StartExecutionRequest.Builder} avoiding the need to
* create one manually via {@link StartExecutionRequest#builder()}
*
* @param startExecutionRequest
* a {@link Consumer} that will call methods on {@link StartExecutionInput.Builder}.
* @return A Java Future containing the result of the StartExecution operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ExecutionLimitExceededException The maximum number of running executions has been reached. Running
* executions must end or be stopped before a new execution can be started.
* - ExecutionAlreadyExistsException The execution has the same
name as another execution
* (but a different input).
*
* Executions with the same name and input are considered idempotent.
*
*
* - InvalidArnException The provided Amazon Resource Name (ARN) is invalid.
* - InvalidExecutionInputException The provided JSON input data is invalid.
* - InvalidNameException The provided name is invalid.
* - StateMachineDoesNotExistException The specified state machine does not exist.
* - StateMachineDeletingException The specified state machine is being deleted.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.StartExecution
* @see AWS API
* Documentation
*/
default CompletableFuture startExecution(Consumer startExecutionRequest) {
return startExecution(StartExecutionRequest.builder().apply(startExecutionRequest).build());
}
/**
*
* Stops an execution.
*
*
* @param stopExecutionRequest
* @return A Java Future containing the result of the StopExecution operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ExecutionDoesNotExistException The specified execution does not exist.
* - InvalidArnException The provided Amazon Resource Name (ARN) is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.StopExecution
* @see AWS API
* Documentation
*/
default CompletableFuture stopExecution(StopExecutionRequest stopExecutionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Stops an execution.
*
*
* This is a convenience which creates an instance of the {@link StopExecutionRequest.Builder} avoiding the need to
* create one manually via {@link StopExecutionRequest#builder()}
*
* @param stopExecutionRequest
* a {@link Consumer} that will call methods on {@link StopExecutionInput.Builder}.
* @return A Java Future containing the result of the StopExecution operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ExecutionDoesNotExistException The specified execution does not exist.
* - InvalidArnException The provided Amazon Resource Name (ARN) is invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.StopExecution
* @see AWS API
* Documentation
*/
default CompletableFuture stopExecution(Consumer stopExecutionRequest) {
return stopExecution(StopExecutionRequest.builder().apply(stopExecutionRequest).build());
}
/**
*
* Updates an existing state machine by modifying its definition and/or roleArn. Running
* executions will continue to use the previous definition and roleArn.
*
*
*
* All StartExecution calls within a few seconds will use the updated definition and
* roleArn. Executions started immediately after calling UpdateStateMachine may use the
* previous state machine definition and roleArn. You must include at least one of
* definition or roleArn or you will receive a MissingRequiredParameter
* error.
*
*
*
* @param updateStateMachineRequest
* @return A Java Future containing the result of the UpdateStateMachine operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidArnException The provided Amazon Resource Name (ARN) is invalid.
* - InvalidDefinitionException The provided Amazon States Language definition is invalid.
* - MissingRequiredParameterException Request is missing a required parameter. This error occurs if both
*
definition and roleArn are not specified.
* - StateMachineDeletingException The specified state machine is being deleted.
* - StateMachineDoesNotExistException The specified state machine does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.UpdateStateMachine
* @see AWS API
* Documentation
*/
default CompletableFuture updateStateMachine(UpdateStateMachineRequest updateStateMachineRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates an existing state machine by modifying its definition and/or roleArn. Running
* executions will continue to use the previous definition and roleArn.
*
*
*
* All StartExecution calls within a few seconds will use the updated definition and
* roleArn. Executions started immediately after calling UpdateStateMachine may use the
* previous state machine definition and roleArn. You must include at least one of
* definition or roleArn or you will receive a MissingRequiredParameter
* error.
*
*
* This is a convenience which creates an instance of the {@link UpdateStateMachineRequest.Builder} avoiding the
* need to create one manually via {@link UpdateStateMachineRequest#builder()}
*
* @param updateStateMachineRequest
* a {@link Consumer} that will call methods on {@link UpdateStateMachineInput.Builder}.
* @return A Java Future containing the result of the UpdateStateMachine operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidArnException The provided Amazon Resource Name (ARN) is invalid.
* - InvalidDefinitionException The provided Amazon States Language definition is invalid.
* - MissingRequiredParameterException Request is missing a required parameter. This error occurs if both
*
definition and roleArn are not specified.
* - StateMachineDeletingException The specified state machine is being deleted.
* - StateMachineDoesNotExistException The specified state machine does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample SFNAsyncClient.UpdateStateMachine
* @see AWS API
* Documentation
*/
default CompletableFuture updateStateMachine(
Consumer updateStateMachineRequest) {
return updateStateMachine(UpdateStateMachineRequest.builder().apply(updateStateMachineRequest).build());
}
}