@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSStepFunctionsAsync extends AbstractAWSStepFunctions implements AWSStepFunctionsAsync
AWSStepFunctionsAsync
. Convenient method forms pass through to the corresponding
overload that takes a request object and an AsyncHandler
, which throws an
UnsupportedOperationException
.ENDPOINT_PREFIX
createActivity, createStateMachine, deleteActivity, deleteStateMachine, describeActivity, describeExecution, describeStateMachine, describeStateMachineForExecution, getActivityTask, getCachedResponseMetadata, getExecutionHistory, listActivities, listExecutions, listStateMachines, sendTaskFailure, sendTaskHeartbeat, sendTaskSuccess, setEndpoint, setRegion, shutdown, startExecution, stopExecution, updateStateMachine
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createActivity, createStateMachine, deleteActivity, deleteStateMachine, describeActivity, describeExecution, describeStateMachine, describeStateMachineForExecution, getActivityTask, getCachedResponseMetadata, getExecutionHistory, listActivities, listExecutions, listStateMachines, sendTaskFailure, sendTaskHeartbeat, sendTaskSuccess, setEndpoint, setRegion, shutdown, startExecution, stopExecution, updateStateMachine
public Future<CreateActivityResult> createActivityAsync(CreateActivityRequest request)
AWSStepFunctionsAsync
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.
createActivityAsync
in interface AWSStepFunctionsAsync
public Future<CreateActivityResult> createActivityAsync(CreateActivityRequest request, AsyncHandler<CreateActivityRequest,CreateActivityResult> asyncHandler)
AWSStepFunctionsAsync
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.
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.public Future<CreateStateMachineResult> createStateMachineAsync(CreateStateMachineRequest request)
AWSStepFunctionsAsync
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.
createStateMachineAsync
in interface AWSStepFunctionsAsync
public Future<CreateStateMachineResult> createStateMachineAsync(CreateStateMachineRequest request, AsyncHandler<CreateStateMachineRequest,CreateStateMachineResult> asyncHandler)
AWSStepFunctionsAsync
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.
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.public Future<DeleteActivityResult> deleteActivityAsync(DeleteActivityRequest request)
AWSStepFunctionsAsync
Deletes an activity.
deleteActivityAsync
in interface AWSStepFunctionsAsync
public Future<DeleteActivityResult> deleteActivityAsync(DeleteActivityRequest request, AsyncHandler<DeleteActivityRequest,DeleteActivityResult> asyncHandler)
AWSStepFunctionsAsync
Deletes an activity.
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.public Future<DeleteStateMachineResult> deleteStateMachineAsync(DeleteStateMachineRequest request)
AWSStepFunctionsAsync
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.
deleteStateMachineAsync
in interface AWSStepFunctionsAsync
public Future<DeleteStateMachineResult> deleteStateMachineAsync(DeleteStateMachineRequest request, AsyncHandler<DeleteStateMachineRequest,DeleteStateMachineResult> asyncHandler)
AWSStepFunctionsAsync
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.
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.public Future<DescribeActivityResult> describeActivityAsync(DescribeActivityRequest request)
AWSStepFunctionsAsync
Describes an activity.
describeActivityAsync
in interface AWSStepFunctionsAsync
public Future<DescribeActivityResult> describeActivityAsync(DescribeActivityRequest request, AsyncHandler<DescribeActivityRequest,DescribeActivityResult> asyncHandler)
AWSStepFunctionsAsync
Describes an activity.
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.public Future<DescribeExecutionResult> describeExecutionAsync(DescribeExecutionRequest request)
AWSStepFunctionsAsync
Describes an execution.
describeExecutionAsync
in interface AWSStepFunctionsAsync
public Future<DescribeExecutionResult> describeExecutionAsync(DescribeExecutionRequest request, AsyncHandler<DescribeExecutionRequest,DescribeExecutionResult> asyncHandler)
AWSStepFunctionsAsync
Describes an execution.
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.public Future<DescribeStateMachineResult> describeStateMachineAsync(DescribeStateMachineRequest request)
AWSStepFunctionsAsync
Describes a state machine.
describeStateMachineAsync
in interface AWSStepFunctionsAsync
public Future<DescribeStateMachineResult> describeStateMachineAsync(DescribeStateMachineRequest request, AsyncHandler<DescribeStateMachineRequest,DescribeStateMachineResult> asyncHandler)
AWSStepFunctionsAsync
Describes a state machine.
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.public Future<DescribeStateMachineForExecutionResult> describeStateMachineForExecutionAsync(DescribeStateMachineForExecutionRequest request)
AWSStepFunctionsAsync
Describes the state machine associated with a specific execution.
describeStateMachineForExecutionAsync
in interface AWSStepFunctionsAsync
public Future<DescribeStateMachineForExecutionResult> describeStateMachineForExecutionAsync(DescribeStateMachineForExecutionRequest request, AsyncHandler<DescribeStateMachineForExecutionRequest,DescribeStateMachineForExecutionResult> asyncHandler)
AWSStepFunctionsAsync
Describes the state machine associated with a specific execution.
describeStateMachineForExecutionAsync
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.public Future<GetActivityTaskResult> getActivityTaskAsync(GetActivityTaskRequest request)
AWSStepFunctionsAsync
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).
getActivityTaskAsync
in interface AWSStepFunctionsAsync
public Future<GetActivityTaskResult> getActivityTaskAsync(GetActivityTaskRequest request, AsyncHandler<GetActivityTaskRequest,GetActivityTaskResult> asyncHandler)
AWSStepFunctionsAsync
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).
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.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.
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.
getExecutionHistoryAsync
in interface AWSStepFunctionsAsync
public 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.
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.
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.public Future<ListActivitiesResult> listActivitiesAsync(ListActivitiesRequest request)
AWSStepFunctionsAsync
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.
listActivitiesAsync
in interface AWSStepFunctionsAsync
public Future<ListActivitiesResult> listActivitiesAsync(ListActivitiesRequest request, AsyncHandler<ListActivitiesRequest,ListActivitiesResult> asyncHandler)
AWSStepFunctionsAsync
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.
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.public Future<ListExecutionsResult> listExecutionsAsync(ListExecutionsRequest request)
AWSStepFunctionsAsync
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.
listExecutionsAsync
in interface AWSStepFunctionsAsync
public Future<ListExecutionsResult> listExecutionsAsync(ListExecutionsRequest request, AsyncHandler<ListExecutionsRequest,ListExecutionsResult> asyncHandler)
AWSStepFunctionsAsync
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.
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.public Future<ListStateMachinesResult> listStateMachinesAsync(ListStateMachinesRequest request)
AWSStepFunctionsAsync
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.
listStateMachinesAsync
in interface AWSStepFunctionsAsync
public Future<ListStateMachinesResult> listStateMachinesAsync(ListStateMachinesRequest request, AsyncHandler<ListStateMachinesRequest,ListStateMachinesResult> asyncHandler)
AWSStepFunctionsAsync
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.
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.public Future<SendTaskFailureResult> sendTaskFailureAsync(SendTaskFailureRequest request)
AWSStepFunctionsAsync
Used by workers to report that the task identified by the taskToken
failed.
sendTaskFailureAsync
in interface AWSStepFunctionsAsync
public 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 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.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 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.
sendTaskHeartbeatAsync
in interface AWSStepFunctionsAsync
public 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 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.
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.public Future<SendTaskSuccessResult> sendTaskSuccessAsync(SendTaskSuccessRequest request)
AWSStepFunctionsAsync
Used by workers to report that the task identified by the taskToken
completed successfully.
sendTaskSuccessAsync
in interface AWSStepFunctionsAsync
public 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 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.public Future<StartExecutionResult> startExecutionAsync(StartExecutionRequest request)
AWSStepFunctionsAsync
Starts a state machine execution.
startExecutionAsync
in interface AWSStepFunctionsAsync
public Future<StartExecutionResult> startExecutionAsync(StartExecutionRequest request, AsyncHandler<StartExecutionRequest,StartExecutionResult> asyncHandler)
AWSStepFunctionsAsync
Starts a state machine execution.
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.public Future<StopExecutionResult> stopExecutionAsync(StopExecutionRequest request)
AWSStepFunctionsAsync
Stops an execution.
stopExecutionAsync
in interface AWSStepFunctionsAsync
public Future<StopExecutionResult> stopExecutionAsync(StopExecutionRequest request, AsyncHandler<StopExecutionRequest,StopExecutionResult> asyncHandler)
AWSStepFunctionsAsync
Stops an execution.
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.public Future<UpdateStateMachineResult> updateStateMachineAsync(UpdateStateMachineRequest request)
AWSStepFunctionsAsync
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.
updateStateMachineAsync
in interface AWSStepFunctionsAsync
public Future<UpdateStateMachineResult> updateStateMachineAsync(UpdateStateMachineRequest request, AsyncHandler<UpdateStateMachineRequest,UpdateStateMachineResult> asyncHandler)
AWSStepFunctionsAsync
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.
updateStateMachineAsync
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.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.