@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| Modifier | Constructor and Description |
|---|---|
protected |
AbstractAWSStepFunctionsAsync() |
createActivity, createStateMachine, deleteActivity, deleteStateMachine, describeActivity, describeExecution, describeStateMachine, describeStateMachineForExecution, getActivityTask, getCachedResponseMetadata, getExecutionHistory, listActivities, listExecutions, listStateMachines, sendTaskFailure, sendTaskHeartbeat, sendTaskSuccess, setEndpoint, setRegion, shutdown, startExecution, stopExecution, updateStateMachineclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcreateActivity, createStateMachine, deleteActivity, deleteStateMachine, describeActivity, describeExecution, describeStateMachine, describeStateMachineForExecution, getActivityTask, getCachedResponseMetadata, getExecutionHistory, listActivities, listExecutions, listStateMachines, sendTaskFailure, sendTaskHeartbeat, sendTaskSuccess, setEndpoint, setRegion, shutdown, startExecution, stopExecution, updateStateMachinepublic Future<CreateActivityResult> createActivityAsync(CreateActivityRequest request)
AWSStepFunctionsAsync
Creates an activity. An activity is a task that you write in any programming language and host on any machine
that 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 AWSStepFunctionsAsyncpublic Future<CreateActivityResult> createActivityAsync(CreateActivityRequest request, AsyncHandler<CreateActivityRequest,CreateActivityResult> asyncHandler)
AWSStepFunctionsAsync
Creates an activity. An activity is a task that you write in any programming language and host on any machine
that 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 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)
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 AWSStepFunctionsAsyncpublic 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 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)
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 AWSStepFunctionsAsyncpublic 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 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.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
describeActivityAsync in interface AWSStepFunctionsAsyncpublic Future<DescribeActivityResult> describeActivityAsync(DescribeActivityRequest request, AsyncHandler<DescribeActivityRequest,DescribeActivityResult> asyncHandler)
AWSStepFunctionsAsyncDescribes an activity.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
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.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
describeExecutionAsync in interface AWSStepFunctionsAsyncpublic Future<DescribeExecutionResult> describeExecutionAsync(DescribeExecutionRequest request, AsyncHandler<DescribeExecutionRequest,DescribeExecutionResult> asyncHandler)
AWSStepFunctionsAsyncDescribes an execution.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
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.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
describeStateMachineAsync in interface AWSStepFunctionsAsyncpublic Future<DescribeStateMachineResult> describeStateMachineAsync(DescribeStateMachineRequest request, AsyncHandler<DescribeStateMachineRequest,DescribeStateMachineResult> asyncHandler)
AWSStepFunctionsAsyncDescribes a state machine.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
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<DescribeStateMachineForExecutionResult> describeStateMachineForExecutionAsync(DescribeStateMachineForExecutionRequest request)
AWSStepFunctionsAsyncDescribes the state machine associated with a specific execution.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
describeStateMachineForExecutionAsync in interface AWSStepFunctionsAsyncpublic Future<DescribeStateMachineForExecutionResult> describeStateMachineForExecutionAsync(DescribeStateMachineForExecutionRequest request, AsyncHandler<DescribeStateMachineForExecutionRequest,DescribeStateMachineForExecutionResult> asyncHandler)
AWSStepFunctionsAsyncDescribes the state machine associated with a specific execution.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
describeStateMachineForExecutionAsync 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) 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).
Polling with GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling
for Activity Tasks in the Step Functions Developer Guide.
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) 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).
Polling with GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling
for Activity Tasks in the Step Functions Developer Guide.
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.
If nextToken is returned, there are more results available. The value of nextToken is a
unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination
token will return an HTTP 400 InvalidToken error.
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.
If nextToken is returned, there are more results available. The value of nextToken is a
unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination
token will return an HTTP 400 InvalidToken error.
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)
AWSStepFunctionsAsyncLists the existing activities.
If nextToken is returned, there are more results available. The value of nextToken is a
unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination
token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
listActivitiesAsync in interface AWSStepFunctionsAsyncpublic Future<ListActivitiesResult> listActivitiesAsync(ListActivitiesRequest request, AsyncHandler<ListActivitiesRequest,ListActivitiesResult> asyncHandler)
AWSStepFunctionsAsyncLists the existing activities.
If nextToken is returned, there are more results available. The value of nextToken is a
unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination
token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
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)
AWSStepFunctionsAsyncLists the executions of a state machine that meet the filtering criteria. Results are sorted by time, with the most recent execution first.
If nextToken is returned, there are more results available. The value of nextToken is a
unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination
token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
listExecutionsAsync in interface AWSStepFunctionsAsyncpublic Future<ListExecutionsResult> listExecutionsAsync(ListExecutionsRequest request, AsyncHandler<ListExecutionsRequest,ListExecutionsResult> asyncHandler)
AWSStepFunctionsAsyncLists the executions of a state machine that meet the filtering criteria. Results are sorted by time, with the most recent execution first.
If nextToken is returned, there are more results available. The value of nextToken is a
unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination
token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
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)
AWSStepFunctionsAsyncLists the existing state machines.
If nextToken is returned, there are more results available. The value of nextToken is a
unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination
token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
listStateMachinesAsync in interface AWSStepFunctionsAsyncpublic Future<ListStateMachinesResult> listStateMachinesAsync(ListStateMachinesRequest request, AsyncHandler<ListStateMachinesRequest,ListStateMachinesResult> asyncHandler)
AWSStepFunctionsAsyncLists the existing state machines.
If nextToken is returned, there are more results available. The value of nextToken is a
unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination
token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
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 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 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 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 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.
StartExecution is idempotent. If StartExecution is called with the same name and input
as a running execution, the call will succeed and return the same response as the original request. If the
execution is closed or if the input is different, it will return a 400 ExecutionAlreadyExists error.
Names can be reused after 90 days.
startExecutionAsync in interface AWSStepFunctionsAsyncpublic Future<StartExecutionResult> startExecutionAsync(StartExecutionRequest request, AsyncHandler<StartExecutionRequest,StartExecutionResult> asyncHandler)
AWSStepFunctionsAsyncStarts a state machine execution.
StartExecution is idempotent. If StartExecution is called with the same name and input
as a running execution, the call will succeed and return the same response as the original request. If the
execution is closed or if the input is different, it will return a 400 ExecutionAlreadyExists error.
Names can be reused after 90 days.
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 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. You must include
at least one of definition or roleArn or you will receive a
MissingRequiredParameter error.
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.
updateStateMachineAsync in interface AWSStepFunctionsAsyncpublic 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. You must include
at least one of definition or roleArn or you will receive a
MissingRequiredParameter error.
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.
updateStateMachineAsync 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.Copyright © 2018. All rights reserved.