@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSStepFunctionsAsyncClient extends AWSStepFunctionsClient implements AWSStepFunctionsAsync
AsyncHandler can be used to receive notification when
an asynchronous operation completes.
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).
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AWSStepFunctionsAsyncClient()
Deprecated.
|
AWSStepFunctionsAsyncClient(AWSCredentials awsCredentials)
Deprecated.
|
AWSStepFunctionsAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AWSStepFunctionsAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
|
AWSStepFunctionsAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSStepFunctionsAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSStepFunctionsAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AWSStepFunctionsAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
|
AWSStepFunctionsAsyncClient(ClientConfiguration clientConfiguration)
Deprecated.
|
builder, createActivity, createStateMachine, deleteActivity, deleteStateMachine, describeActivity, describeExecution, describeStateMachine, getActivityTask, getCachedResponseMetadata, getExecutionHistory, listActivities, listExecutions, listStateMachines, sendTaskFailure, sendTaskHeartbeat, sendTaskSuccess, startExecution, stopExecutionaddRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcreateActivity, createStateMachine, deleteActivity, deleteStateMachine, describeActivity, describeExecution, describeStateMachine, getActivityTask, getCachedResponseMetadata, getExecutionHistory, listActivities, listExecutions, listStateMachines, sendTaskFailure, sendTaskHeartbeat, sendTaskSuccess, setEndpoint, setRegion, startExecution, stopExecution@Deprecated public AWSStepFunctionsAsyncClient()
AWSStepFunctionsAsyncClientBuilder.defaultClient()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).
@Deprecated public AWSStepFunctionsAsyncClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
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().
clientConfiguration - The client configuration options controlling how this client connects to AWS SFN (ex: proxy settings,
retry counts, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)@Deprecated public AWSStepFunctionsAsyncClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)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).
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.Executors.newFixedThreadPool(int)@Deprecated public AWSStepFunctionsAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)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.@Deprecated public AWSStepFunctionsAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)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.@Deprecated public AWSStepFunctionsAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)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).
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.Executors.newFixedThreadPool(int)@Deprecated public AWSStepFunctionsAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
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().
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).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)@Deprecated public AWSStepFunctionsAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)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.@Deprecated public AWSStepFunctionsAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)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.public static AWSStepFunctionsAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CreateActivityResult> createActivityAsync(CreateActivityRequest request)
AWSStepFunctionsAsyncCreates an activity.
createActivityAsync in interface AWSStepFunctionsAsyncpublic Future<CreateActivityResult> createActivityAsync(CreateActivityRequest request, AsyncHandler<CreateActivityRequest,CreateActivityResult> asyncHandler)
AWSStepFunctionsAsyncCreates an activity.
createActivityAsync in interface AWSStepFunctionsAsyncasyncHandler - 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.public Future<CreateStateMachineResult> createStateMachineAsync(CreateStateMachineRequest request)
AWSStepFunctionsAsyncCreates a state machine.
createStateMachineAsync in interface AWSStepFunctionsAsyncpublic Future<CreateStateMachineResult> createStateMachineAsync(CreateStateMachineRequest request, AsyncHandler<CreateStateMachineRequest,CreateStateMachineResult> asyncHandler)
AWSStepFunctionsAsyncCreates a state machine.
createStateMachineAsync in interface AWSStepFunctionsAsyncasyncHandler - 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.public Future<DeleteActivityResult> deleteActivityAsync(DeleteActivityRequest request)
AWSStepFunctionsAsyncDeletes an activity.
deleteActivityAsync in interface AWSStepFunctionsAsyncpublic Future<DeleteActivityResult> deleteActivityAsync(DeleteActivityRequest request, AsyncHandler<DeleteActivityRequest,DeleteActivityResult> asyncHandler)
AWSStepFunctionsAsyncDeletes an activity.
deleteActivityAsync in interface AWSStepFunctionsAsyncasyncHandler - 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.public Future<DeleteStateMachineResult> deleteStateMachineAsync(DeleteStateMachineRequest request)
AWSStepFunctionsAsyncDeletes a state machine. This is an asynchronous operation-- it sets the state machine's status to "DELETING" and begins the delete process.
deleteStateMachineAsync in interface AWSStepFunctionsAsyncpublic Future<DeleteStateMachineResult> deleteStateMachineAsync(DeleteStateMachineRequest request, AsyncHandler<DeleteStateMachineRequest,DeleteStateMachineResult> asyncHandler)
AWSStepFunctionsAsyncDeletes a state machine. This is an asynchronous operation-- it sets the state machine's status to "DELETING" and begins the delete process.
deleteStateMachineAsync in interface AWSStepFunctionsAsyncasyncHandler - 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.public Future<DescribeActivityResult> describeActivityAsync(DescribeActivityRequest request)
AWSStepFunctionsAsyncDescribes an activity.
describeActivityAsync in interface AWSStepFunctionsAsyncpublic Future<DescribeActivityResult> describeActivityAsync(DescribeActivityRequest request, AsyncHandler<DescribeActivityRequest,DescribeActivityResult> asyncHandler)
AWSStepFunctionsAsyncDescribes an activity.
describeActivityAsync in interface AWSStepFunctionsAsyncasyncHandler - 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.public Future<DescribeExecutionResult> describeExecutionAsync(DescribeExecutionRequest request)
AWSStepFunctionsAsyncDescribes an execution.
describeExecutionAsync in interface AWSStepFunctionsAsyncpublic Future<DescribeExecutionResult> describeExecutionAsync(DescribeExecutionRequest request, AsyncHandler<DescribeExecutionRequest,DescribeExecutionResult> asyncHandler)
AWSStepFunctionsAsyncDescribes an execution.
describeExecutionAsync in interface AWSStepFunctionsAsyncasyncHandler - 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.public Future<DescribeStateMachineResult> describeStateMachineAsync(DescribeStateMachineRequest request)
AWSStepFunctionsAsyncDescribes a state machine.
describeStateMachineAsync in interface AWSStepFunctionsAsyncpublic Future<DescribeStateMachineResult> describeStateMachineAsync(DescribeStateMachineRequest request, AsyncHandler<DescribeStateMachineRequest,DescribeStateMachineResult> asyncHandler)
AWSStepFunctionsAsyncDescribes a state machine.
describeStateMachineAsync in interface AWSStepFunctionsAsyncasyncHandler - 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.public Future<GetActivityTaskResult> getActivityTaskAsync(GetActivityTaskRequest request)
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).
getActivityTaskAsync in interface AWSStepFunctionsAsyncpublic Future<GetActivityTaskResult> getActivityTaskAsync(GetActivityTaskRequest request, AsyncHandler<GetActivityTaskRequest,GetActivityTaskResult> asyncHandler)
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).
getActivityTaskAsync in interface AWSStepFunctionsAsyncasyncHandler - 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.public Future<GetExecutionHistoryResult> getExecutionHistoryAsync(GetExecutionHistoryRequest request)
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.
getExecutionHistoryAsync in interface AWSStepFunctionsAsyncpublic Future<GetExecutionHistoryResult> getExecutionHistoryAsync(GetExecutionHistoryRequest request, AsyncHandler<GetExecutionHistoryRequest,GetExecutionHistoryResult> asyncHandler)
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.
getExecutionHistoryAsync in interface AWSStepFunctionsAsyncasyncHandler - 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.public Future<ListActivitiesResult> listActivitiesAsync(ListActivitiesRequest request)
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.
listActivitiesAsync in interface AWSStepFunctionsAsyncpublic Future<ListActivitiesResult> listActivitiesAsync(ListActivitiesRequest request, AsyncHandler<ListActivitiesRequest,ListActivitiesResult> asyncHandler)
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.
listActivitiesAsync in interface AWSStepFunctionsAsyncasyncHandler - 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.public Future<ListExecutionsResult> listExecutionsAsync(ListExecutionsRequest request)
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.
listExecutionsAsync in interface AWSStepFunctionsAsyncpublic Future<ListExecutionsResult> listExecutionsAsync(ListExecutionsRequest request, AsyncHandler<ListExecutionsRequest,ListExecutionsResult> asyncHandler)
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.
listExecutionsAsync in interface AWSStepFunctionsAsyncasyncHandler - 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.public Future<ListStateMachinesResult> listStateMachinesAsync(ListStateMachinesRequest request)
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.
listStateMachinesAsync in interface AWSStepFunctionsAsyncpublic Future<ListStateMachinesResult> listStateMachinesAsync(ListStateMachinesRequest request, AsyncHandler<ListStateMachinesRequest,ListStateMachinesResult> asyncHandler)
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.
listStateMachinesAsync in interface AWSStepFunctionsAsyncasyncHandler - 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.public Future<SendTaskFailureResult> sendTaskFailureAsync(SendTaskFailureRequest request)
AWSStepFunctionsAsync
Used by workers to report that the task identified by the taskToken failed.
sendTaskFailureAsync in interface AWSStepFunctionsAsyncpublic Future<SendTaskFailureResult> sendTaskFailureAsync(SendTaskFailureRequest request, AsyncHandler<SendTaskFailureRequest,SendTaskFailureResult> asyncHandler)
AWSStepFunctionsAsync
Used by workers to report that the task identified by the taskToken failed.
sendTaskFailureAsync in interface AWSStepFunctionsAsyncasyncHandler - 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.public Future<SendTaskHeartbeatResult> sendTaskHeartbeatAsync(SendTaskHeartbeatRequest request)
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.
sendTaskHeartbeatAsync in interface AWSStepFunctionsAsyncpublic Future<SendTaskHeartbeatResult> sendTaskHeartbeatAsync(SendTaskHeartbeatRequest request, AsyncHandler<SendTaskHeartbeatRequest,SendTaskHeartbeatResult> asyncHandler)
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.
sendTaskHeartbeatAsync in interface AWSStepFunctionsAsyncasyncHandler - 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.public Future<SendTaskSuccessResult> sendTaskSuccessAsync(SendTaskSuccessRequest request)
AWSStepFunctionsAsync
Used by workers to report that the task identified by the taskToken completed successfully.
sendTaskSuccessAsync in interface AWSStepFunctionsAsyncpublic Future<SendTaskSuccessResult> sendTaskSuccessAsync(SendTaskSuccessRequest request, AsyncHandler<SendTaskSuccessRequest,SendTaskSuccessResult> asyncHandler)
AWSStepFunctionsAsync
Used by workers to report that the task identified by the taskToken completed successfully.
sendTaskSuccessAsync in interface AWSStepFunctionsAsyncasyncHandler - 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.public Future<StartExecutionResult> startExecutionAsync(StartExecutionRequest request)
AWSStepFunctionsAsyncStarts a state machine execution.
startExecutionAsync in interface AWSStepFunctionsAsyncpublic Future<StartExecutionResult> startExecutionAsync(StartExecutionRequest request, AsyncHandler<StartExecutionRequest,StartExecutionResult> asyncHandler)
AWSStepFunctionsAsyncStarts a state machine execution.
startExecutionAsync in interface AWSStepFunctionsAsyncasyncHandler - 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.public Future<StopExecutionResult> stopExecutionAsync(StopExecutionRequest request)
AWSStepFunctionsAsyncStops an execution.
stopExecutionAsync in interface AWSStepFunctionsAsyncpublic Future<StopExecutionResult> stopExecutionAsync(StopExecutionRequest request, AsyncHandler<StopExecutionRequest,StopExecutionResult> asyncHandler)
AWSStepFunctionsAsyncStops an execution.
stopExecutionAsync in interface AWSStepFunctionsAsyncasyncHandler - 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.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AWSStepFunctionsshutdown in class AmazonWebServiceClientCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.