@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 in order and as expected, every time. Step Functions logs the state of each step, so you can diagnose and debug problems quickly.
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, getActivityTask, getCachedResponseMetadata, getExecutionHistory, listActivities, listExecutions, listStateMachines, sendTaskFailure, sendTaskHeartbeat, sendTaskSuccess, setEndpoint, setRegion, shutdown, startExecution, stopExecutionFuture<CreateActivityResult> createActivityAsync(CreateActivityRequest createActivityRequest)
Creates an activity. An Activity is a task which you write, in any language and hosted on any machine which has
access to AWS Step Functions. Activities must poll Step Functions using the GetActivityTask and
respond using SendTask* API calls. 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 language and hosted on any machine which has
access to AWS Step Functions. Activities must poll Step Functions using the GetActivityTask and
respond using SendTask* API calls. 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 which states to transition to 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 which states to transition to 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 delete process. Each state machine execution will be deleted the next time it makes a state transition. After all executions have completed or been deleted, the state machine itself will be 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 delete process. Each state machine execution will be deleted the next time it makes a state transition. After all executions have completed or been deleted, the state machine itself will be 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<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 will return 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 will return 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. The results may be split into multiple pages. To retrieve subsequent pages, make the
call again using the nextToken returned by the previous call.
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. The results may be split into multiple pages. To retrieve subsequent pages, make the
call again using the nextToken returned by the previous call.
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. The results may be split into multiple pages. To retrieve subsequent pages, make
the call again using the nextToken returned by the previous call.
listActivitiesRequest - Future<ListActivitiesResult> listActivitiesAsync(ListActivitiesRequest listActivitiesRequest, AsyncHandler<ListActivitiesRequest,ListActivitiesResult> asyncHandler)
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.
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. The results may be split into multiple
pages. To retrieve subsequent pages, make the call again using the nextToken returned by the
previous call.
listExecutionsRequest - Future<ListExecutionsResult> listExecutionsAsync(ListExecutionsRequest listExecutionsRequest, AsyncHandler<ListExecutionsRequest,ListExecutionsResult> asyncHandler)
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.
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. The results may be split into multiple pages. To retrieve subsequent pages,
make the call again using the nextToken returned by the previous call.
listStateMachinesRequest - Future<ListStateMachinesResult> listStateMachinesAsync(ListStateMachinesRequest listStateMachinesRequest, AsyncHandler<ListStateMachinesRequest,ListStateMachinesResult> asyncHandler)
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.
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 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.
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 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.
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.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.