AWSStepFunctionsAsyncClient (AWS Java SDK for AWS Step Functions 1.11.70 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.stepfunctions.AWSStepFunctionsClient
  - - com.amazonaws.services.stepfunctions.AWSStepFunctionsAsyncClient

All Implemented Interfaces:

AWSStepFunctions, AWSStepFunctionsAsync
```
@ThreadSafe
public class AWSStepFunctionsAsyncClient
extends AWSStepFunctionsClient
implements AWSStepFunctionsAsync
```
Client for accessing AWS SFN asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.
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).

Field Summary
- Fields inherited from class com.amazonaws.services.stepfunctions.AWSStepFunctionsClient
  configFactory
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
- Fields inherited from interface com.amazonaws.services.stepfunctions.AWSStepFunctions
  ENDPOINT_PREFIX

Constructor Summary

Constructors
Constructor and Description
`AWSStepFunctionsAsyncClient()` Constructs a new asynchronous client to invoke service methods on AWS SFN.
`AWSStepFunctionsAsyncClient(AWSCredentials awsCredentials)` Constructs a new asynchronous client to invoke service methods on AWS SFN using the specified AWS account credentials.
`AWSStepFunctionsAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)` Constructs a new asynchronous client to invoke service methods on AWS SFN using the specified AWS account credentials, executor service, and client configuration options.
`AWSStepFunctionsAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)` Constructs a new asynchronous client to invoke service methods on AWS SFN using the specified AWS account credentials and executor service.
`AWSStepFunctionsAsyncClient(AWSCredentialsProvider awsCredentialsProvider)` Constructs a new asynchronous client to invoke service methods on AWS SFN using the specified AWS account credentials provider.
`AWSStepFunctionsAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)` Constructs a new asynchronous client to invoke service methods on AWS SFN using the provided AWS account credentials provider and client configuration options.
`AWSStepFunctionsAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)` Constructs a new asynchronous client to invoke service methods on AWS SFN using the specified AWS account credentials provider, executor service, and client configuration options.
`AWSStepFunctionsAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)` Constructs a new asynchronous client to invoke service methods on AWS SFN using the specified AWS account credentials provider and executor service.
`AWSStepFunctionsAsyncClient(ClientConfiguration clientConfiguration)` Constructs a new asynchronous client to invoke service methods on AWS SFN.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Future<CreateActivityResult>`	`createActivityAsync(CreateActivityRequest request)` Creates an activity.
`Future<CreateActivityResult>`	`createActivityAsync(CreateActivityRequest request, AsyncHandler<CreateActivityRequest,CreateActivityResult> asyncHandler)` Creates an activity.
`Future<CreateStateMachineResult>`	`createStateMachineAsync(CreateStateMachineRequest request)` Creates a state machine.
`Future<CreateStateMachineResult>`	`createStateMachineAsync(CreateStateMachineRequest request, AsyncHandler<CreateStateMachineRequest,CreateStateMachineResult> asyncHandler)` Creates a state machine.
`Future<DeleteActivityResult>`	`deleteActivityAsync(DeleteActivityRequest request)` Deletes an activity.
`Future<DeleteActivityResult>`	`deleteActivityAsync(DeleteActivityRequest request, AsyncHandler<DeleteActivityRequest,DeleteActivityResult> asyncHandler)` Deletes an activity.
`Future<DeleteStateMachineResult>`	`deleteStateMachineAsync(DeleteStateMachineRequest request)` Deletes a state machine.
`Future<DeleteStateMachineResult>`	`deleteStateMachineAsync(DeleteStateMachineRequest request, AsyncHandler<DeleteStateMachineRequest,DeleteStateMachineResult> asyncHandler)` Deletes a state machine.
`Future<DescribeActivityResult>`	`describeActivityAsync(DescribeActivityRequest request)` Describes an activity.
`Future<DescribeActivityResult>`	`describeActivityAsync(DescribeActivityRequest request, AsyncHandler<DescribeActivityRequest,DescribeActivityResult> asyncHandler)` Describes an activity.
`Future<DescribeExecutionResult>`	`describeExecutionAsync(DescribeExecutionRequest request)` Describes an execution.
`Future<DescribeExecutionResult>`	`describeExecutionAsync(DescribeExecutionRequest request, AsyncHandler<DescribeExecutionRequest,DescribeExecutionResult> asyncHandler)` Describes an execution.
`Future<DescribeStateMachineResult>`	`describeStateMachineAsync(DescribeStateMachineRequest request)` Describes a state machine.
`Future<DescribeStateMachineResult>`	`describeStateMachineAsync(DescribeStateMachineRequest request, AsyncHandler<DescribeStateMachineRequest,DescribeStateMachineResult> asyncHandler)` Describes a state machine.
`Future<GetActivityTaskResult>`	`getActivityTaskAsync(GetActivityTaskRequest request)` Used by workers to retrieve a task (with the specified activity ARN) scheduled for execution by a running state machine.
`Future<GetActivityTaskResult>`	`getActivityTaskAsync(GetActivityTaskRequest request, AsyncHandler<GetActivityTaskRequest,GetActivityTaskResult> asyncHandler)` Used by workers to retrieve a task (with the specified activity ARN) scheduled for execution by a running state machine.
`Future<GetExecutionHistoryResult>`	`getExecutionHistoryAsync(GetExecutionHistoryRequest request)` Returns the history of the specified execution as a list of events.
`Future<GetExecutionHistoryResult>`	`getExecutionHistoryAsync(GetExecutionHistoryRequest request, AsyncHandler<GetExecutionHistoryRequest,GetExecutionHistoryResult> asyncHandler)` Returns the history of the specified execution as a list of events.
`ExecutorService`	`getExecutorService()` Returns the executor service used by this client to execute async requests.
`Future<ListActivitiesResult>`	`listActivitiesAsync(ListActivitiesRequest request)` Lists the existing activities.
`Future<ListActivitiesResult>`	`listActivitiesAsync(ListActivitiesRequest request, AsyncHandler<ListActivitiesRequest,ListActivitiesResult> asyncHandler)` Lists the existing activities.
`Future<ListExecutionsResult>`	`listExecutionsAsync(ListExecutionsRequest request)` Lists the executions of a state machine that meet the filtering criteria.
`Future<ListExecutionsResult>`	`listExecutionsAsync(ListExecutionsRequest request, AsyncHandler<ListExecutionsRequest,ListExecutionsResult> asyncHandler)` Lists the executions of a state machine that meet the filtering criteria.
`Future<ListStateMachinesResult>`	`listStateMachinesAsync(ListStateMachinesRequest request)` Lists the existing state machines.
`Future<ListStateMachinesResult>`	`listStateMachinesAsync(ListStateMachinesRequest request, AsyncHandler<ListStateMachinesRequest,ListStateMachinesResult> asyncHandler)` Lists the existing state machines.
`Future<SendTaskFailureResult>`	`sendTaskFailureAsync(SendTaskFailureRequest request)` Used by workers to report that the task identified by the `taskToken` failed.
`Future<SendTaskFailureResult>`	`sendTaskFailureAsync(SendTaskFailureRequest request, AsyncHandler<SendTaskFailureRequest,SendTaskFailureResult> asyncHandler)` Used by workers to report that the task identified by the `taskToken` failed.
`Future<SendTaskHeartbeatResult>`	`sendTaskHeartbeatAsync(SendTaskHeartbeatRequest request)` Used by workers to report to the service that the task represented by the specified `taskToken` is still making progress.
`Future<SendTaskHeartbeatResult>`	`sendTaskHeartbeatAsync(SendTaskHeartbeatRequest request, AsyncHandler<SendTaskHeartbeatRequest,SendTaskHeartbeatResult> asyncHandler)` Used by workers to report to the service that the task represented by the specified `taskToken` is still making progress.
`Future<SendTaskSuccessResult>`	`sendTaskSuccessAsync(SendTaskSuccessRequest request)` Used by workers to report that the task identified by the `taskToken` completed successfully.
`Future<SendTaskSuccessResult>`	`sendTaskSuccessAsync(SendTaskSuccessRequest request, AsyncHandler<SendTaskSuccessRequest,SendTaskSuccessResult> asyncHandler)` Used by workers to report that the task identified by the `taskToken` completed successfully.
`void`	`shutdown()` Shuts down the client, releasing all managed resources.
`Future<StartExecutionResult>`	`startExecutionAsync(StartExecutionRequest request)` Starts a state machine execution.
`Future<StartExecutionResult>`	`startExecutionAsync(StartExecutionRequest request, AsyncHandler<StartExecutionRequest,StartExecutionResult> asyncHandler)` Starts a state machine execution.
`Future<StopExecutionResult>`	`stopExecutionAsync(StopExecutionRequest request)` Stops an execution.
`Future<StopExecutionResult>`	`stopExecutionAsync(StopExecutionRequest request, AsyncHandler<StopExecutionRequest,StopExecutionResult> asyncHandler)` Stops an execution.

Methods inherited from class com.amazonaws.services.stepfunctions.AWSStepFunctionsClient
createActivity, createStateMachine, deleteActivity, deleteStateMachine, describeActivity, describeExecution, describeStateMachine, getActivityTask, getCachedResponseMetadata, getExecutionHistory, listActivities, listExecutions, listStateMachines, sendTaskFailure, sendTaskHeartbeat, sendTaskSuccess, startExecution, stopExecution

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerProvider, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.stepfunctions.AWSStepFunctions
createActivity, createStateMachine, deleteActivity, deleteStateMachine, describeActivity, describeExecution, describeStateMachine, getActivityTask, getCachedResponseMetadata, getExecutionHistory, listActivities, listExecutions, listStateMachines, sendTaskFailure, sendTaskHeartbeat, sendTaskSuccess, setEndpoint, setRegion, startExecution, stopExecution

- Constructor Detail
  - AWSStepFunctionsAsyncClient
```
public AWSStepFunctionsAsyncClient()
```
    Constructs a new asynchronous client to invoke service methods on AWS SFN. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
    See Also:
    
    DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)
  - AWSStepFunctionsAsyncClient
```
public AWSStepFunctionsAsyncClient(ClientConfiguration clientConfiguration)
```
    Constructs a new asynchronous client to invoke service methods on AWS SFN. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
    Parameters:
    
    clientConfiguration - The client configuration options controlling how this client connects to AWS SFN (ex: proxy settings, retry counts, etc).
    
    See Also:
    
    DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)
  - AWSStepFunctionsAsyncClient
```
public AWSStepFunctionsAsyncClient(AWSCredentials awsCredentials)
```
    Constructs a new asynchronous client to invoke service methods on AWS SFN using the specified AWS account credentials.
    Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
    
    Parameters:
    
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
    
    See Also:
    
    Executors.newFixedThreadPool(int)
  - AWSStepFunctionsAsyncClient
```
public AWSStepFunctionsAsyncClient(AWSCredentials awsCredentials,
                                   ExecutorService executorService)
```
    Constructs a new asynchronous client to invoke service methods on AWS SFN using the specified AWS account credentials and executor service. Default client settings will be used.
    
    Parameters:
    
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
    
    executorService - The executor service by which all asynchronous requests will be executed.
  - AWSStepFunctionsAsyncClient
```
public AWSStepFunctionsAsyncClient(AWSCredentials awsCredentials,
                                   ClientConfiguration clientConfiguration,
                                   ExecutorService executorService)
```
    Constructs a new asynchronous client to invoke service methods on AWS SFN using the specified AWS account credentials, executor service, and client configuration options.
    
    Parameters:
    
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
    
    clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).
    
    executorService - The executor service by which all asynchronous requests will be executed.
  - AWSStepFunctionsAsyncClient
```
public AWSStepFunctionsAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
```
    Constructs a new asynchronous client to invoke service methods on AWS SFN using the specified AWS account credentials provider. Default client settings will be used.
    Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    
    See Also:
    
    Executors.newFixedThreadPool(int)
  - AWSStepFunctionsAsyncClient
```
public AWSStepFunctionsAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                   ClientConfiguration clientConfiguration)
```
    Constructs a new asynchronous client to invoke service methods on AWS SFN using the provided AWS account credentials provider and client configuration options.
    Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    
    clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).
    
    See Also:
    
    DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)
  - AWSStepFunctionsAsyncClient
```
public AWSStepFunctionsAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                   ExecutorService executorService)
```
    Constructs a new asynchronous client to invoke service methods on AWS SFN using the specified AWS account credentials provider and executor service. Default client settings will be used.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    
    executorService - The executor service by which all asynchronous requests will be executed.
  - AWSStepFunctionsAsyncClient
```
public AWSStepFunctionsAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                   ClientConfiguration clientConfiguration,
                                   ExecutorService executorService)
```
    Constructs a new asynchronous client to invoke service methods on AWS SFN using the specified AWS account credentials provider, executor service, and client configuration options.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    
    clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).
    
    executorService - The executor service by which all asynchronous requests will be executed.
- Method Detail
  - getExecutorService
```
public ExecutorService getExecutorService()
```
    Returns the executor service used by this client to execute async requests.
    
    Returns:
    
    The executor service used by this client to execute async requests.
  - createActivityAsync
```
public Future<CreateActivityResult> createActivityAsync(CreateActivityRequest request)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    Creates an activity.
    
    Specified by:
    
    createActivityAsync in interface AWSStepFunctionsAsync
    
    Returns:
    
    A Java Future containing the result of the CreateActivity operation returned by the service.
  - createActivityAsync
```
public Future<CreateActivityResult> createActivityAsync(CreateActivityRequest request,
                                                        AsyncHandler<CreateActivityRequest,CreateActivityResult> asyncHandler)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    Creates an activity.
    
    Specified by:
    
    createActivityAsync in interface AWSStepFunctionsAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the CreateActivity operation returned by the service.
  - createStateMachineAsync
```
public Future<CreateStateMachineResult> createStateMachineAsync(CreateStateMachineRequest request)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    Creates a state machine.
    
    Specified by:
    
    createStateMachineAsync in interface AWSStepFunctionsAsync
    
    Returns:
    
    A Java Future containing the result of the CreateStateMachine operation returned by the service.
  - createStateMachineAsync
```
public Future<CreateStateMachineResult> createStateMachineAsync(CreateStateMachineRequest request,
                                                                AsyncHandler<CreateStateMachineRequest,CreateStateMachineResult> asyncHandler)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    Creates a state machine.
    
    Specified by:
    
    createStateMachineAsync in interface AWSStepFunctionsAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the CreateStateMachine operation returned by the service.
  - deleteActivityAsync
```
public Future<DeleteActivityResult> deleteActivityAsync(DeleteActivityRequest request)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    Deletes an activity.
    
    Specified by:
    
    deleteActivityAsync in interface AWSStepFunctionsAsync
    
    Returns:
    
    A Java Future containing the result of the DeleteActivity operation returned by the service.
  - deleteActivityAsync
```
public Future<DeleteActivityResult> deleteActivityAsync(DeleteActivityRequest request,
                                                        AsyncHandler<DeleteActivityRequest,DeleteActivityResult> asyncHandler)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    Deletes an activity.
    
    Specified by:
    
    deleteActivityAsync in interface AWSStepFunctionsAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the DeleteActivity operation returned by the service.
  - deleteStateMachineAsync
```
public Future<DeleteStateMachineResult> deleteStateMachineAsync(DeleteStateMachineRequest request)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    Deletes a state machine. This is an asynchronous operation-- it sets the state machine's status to "DELETING" and begins the delete process.
    
    Specified by:
    
    deleteStateMachineAsync in interface AWSStepFunctionsAsync
    
    Returns:
    
    A Java Future containing the result of the DeleteStateMachine operation returned by the service.
  - deleteStateMachineAsync
```
public Future<DeleteStateMachineResult> deleteStateMachineAsync(DeleteStateMachineRequest request,
                                                                AsyncHandler<DeleteStateMachineRequest,DeleteStateMachineResult> asyncHandler)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    Deletes a state machine. This is an asynchronous operation-- it sets the state machine's status to "DELETING" and begins the delete process.
    
    Specified by:
    
    deleteStateMachineAsync in interface AWSStepFunctionsAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the DeleteStateMachine operation returned by the service.
  - describeActivityAsync
```
public Future<DescribeActivityResult> describeActivityAsync(DescribeActivityRequest request)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    Describes an activity.
    
    Specified by:
    
    describeActivityAsync in interface AWSStepFunctionsAsync
    
    Returns:
    
    A Java Future containing the result of the DescribeActivity operation returned by the service.
  - describeActivityAsync
```
public Future<DescribeActivityResult> describeActivityAsync(DescribeActivityRequest request,
                                                            AsyncHandler<DescribeActivityRequest,DescribeActivityResult> asyncHandler)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    Describes an activity.
    
    Specified by:
    
    describeActivityAsync in interface AWSStepFunctionsAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the DescribeActivity operation returned by the service.
  - describeExecutionAsync
```
public Future<DescribeExecutionResult> describeExecutionAsync(DescribeExecutionRequest request)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    Describes an execution.
    
    Specified by:
    
    describeExecutionAsync in interface AWSStepFunctionsAsync
    
    Returns:
    
    A Java Future containing the result of the DescribeExecution operation returned by the service.
  - describeExecutionAsync
```
public Future<DescribeExecutionResult> describeExecutionAsync(DescribeExecutionRequest request,
                                                              AsyncHandler<DescribeExecutionRequest,DescribeExecutionResult> asyncHandler)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    Describes an execution.
    
    Specified by:
    
    describeExecutionAsync in interface AWSStepFunctionsAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the DescribeExecution operation returned by the service.
  - describeStateMachineAsync
```
public Future<DescribeStateMachineResult> describeStateMachineAsync(DescribeStateMachineRequest request)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    Describes a state machine.
    
    Specified by:
    
    describeStateMachineAsync in interface AWSStepFunctionsAsync
    
    Returns:
    
    A Java Future containing the result of the DescribeStateMachine operation returned by the service.
  - describeStateMachineAsync
```
public Future<DescribeStateMachineResult> describeStateMachineAsync(DescribeStateMachineRequest request,
                                                                    AsyncHandler<DescribeStateMachineRequest,DescribeStateMachineResult> asyncHandler)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    Describes a state machine.
    
    Specified by:
    
    describeStateMachineAsync in interface AWSStepFunctionsAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the DescribeStateMachine operation returned by the service.
  - getActivityTaskAsync
```
public Future<GetActivityTaskResult> getActivityTaskAsync(GetActivityTaskRequest request)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    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).
    
    Specified by:
    
    getActivityTaskAsync in interface AWSStepFunctionsAsync
    
    Returns:
    
    A Java Future containing the result of the GetActivityTask operation returned by the service.
  - getActivityTaskAsync
```
public Future<GetActivityTaskResult> getActivityTaskAsync(GetActivityTaskRequest request,
                                                          AsyncHandler<GetActivityTaskRequest,GetActivityTaskResult> asyncHandler)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    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).
    
    Specified by:
    
    getActivityTaskAsync in interface AWSStepFunctionsAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the GetActivityTask operation returned by the service.
  - getExecutionHistoryAsync
```
public Future<GetExecutionHistoryResult> getExecutionHistoryAsync(GetExecutionHistoryRequest request)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    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.
    
    Specified by:
    
    getExecutionHistoryAsync in interface AWSStepFunctionsAsync
    
    Returns:
    
    A Java Future containing the result of the GetExecutionHistory operation returned by the service.
  - getExecutionHistoryAsync
```
public Future<GetExecutionHistoryResult> getExecutionHistoryAsync(GetExecutionHistoryRequest request,
                                                                  AsyncHandler<GetExecutionHistoryRequest,GetExecutionHistoryResult> asyncHandler)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    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.
    
    Specified by:
    
    getExecutionHistoryAsync in interface AWSStepFunctionsAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the GetExecutionHistory operation returned by the service.
  - listActivitiesAsync
```
public Future<ListActivitiesResult> listActivitiesAsync(ListActivitiesRequest request)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    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.
    
    Specified by:
    
    listActivitiesAsync in interface AWSStepFunctionsAsync
    
    Returns:
    
    A Java Future containing the result of the ListActivities operation returned by the service.
  - listActivitiesAsync
```
public Future<ListActivitiesResult> listActivitiesAsync(ListActivitiesRequest request,
                                                        AsyncHandler<ListActivitiesRequest,ListActivitiesResult> asyncHandler)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    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.
    
    Specified by:
    
    listActivitiesAsync in interface AWSStepFunctionsAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the ListActivities operation returned by the service.
  - listExecutionsAsync
```
public Future<ListExecutionsResult> listExecutionsAsync(ListExecutionsRequest request)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    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.
    
    Specified by:
    
    listExecutionsAsync in interface AWSStepFunctionsAsync
    
    Returns:
    
    A Java Future containing the result of the ListExecutions operation returned by the service.
  - listExecutionsAsync
```
public Future<ListExecutionsResult> listExecutionsAsync(ListExecutionsRequest request,
                                                        AsyncHandler<ListExecutionsRequest,ListExecutionsResult> asyncHandler)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    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.
    
    Specified by:
    
    listExecutionsAsync in interface AWSStepFunctionsAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the ListExecutions operation returned by the service.
  - listStateMachinesAsync
```
public Future<ListStateMachinesResult> listStateMachinesAsync(ListStateMachinesRequest request)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    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.
    
    Specified by:
    
    listStateMachinesAsync in interface AWSStepFunctionsAsync
    
    Returns:
    
    A Java Future containing the result of the ListStateMachines operation returned by the service.
  - listStateMachinesAsync
```
public Future<ListStateMachinesResult> listStateMachinesAsync(ListStateMachinesRequest request,
                                                              AsyncHandler<ListStateMachinesRequest,ListStateMachinesResult> asyncHandler)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    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.
    
    Specified by:
    
    listStateMachinesAsync in interface AWSStepFunctionsAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the ListStateMachines operation returned by the service.
  - sendTaskFailureAsync
```
public Future<SendTaskFailureResult> sendTaskFailureAsync(SendTaskFailureRequest request)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    Used by workers to report that the task identified by the taskToken failed.
    
    Specified by:
    
    sendTaskFailureAsync in interface AWSStepFunctionsAsync
    
    Returns:
    
    A Java Future containing the result of the SendTaskFailure operation returned by the service.
  - sendTaskFailureAsync
```
public Future<SendTaskFailureResult> sendTaskFailureAsync(SendTaskFailureRequest request,
                                                          AsyncHandler<SendTaskFailureRequest,SendTaskFailureResult> asyncHandler)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    Used by workers to report that the task identified by the taskToken failed.
    
    Specified by:
    
    sendTaskFailureAsync in interface AWSStepFunctionsAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the SendTaskFailure operation returned by the service.
  - sendTaskHeartbeatAsync
```
public Future<SendTaskHeartbeatResult> sendTaskHeartbeatAsync(SendTaskHeartbeatRequest request)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    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.
    
    Specified by:
    
    sendTaskHeartbeatAsync in interface AWSStepFunctionsAsync
    
    Returns:
    
    A Java Future containing the result of the SendTaskHeartbeat operation returned by the service.
  - sendTaskHeartbeatAsync
```
public Future<SendTaskHeartbeatResult> sendTaskHeartbeatAsync(SendTaskHeartbeatRequest request,
                                                              AsyncHandler<SendTaskHeartbeatRequest,SendTaskHeartbeatResult> asyncHandler)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    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.
    
    Specified by:
    
    sendTaskHeartbeatAsync in interface AWSStepFunctionsAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the SendTaskHeartbeat operation returned by the service.
  - sendTaskSuccessAsync
```
public Future<SendTaskSuccessResult> sendTaskSuccessAsync(SendTaskSuccessRequest request)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    Used by workers to report that the task identified by the taskToken completed successfully.
    
    Specified by:
    
    sendTaskSuccessAsync in interface AWSStepFunctionsAsync
    
    Returns:
    
    A Java Future containing the result of the SendTaskSuccess operation returned by the service.
  - sendTaskSuccessAsync
```
public Future<SendTaskSuccessResult> sendTaskSuccessAsync(SendTaskSuccessRequest request,
                                                          AsyncHandler<SendTaskSuccessRequest,SendTaskSuccessResult> asyncHandler)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    Used by workers to report that the task identified by the taskToken completed successfully.
    
    Specified by:
    
    sendTaskSuccessAsync in interface AWSStepFunctionsAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the SendTaskSuccess operation returned by the service.
  - startExecutionAsync
```
public Future<StartExecutionResult> startExecutionAsync(StartExecutionRequest request)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    Starts a state machine execution.
    
    Specified by:
    
    startExecutionAsync in interface AWSStepFunctionsAsync
    
    Returns:
    
    A Java Future containing the result of the StartExecution operation returned by the service.
  - startExecutionAsync
```
public Future<StartExecutionResult> startExecutionAsync(StartExecutionRequest request,
                                                        AsyncHandler<StartExecutionRequest,StartExecutionResult> asyncHandler)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    Starts a state machine execution.
    
    Specified by:
    
    startExecutionAsync in interface AWSStepFunctionsAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the StartExecution operation returned by the service.
  - stopExecutionAsync
```
public Future<StopExecutionResult> stopExecutionAsync(StopExecutionRequest request)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    Stops an execution.
    
    Specified by:
    
    stopExecutionAsync in interface AWSStepFunctionsAsync
    
    Returns:
    
    A Java Future containing the result of the StopExecution operation returned by the service.
  - stopExecutionAsync
```
public Future<StopExecutionResult> stopExecutionAsync(StopExecutionRequest request,
                                                      AsyncHandler<StopExecutionRequest,StopExecutionResult> asyncHandler)
```
    Description copied from interface: AWSStepFunctionsAsync
    
    Stops an execution.
    
    Specified by:
    
    stopExecutionAsync in interface AWSStepFunctionsAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the StopExecution operation returned by the service.
  - shutdown
```
public void shutdown()
```
    Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.
    
    Specified by:
    
    shutdown in interface AWSStepFunctions
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Class AWSStepFunctionsAsyncClient

Field Summary

Fields inherited from class com.amazonaws.services.stepfunctions.AWSStepFunctionsClient

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.stepfunctions.AWSStepFunctions

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.services.stepfunctions.AWSStepFunctionsClient

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.services.stepfunctions.AWSStepFunctions

Constructor Detail

AWSStepFunctionsAsyncClient

AWSStepFunctionsAsyncClient

AWSStepFunctionsAsyncClient

AWSStepFunctionsAsyncClient

AWSStepFunctionsAsyncClient

AWSStepFunctionsAsyncClient

AWSStepFunctionsAsyncClient

AWSStepFunctionsAsyncClient

AWSStepFunctionsAsyncClient

Method Detail

getExecutorService

createActivityAsync

createActivityAsync

createStateMachineAsync

createStateMachineAsync

deleteActivityAsync

deleteActivityAsync

deleteStateMachineAsync

deleteStateMachineAsync

describeActivityAsync

describeActivityAsync

describeExecutionAsync

describeExecutionAsync

describeStateMachineAsync

describeStateMachineAsync

getActivityTaskAsync

getActivityTaskAsync

getExecutionHistoryAsync

getExecutionHistoryAsync

listActivitiesAsync

listActivitiesAsync

listExecutionsAsync

listExecutionsAsync

listStateMachinesAsync

listStateMachinesAsync

sendTaskFailureAsync

sendTaskFailureAsync

sendTaskHeartbeatAsync

sendTaskHeartbeatAsync

sendTaskSuccessAsync

sendTaskSuccessAsync

startExecutionAsync

startExecutionAsync

stopExecutionAsync

stopExecutionAsync

shutdown