@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSStepFunctionsAsync extends AWSStepFunctions
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSStepFunctionsAsync instead.
AWS Step Functions is a service that lets you coordinate the components of distributed applications and microservices using visual workflows.
You can use Step Functions to build applications from individual components, each of which performs a discrete function, or task, allowing you to scale and change applications quickly. Step Functions provides a console that helps visualize the components of your application as a series of steps. Step Functions automatically triggers and tracks each step, and retries steps when there are errors, so your application executes predictably and in the right order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any issues.
Step Functions manages operations and underlying infrastructure to ensure your application is available at any scale. You can run tasks on AWS, your own servers, or any system that has access to AWS. You can access and use Step Functions using the console, the AWS SDKs, or an HTTP API. For more information about Step Functions, see the AWS Step Functions Developer Guide .
ENDPOINT_PREFIXcreateActivity, createStateMachine, deleteActivity, deleteStateMachine, describeActivity, describeExecution, describeStateMachine, describeStateMachineForExecution, getActivityTask, getCachedResponseMetadata, getExecutionHistory, listActivities, listExecutions, listStateMachines, sendTaskFailure, sendTaskHeartbeat, sendTaskSuccess, setEndpoint, setRegion, shutdown, startExecution, stopExecution, updateStateMachineFuture<CreateActivityResult> createActivityAsync(CreateActivityRequest createActivityRequest)
Creates an activity. An activity is a task which you write in any programming language and host on any machine
which has access to AWS Step Functions. Activities must poll Step Functions using the
GetActivityTask API action and respond using SendTask* API actions. This function lets
Step Functions know the existence of your activity and returns an identifier for use in a state machine and when
polling from the activity.
createActivityRequest - Future<CreateActivityResult> createActivityAsync(CreateActivityRequest createActivityRequest, AsyncHandler<CreateActivityRequest,CreateActivityResult> asyncHandler)
Creates an activity. An activity is a task which you write in any programming language and host on any machine
which has access to AWS Step Functions. Activities must poll Step Functions using the
GetActivityTask API action and respond using SendTask* API actions. This function lets
Step Functions know the existence of your activity and returns an identifier for use in a state machine and when
polling from the activity.
createActivityRequest - 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.Future<CreateStateMachineResult> createStateMachineAsync(CreateStateMachineRequest createStateMachineRequest)
Creates a state machine. A state machine consists of a collection of states that can do work (Task
states), determine to which states to transition next (Choice states), stop an execution with an
error (Fail states), and so on. State machines are specified using a JSON-based, structured
language.
createStateMachineRequest - Future<CreateStateMachineResult> createStateMachineAsync(CreateStateMachineRequest createStateMachineRequest, AsyncHandler<CreateStateMachineRequest,CreateStateMachineResult> asyncHandler)
Creates a state machine. A state machine consists of a collection of states that can do work (Task
states), determine to which states to transition next (Choice states), stop an execution with an
error (Fail states), and so on. State machines are specified using a JSON-based, structured
language.
createStateMachineRequest - 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.Future<DeleteActivityResult> deleteActivityAsync(DeleteActivityRequest deleteActivityRequest)
Deletes an activity.
deleteActivityRequest - Future<DeleteActivityResult> deleteActivityAsync(DeleteActivityRequest deleteActivityRequest, AsyncHandler<DeleteActivityRequest,DeleteActivityResult> asyncHandler)
Deletes an activity.
deleteActivityRequest - 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.Future<DeleteStateMachineResult> deleteStateMachineAsync(DeleteStateMachineRequest deleteStateMachineRequest)
Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to
DELETING and begins the deletion process. Each state machine execution is deleted the next time it
makes a state transition.
The state machine itself is deleted after all executions are completed or deleted.
deleteStateMachineRequest - Future<DeleteStateMachineResult> deleteStateMachineAsync(DeleteStateMachineRequest deleteStateMachineRequest, AsyncHandler<DeleteStateMachineRequest,DeleteStateMachineResult> asyncHandler)
Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to
DELETING and begins the deletion process. Each state machine execution is deleted the next time it
makes a state transition.
The state machine itself is deleted after all executions are completed or deleted.
deleteStateMachineRequest - 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.Future<DescribeActivityResult> describeActivityAsync(DescribeActivityRequest describeActivityRequest)
Describes an activity.
describeActivityRequest - Future<DescribeActivityResult> describeActivityAsync(DescribeActivityRequest describeActivityRequest, AsyncHandler<DescribeActivityRequest,DescribeActivityResult> asyncHandler)
Describes an activity.
describeActivityRequest - 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.Future<DescribeExecutionResult> describeExecutionAsync(DescribeExecutionRequest describeExecutionRequest)
Describes an execution.
describeExecutionRequest - Future<DescribeExecutionResult> describeExecutionAsync(DescribeExecutionRequest describeExecutionRequest, AsyncHandler<DescribeExecutionRequest,DescribeExecutionResult> asyncHandler)
Describes an execution.
describeExecutionRequest - 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.Future<DescribeStateMachineResult> describeStateMachineAsync(DescribeStateMachineRequest describeStateMachineRequest)
Describes a state machine.
describeStateMachineRequest - Future<DescribeStateMachineResult> describeStateMachineAsync(DescribeStateMachineRequest describeStateMachineRequest, AsyncHandler<DescribeStateMachineRequest,DescribeStateMachineResult> asyncHandler)
Describes a state machine.
describeStateMachineRequest - 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.Future<DescribeStateMachineForExecutionResult> describeStateMachineForExecutionAsync(DescribeStateMachineForExecutionRequest describeStateMachineForExecutionRequest)
Describes the state machine associated with a specific execution.
describeStateMachineForExecutionRequest - Future<DescribeStateMachineForExecutionResult> describeStateMachineForExecutionAsync(DescribeStateMachineForExecutionRequest describeStateMachineForExecutionRequest, AsyncHandler<DescribeStateMachineForExecutionRequest,DescribeStateMachineForExecutionResult> asyncHandler)
Describes the state machine associated with a specific execution.
describeStateMachineForExecutionRequest - 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.Future<GetActivityTaskResult> getActivityTaskAsync(GetActivityTaskRequest getActivityTaskRequest)
Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a
running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds
as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the
service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the
poll returns a taskToken with a null string.
Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request).
getActivityTaskRequest - Future<GetActivityTaskResult> getActivityTaskAsync(GetActivityTaskRequest getActivityTaskRequest, AsyncHandler<GetActivityTaskRequest,GetActivityTaskResult> asyncHandler)
Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a
running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds
as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the
service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the
poll returns a taskToken with a null string.
Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request).
getActivityTaskRequest - 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.Future<GetExecutionHistoryResult> getExecutionHistoryAsync(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.
If a nextToken is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken. Keep all other
arguments unchanged.
getExecutionHistoryRequest - Future<GetExecutionHistoryResult> getExecutionHistoryAsync(GetExecutionHistoryRequest getExecutionHistoryRequest, AsyncHandler<GetExecutionHistoryRequest,GetExecutionHistoryResult> asyncHandler)
Returns the history of the specified execution as a list of events. By default, the results are returned in
ascending order of the timeStamp of the events. Use the reverseOrder parameter to get
the latest events first.
If a nextToken is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken. Keep all other
arguments unchanged.
getExecutionHistoryRequest - 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.Future<ListActivitiesResult> listActivitiesAsync(ListActivitiesRequest listActivitiesRequest)
Lists the existing activities.
If a nextToken is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken. Keep all other
arguments unchanged.
listActivitiesRequest - Future<ListActivitiesResult> listActivitiesAsync(ListActivitiesRequest listActivitiesRequest, AsyncHandler<ListActivitiesRequest,ListActivitiesResult> asyncHandler)
Lists the existing activities.
If a nextToken is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken. Keep all other
arguments unchanged.
listActivitiesRequest - 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.Future<ListExecutionsResult> listExecutionsAsync(ListExecutionsRequest listExecutionsRequest)
Lists the executions of a state machine that meet the filtering criteria.
If a nextToken is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken. Keep all other
arguments unchanged.
listExecutionsRequest - Future<ListExecutionsResult> listExecutionsAsync(ListExecutionsRequest listExecutionsRequest, AsyncHandler<ListExecutionsRequest,ListExecutionsResult> asyncHandler)
Lists the executions of a state machine that meet the filtering criteria.
If a nextToken is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken. Keep all other
arguments unchanged.
listExecutionsRequest - 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.Future<ListStateMachinesResult> listStateMachinesAsync(ListStateMachinesRequest listStateMachinesRequest)
Lists the existing state machines.
If a nextToken is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken. Keep all other
arguments unchanged.
listStateMachinesRequest - Future<ListStateMachinesResult> listStateMachinesAsync(ListStateMachinesRequest listStateMachinesRequest, AsyncHandler<ListStateMachinesRequest,ListStateMachinesResult> asyncHandler)
Lists the existing state machines.
If a nextToken is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken. Keep all other
arguments unchanged.
listStateMachinesRequest - 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.Future<SendTaskFailureResult> sendTaskFailureAsync(SendTaskFailureRequest sendTaskFailureRequest)
Used by workers to report that the task identified by the taskToken failed.
sendTaskFailureRequest - Future<SendTaskFailureResult> sendTaskFailureAsync(SendTaskFailureRequest sendTaskFailureRequest, AsyncHandler<SendTaskFailureRequest,SendTaskFailureResult> asyncHandler)
Used by workers to report that the task identified by the taskToken failed.
sendTaskFailureRequest - 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.Future<SendTaskHeartbeatResult> sendTaskHeartbeatAsync(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 contains an
ActivityTimedOut event.
The Timeout of a task, defined in the state machine's Amazon States Language definition, is its
maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received.
This operation is only useful for long-lived tasks to report the liveliness of the task.
sendTaskHeartbeatRequest - Future<SendTaskHeartbeatResult> sendTaskHeartbeatAsync(SendTaskHeartbeatRequest sendTaskHeartbeatRequest, AsyncHandler<SendTaskHeartbeatRequest,SendTaskHeartbeatResult> asyncHandler)
Used by workers to report to the service that the task represented by the specified taskToken is
still making progress. This action resets the Heartbeat clock. The Heartbeat threshold
is specified in the state machine's Amazon States Language definition. This action does not in itself create an
event in the execution history. However, if the task times out, the execution history contains an
ActivityTimedOut event.
The Timeout of a task, defined in the state machine's Amazon States Language definition, is its
maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received.
This operation is only useful for long-lived tasks to report the liveliness of the task.
sendTaskHeartbeatRequest - 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.Future<SendTaskSuccessResult> sendTaskSuccessAsync(SendTaskSuccessRequest sendTaskSuccessRequest)
Used by workers to report that the task identified by the taskToken completed successfully.
sendTaskSuccessRequest - Future<SendTaskSuccessResult> sendTaskSuccessAsync(SendTaskSuccessRequest sendTaskSuccessRequest, AsyncHandler<SendTaskSuccessRequest,SendTaskSuccessResult> asyncHandler)
Used by workers to report that the task identified by the taskToken completed successfully.
sendTaskSuccessRequest - 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.Future<StartExecutionResult> startExecutionAsync(StartExecutionRequest startExecutionRequest)
Starts a state machine execution.
startExecutionRequest - Future<StartExecutionResult> startExecutionAsync(StartExecutionRequest startExecutionRequest, AsyncHandler<StartExecutionRequest,StartExecutionResult> asyncHandler)
Starts a state machine execution.
startExecutionRequest - 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.Future<StopExecutionResult> stopExecutionAsync(StopExecutionRequest stopExecutionRequest)
Stops an execution.
stopExecutionRequest - Future<StopExecutionResult> stopExecutionAsync(StopExecutionRequest stopExecutionRequest, AsyncHandler<StopExecutionRequest,StopExecutionResult> asyncHandler)
Stops an execution.
stopExecutionRequest - 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.Future<UpdateStateMachineResult> updateStateMachineAsync(UpdateStateMachineRequest updateStateMachineRequest)
Updates an existing state machine by modifying its definition and/or roleArn. Running
executions will continue to use the previous definition and roleArn.
All StartExecution calls within a few seconds will use the updated definition and
roleArn. Executions started immediately after calling UpdateStateMachine may use the
previous state machine definition and roleArn. You must include at least one of
definition or roleArn or you will receive a MissingRequiredParameter
error.
updateStateMachineRequest - Future<UpdateStateMachineResult> updateStateMachineAsync(UpdateStateMachineRequest updateStateMachineRequest, AsyncHandler<UpdateStateMachineRequest,UpdateStateMachineResult> asyncHandler)
Updates an existing state machine by modifying its definition and/or roleArn. Running
executions will continue to use the previous definition and roleArn.
All StartExecution calls within a few seconds will use the updated definition and
roleArn. Executions started immediately after calling UpdateStateMachine may use the
previous state machine definition and roleArn. You must include at least one of
definition or roleArn or you will receive a MissingRequiredParameter
error.
updateStateMachineRequest - 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.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.