Package software.amazon.awssdk.services.sfn

Interface SFNAsyncClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface SFNAsyncClient
extends AutoCloseable

Service client for accessing AWS SFN asynchronously. This can be created using the static builder() method. AWS Step Functions

AWS Step Functions is a web service that enables you to coordinate the components of distributed applications and microservices using visual workflows. You build applications from individual components that each perform a discrete function, or task, allowing you to scale and change applications quickly. Step Functions provides a graphical console to visualize the components of your application as a series of steps. It automatically triggers and tracks each step, and retries when there are errors, so your application executes in order and as expected, every time. Step Functions logs the state of each step, so when things do go wrong, you can diagnose and debug problems quickly.

Step Functions manages the operations and underlying infrastructure for you to ensure your application is available at any scale. You can run tasks on the AWS cloud, on your own servers, or an any system that has access to AWS. Step Functions can be accessed and used with the Step Functions console, the AWS SDKs (included with your Beta release invitation email), or an HTTP API (the subject of this document).

Method Summary

Modifier and Type	Method	Description
static SFNAsyncClientBuilder	builder()	Create a builder that can be used to configure and create a SFNAsyncClient.
static SFNAsyncClient	create()	Create a SFNAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateActivityResponse>	createActivity(CreateActivityRequest createActivityRequest)	Creates an activity.
default CompletableFuture<CreateStateMachineResponse>	createStateMachine(CreateStateMachineRequest createStateMachineRequest)	Creates a state machine.
default CompletableFuture<DeleteActivityResponse>	deleteActivity(DeleteActivityRequest deleteActivityRequest)	Deletes an activity.
default CompletableFuture<DeleteStateMachineResponse>	deleteStateMachine(DeleteStateMachineRequest deleteStateMachineRequest)	Deletes a state machine.
default CompletableFuture<DescribeActivityResponse>	describeActivity(DescribeActivityRequest describeActivityRequest)	Describes an activity.
default CompletableFuture<DescribeExecutionResponse>	describeExecution(DescribeExecutionRequest describeExecutionRequest)	Describes an execution.
default CompletableFuture<DescribeStateMachineResponse>	describeStateMachine(DescribeStateMachineRequest describeStateMachineRequest)	Describes a state machine.
default CompletableFuture<GetActivityTaskResponse>	getActivityTask(GetActivityTaskRequest getActivityTaskRequest)	Used by workers to retrieve a task (with the specified activity ARN) scheduled for execution by a running state machine.
default CompletableFuture<GetExecutionHistoryResponse>	getExecutionHistory(GetExecutionHistoryRequest getExecutionHistoryRequest)	Returns the history of the specified execution as a list of events.
default CompletableFuture<ListActivitiesResponse>	listActivities(ListActivitiesRequest listActivitiesRequest)	Lists the existing activities.
default CompletableFuture<ListExecutionsResponse>	listExecutions(ListExecutionsRequest listExecutionsRequest)	Lists the executions of a state machine that meet the filtering criteria.
default CompletableFuture<ListStateMachinesResponse>	listStateMachines(ListStateMachinesRequest listStateMachinesRequest)	Lists the existing state machines.
default CompletableFuture<SendTaskFailureResponse>	sendTaskFailure(SendTaskFailureRequest sendTaskFailureRequest)	Used by workers to report that the task identified by the taskToken failed.
default CompletableFuture<SendTaskHeartbeatResponse>	sendTaskHeartbeat(SendTaskHeartbeatRequest sendTaskHeartbeatRequest)	Used by workers to report to the service that the task represented by the specified taskToken is still making progress.
default CompletableFuture<SendTaskSuccessResponse>	sendTaskSuccess(SendTaskSuccessRequest sendTaskSuccessRequest)	Used by workers to report that the task identified by the taskToken completed successfully.
default CompletableFuture<StartExecutionResponse>	startExecution(StartExecutionRequest startExecutionRequest)	Starts a state machine execution.
default CompletableFuture<StopExecutionResponse>	stopExecution(StopExecutionRequest stopExecutionRequest)	Stops an execution.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

create

static SFNAsyncClient create()

Create a SFNAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static SFNAsyncClientBuilder builder()

Create a builder that can be used to configure and create a SFNAsyncClient.

createActivity

default CompletableFuture<CreateActivityResponse> createActivity(CreateActivityRequest createActivityRequest)

Creates an activity.

Parameters:

createActivityRequest -

Returns:

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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createStateMachine

default CompletableFuture<CreateStateMachineResponse> createStateMachine(CreateStateMachineRequest createStateMachineRequest)

Creates a state machine.

Parameters:

createStateMachineRequest -

Returns:

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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteActivity

default CompletableFuture<DeleteActivityResponse> deleteActivity(DeleteActivityRequest deleteActivityRequest)

Deletes an activity.

Parameters:

deleteActivityRequest -

Returns:

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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteStateMachine

default CompletableFuture<DeleteStateMachineResponse> deleteStateMachine(DeleteStateMachineRequest deleteStateMachineRequest)

Deletes a state machine. This is an asynchronous operation-- it sets the state machine's status to "DELETING" and begins the delete process.

Parameters:

deleteStateMachineRequest -

Returns:

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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeActivity

default CompletableFuture<DescribeActivityResponse> describeActivity(DescribeActivityRequest describeActivityRequest)

Describes an activity.

Parameters:

describeActivityRequest -

Returns:

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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeExecution

default CompletableFuture<DescribeExecutionResponse> describeExecution(DescribeExecutionRequest describeExecutionRequest)

Describes an execution.

Parameters:

describeExecutionRequest -

Returns:

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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeStateMachine

default CompletableFuture<DescribeStateMachineResponse> describeStateMachine(DescribeStateMachineRequest describeStateMachineRequest)

Describes a state machine.

Parameters:

describeStateMachineRequest -

Returns:

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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getActivityTask

default CompletableFuture<GetActivityTaskResponse> getActivityTask(GetActivityTaskRequest getActivityTaskRequest)

Used by workers to retrieve a task (with the specified activity ARN) 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 will return an empty result, that is, the taskToken returned is an empty 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).

Parameters:

getActivityTaskRequest -

Returns:

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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getExecutionHistory

default CompletableFuture<GetExecutionHistoryResponse> getExecutionHistory(GetExecutionHistoryRequest getExecutionHistoryRequest)

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. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken returned by the previous call.

Parameters:

getExecutionHistoryRequest -

Returns:

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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listActivities

default CompletableFuture<ListActivitiesResponse> listActivities(ListActivitiesRequest listActivitiesRequest)

Lists the existing activities. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken returned by the previous call.

Parameters:

listActivitiesRequest -

Returns:

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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listExecutions

default CompletableFuture<ListExecutionsResponse> listExecutions(ListExecutionsRequest listExecutionsRequest)

Lists the executions of a state machine that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken returned by the previous call.

Parameters:

listExecutionsRequest -

Returns:

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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listStateMachines

default CompletableFuture<ListStateMachinesResponse> listStateMachines(ListStateMachinesRequest listStateMachinesRequest)

Lists the existing state machines. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken returned by the previous call.

Parameters:

listStateMachinesRequest -

Returns:

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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

sendTaskFailure

default CompletableFuture<SendTaskFailureResponse> sendTaskFailure(SendTaskFailureRequest sendTaskFailureRequest)

Used by workers to report that the task identified by the taskToken failed.

Parameters:

sendTaskFailureRequest -

Returns:

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
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

sendTaskHeartbeat

default CompletableFuture<SendTaskHeartbeatResponse> sendTaskHeartbeat(SendTaskHeartbeatRequest sendTaskHeartbeatRequest)

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 will contain 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.

Parameters:

sendTaskHeartbeatRequest -

Returns:

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
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

sendTaskSuccess

default CompletableFuture<SendTaskSuccessResponse> sendTaskSuccess(SendTaskSuccessRequest sendTaskSuccessRequest)

Used by workers to report that the task identified by the taskToken completed successfully.

Parameters:

sendTaskSuccessRequest -

Returns:

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
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

startExecution

default CompletableFuture<StartExecutionResponse> startExecution(StartExecutionRequest startExecutionRequest)

Starts a state machine execution.

Parameters:

startExecutionRequest -

Returns:

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 An execution with the same name already exists.
• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

stopExecution

default CompletableFuture<StopExecutionResponse> stopExecution(StopExecutionRequest stopExecutionRequest)

Stops an execution.

Parameters:

stopExecutionRequest -

Returns:

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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SFNException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation