@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface SfnAsyncClient extends SdkClient
builder() method.
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 .
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static SfnAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
SfnAsyncClient. |
static SfnAsyncClient |
create()
Create a
SfnAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateActivityResponse> |
createActivity(Consumer<CreateActivityRequest.Builder> createActivityRequest)
Creates an activity.
|
default CompletableFuture<CreateActivityResponse> |
createActivity(CreateActivityRequest createActivityRequest)
Creates an activity.
|
default CompletableFuture<CreateStateMachineResponse> |
createStateMachine(Consumer<CreateStateMachineRequest.Builder> createStateMachineRequest)
Creates a state machine.
|
default CompletableFuture<CreateStateMachineResponse> |
createStateMachine(CreateStateMachineRequest createStateMachineRequest)
Creates a state machine.
|
default CompletableFuture<DeleteActivityResponse> |
deleteActivity(Consumer<DeleteActivityRequest.Builder> deleteActivityRequest)
Deletes an activity.
|
default CompletableFuture<DeleteActivityResponse> |
deleteActivity(DeleteActivityRequest deleteActivityRequest)
Deletes an activity.
|
default CompletableFuture<DeleteStateMachineResponse> |
deleteStateMachine(Consumer<DeleteStateMachineRequest.Builder> deleteStateMachineRequest)
Deletes a state machine.
|
default CompletableFuture<DeleteStateMachineResponse> |
deleteStateMachine(DeleteStateMachineRequest deleteStateMachineRequest)
Deletes a state machine.
|
default CompletableFuture<DescribeActivityResponse> |
describeActivity(Consumer<DescribeActivityRequest.Builder> describeActivityRequest)
Describes an activity.
|
default CompletableFuture<DescribeActivityResponse> |
describeActivity(DescribeActivityRequest describeActivityRequest)
Describes an activity.
|
default CompletableFuture<DescribeExecutionResponse> |
describeExecution(Consumer<DescribeExecutionRequest.Builder> describeExecutionRequest)
Describes an execution.
|
default CompletableFuture<DescribeExecutionResponse> |
describeExecution(DescribeExecutionRequest describeExecutionRequest)
Describes an execution.
|
default CompletableFuture<DescribeStateMachineResponse> |
describeStateMachine(Consumer<DescribeStateMachineRequest.Builder> describeStateMachineRequest)
Describes a state machine.
|
default CompletableFuture<DescribeStateMachineResponse> |
describeStateMachine(DescribeStateMachineRequest describeStateMachineRequest)
Describes a state machine.
|
default CompletableFuture<DescribeStateMachineForExecutionResponse> |
describeStateMachineForExecution(Consumer<DescribeStateMachineForExecutionRequest.Builder> describeStateMachineForExecutionRequest)
Describes the state machine associated with a specific execution.
|
default CompletableFuture<DescribeStateMachineForExecutionResponse> |
describeStateMachineForExecution(DescribeStateMachineForExecutionRequest describeStateMachineForExecutionRequest)
Describes the state machine associated with a specific execution.
|
default CompletableFuture<GetActivityTaskResponse> |
getActivityTask(Consumer<GetActivityTaskRequest.Builder> getActivityTaskRequest)
Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a
running state machine.
|
default CompletableFuture<GetActivityTaskResponse> |
getActivityTask(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.
|
default CompletableFuture<GetExecutionHistoryResponse> |
getExecutionHistory(Consumer<GetExecutionHistoryRequest.Builder> getExecutionHistoryRequest)
Returns the history of the specified execution as a list of events.
|
default CompletableFuture<GetExecutionHistoryResponse> |
getExecutionHistory(GetExecutionHistoryRequest getExecutionHistoryRequest)
Returns the history of the specified execution as a list of events.
|
default GetExecutionHistoryPublisher |
getExecutionHistoryPaginator(Consumer<GetExecutionHistoryRequest.Builder> getExecutionHistoryRequest)
Returns the history of the specified execution as a list of events.
|
default GetExecutionHistoryPublisher |
getExecutionHistoryPaginator(GetExecutionHistoryRequest getExecutionHistoryRequest)
Returns the history of the specified execution as a list of events.
|
default CompletableFuture<ListActivitiesResponse> |
listActivities()
Lists the existing activities.
|
default CompletableFuture<ListActivitiesResponse> |
listActivities(Consumer<ListActivitiesRequest.Builder> listActivitiesRequest)
Lists the existing activities.
|
default CompletableFuture<ListActivitiesResponse> |
listActivities(ListActivitiesRequest listActivitiesRequest)
Lists the existing activities.
|
default ListActivitiesPublisher |
listActivitiesPaginator()
Lists the existing activities.
|
default ListActivitiesPublisher |
listActivitiesPaginator(Consumer<ListActivitiesRequest.Builder> listActivitiesRequest)
Lists the existing activities.
|
default ListActivitiesPublisher |
listActivitiesPaginator(ListActivitiesRequest listActivitiesRequest)
Lists the existing activities.
|
default CompletableFuture<ListExecutionsResponse> |
listExecutions(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)
Lists the executions of a state machine that meet the filtering criteria.
|
default CompletableFuture<ListExecutionsResponse> |
listExecutions(ListExecutionsRequest listExecutionsRequest)
Lists the executions of a state machine that meet the filtering criteria.
|
default ListExecutionsPublisher |
listExecutionsPaginator(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)
Lists the executions of a state machine that meet the filtering criteria.
|
default ListExecutionsPublisher |
listExecutionsPaginator(ListExecutionsRequest listExecutionsRequest)
Lists the executions of a state machine that meet the filtering criteria.
|
default CompletableFuture<ListStateMachinesResponse> |
listStateMachines()
Lists the existing state machines.
|
default CompletableFuture<ListStateMachinesResponse> |
listStateMachines(Consumer<ListStateMachinesRequest.Builder> listStateMachinesRequest)
Lists the existing state machines.
|
default CompletableFuture<ListStateMachinesResponse> |
listStateMachines(ListStateMachinesRequest listStateMachinesRequest)
Lists the existing state machines.
|
default ListStateMachinesPublisher |
listStateMachinesPaginator()
Lists the existing state machines.
|
default ListStateMachinesPublisher |
listStateMachinesPaginator(Consumer<ListStateMachinesRequest.Builder> listStateMachinesRequest)
Lists the existing state machines.
|
default ListStateMachinesPublisher |
listStateMachinesPaginator(ListStateMachinesRequest listStateMachinesRequest)
Lists the existing state machines.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
List tags for a given resource.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List tags for a given resource.
|
default CompletableFuture<SendTaskFailureResponse> |
sendTaskFailure(Consumer<SendTaskFailureRequest.Builder> sendTaskFailureRequest)
Used by activity workers and task states using the callback pattern to report that the task identified by the
taskToken failed. |
default CompletableFuture<SendTaskFailureResponse> |
sendTaskFailure(SendTaskFailureRequest sendTaskFailureRequest)
Used by activity workers and task states using the callback pattern to report that the task identified by the
taskToken failed. |
default CompletableFuture<SendTaskHeartbeatResponse> |
sendTaskHeartbeat(Consumer<SendTaskHeartbeatRequest.Builder> sendTaskHeartbeatRequest)
Used by activity workers and task states using the callback pattern to report to Step Functions that the task represented by the specified
taskToken is still making progress. |
default CompletableFuture<SendTaskHeartbeatResponse> |
sendTaskHeartbeat(SendTaskHeartbeatRequest sendTaskHeartbeatRequest)
Used by activity workers and task states using the callback pattern to report to Step Functions that the task represented by the specified
taskToken is still making progress. |
default CompletableFuture<SendTaskSuccessResponse> |
sendTaskSuccess(Consumer<SendTaskSuccessRequest.Builder> sendTaskSuccessRequest)
Used by activity workers and task states using the callback pattern to report that the task identified by the
taskToken completed successfully. |
default CompletableFuture<SendTaskSuccessResponse> |
sendTaskSuccess(SendTaskSuccessRequest sendTaskSuccessRequest)
Used by activity workers and task states using the callback pattern to report that the task identified by the
taskToken completed successfully. |
default CompletableFuture<StartExecutionResponse> |
startExecution(Consumer<StartExecutionRequest.Builder> startExecutionRequest)
Starts a state machine execution.
|
default CompletableFuture<StartExecutionResponse> |
startExecution(StartExecutionRequest startExecutionRequest)
Starts a state machine execution.
|
default CompletableFuture<StartSyncExecutionResponse> |
startSyncExecution(Consumer<StartSyncExecutionRequest.Builder> startSyncExecutionRequest)
Starts a Synchronous Express state machine execution.
|
default CompletableFuture<StartSyncExecutionResponse> |
startSyncExecution(StartSyncExecutionRequest startSyncExecutionRequest)
Starts a Synchronous Express state machine execution.
|
default CompletableFuture<StopExecutionResponse> |
stopExecution(Consumer<StopExecutionRequest.Builder> stopExecutionRequest)
Stops an execution.
|
default CompletableFuture<StopExecutionResponse> |
stopExecution(StopExecutionRequest stopExecutionRequest)
Stops an execution.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Add a tag to a Step Functions resource.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Add a tag to a Step Functions resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Remove a tag from a Step Functions resource
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Remove a tag from a Step Functions resource
|
default CompletableFuture<UpdateStateMachineResponse> |
updateStateMachine(Consumer<UpdateStateMachineRequest.Builder> updateStateMachineRequest)
Updates an existing state machine by modifying its
definition, roleArn, or
loggingConfiguration. |
default CompletableFuture<UpdateStateMachineResponse> |
updateStateMachine(UpdateStateMachineRequest updateStateMachineRequest)
Updates an existing state machine by modifying its
definition, roleArn, or
loggingConfiguration. |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static SfnAsyncClient create()
SfnAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static SfnAsyncClientBuilder builder()
SfnAsyncClient.default CompletableFuture<CreateActivityResponse> createActivity(CreateActivityRequest createActivityRequest)
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.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
CreateActivity is an idempotent API. Subsequent requests won’t create a duplicate resource if it was
already created. CreateActivity's idempotency check is based on the activity name. If a
following request has different tags values, Step Functions will ignore these differences and treat
it as an idempotent request of the previous. In this case, tags will not be updated, even if they
are different.
createActivityRequest - default CompletableFuture<CreateActivityResponse> createActivity(Consumer<CreateActivityRequest.Builder> createActivityRequest)
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.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
CreateActivity is an idempotent API. Subsequent requests won’t create a duplicate resource if it was
already created. CreateActivity's idempotency check is based on the activity name. If a
following request has different tags values, Step Functions will ignore these differences and treat
it as an idempotent request of the previous. In this case, tags will not be updated, even if they
are different.
This is a convenience which creates an instance of the CreateActivityRequest.Builder avoiding the need to
create one manually via CreateActivityRequest.builder()
createActivityRequest - A Consumer that will call methods on CreateActivityInput.Builder to create a request.default CompletableFuture<CreateStateMachineResponse> createStateMachine(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. For more information, see Amazon States
Language in the AWS Step Functions User Guide.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it
was already created. CreateStateMachine's idempotency check is based on the state machine
name, definition, type, LoggingConfiguration and
TracingConfiguration. If a following request has a different roleArn or
tags, Step Functions will ignore these differences and treat it as an idempotent request of the
previous. In this case, roleArn and tags will not be updated, even if they are
different.
createStateMachineRequest - tracingConfiguration key does not match, or
enabled has not been set to true or false.default CompletableFuture<CreateStateMachineResponse> createStateMachine(Consumer<CreateStateMachineRequest.Builder> 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. For more information, see Amazon States
Language in the AWS Step Functions User Guide.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it
was already created. CreateStateMachine's idempotency check is based on the state machine
name, definition, type, LoggingConfiguration and
TracingConfiguration. If a following request has a different roleArn or
tags, Step Functions will ignore these differences and treat it as an idempotent request of the
previous. In this case, roleArn and tags will not be updated, even if they are
different.
This is a convenience which creates an instance of the CreateStateMachineRequest.Builder avoiding the
need to create one manually via CreateStateMachineRequest.builder()
createStateMachineRequest - A Consumer that will call methods on CreateStateMachineInput.Builder to create a request.tracingConfiguration key does not match, or
enabled has not been set to true or false.default CompletableFuture<DeleteActivityResponse> deleteActivity(DeleteActivityRequest deleteActivityRequest)
Deletes an activity.
deleteActivityRequest - default CompletableFuture<DeleteActivityResponse> deleteActivity(Consumer<DeleteActivityRequest.Builder> deleteActivityRequest)
Deletes an activity.
This is a convenience which creates an instance of the DeleteActivityRequest.Builder avoiding the need to
create one manually via DeleteActivityRequest.builder()
deleteActivityRequest - A Consumer that will call methods on DeleteActivityInput.Builder to create a request.default CompletableFuture<DeleteStateMachineResponse> deleteStateMachine(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.
For EXPRESSstate machines, the deletion will happen eventually (usually less than a minute). Running
executions may emit logs after DeleteStateMachine API is called.
deleteStateMachineRequest - default CompletableFuture<DeleteStateMachineResponse> deleteStateMachine(Consumer<DeleteStateMachineRequest.Builder> deleteStateMachineRequest)
Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to
DELETING and begins the deletion process.
For EXPRESSstate machines, the deletion will happen eventually (usually less than a minute). Running
executions may emit logs after DeleteStateMachine API is called.
This is a convenience which creates an instance of the DeleteStateMachineRequest.Builder avoiding the
need to create one manually via DeleteStateMachineRequest.builder()
deleteStateMachineRequest - A Consumer that will call methods on DeleteStateMachineInput.Builder to create a request.default CompletableFuture<DescribeActivityResponse> describeActivity(DescribeActivityRequest describeActivityRequest)
Describes an activity.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
describeActivityRequest - default CompletableFuture<DescribeActivityResponse> describeActivity(Consumer<DescribeActivityRequest.Builder> describeActivityRequest)
Describes an activity.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This is a convenience which creates an instance of the DescribeActivityRequest.Builder avoiding the need
to create one manually via DescribeActivityRequest.builder()
describeActivityRequest - A Consumer that will call methods on DescribeActivityInput.Builder to create a request.default CompletableFuture<DescribeExecutionResponse> describeExecution(DescribeExecutionRequest describeExecutionRequest)
Describes an execution.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machines.
describeExecutionRequest - default CompletableFuture<DescribeExecutionResponse> describeExecution(Consumer<DescribeExecutionRequest.Builder> describeExecutionRequest)
Describes an execution.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machines.
This is a convenience which creates an instance of the DescribeExecutionRequest.Builder avoiding the need
to create one manually via DescribeExecutionRequest.builder()
describeExecutionRequest - A Consumer that will call methods on DescribeExecutionInput.Builder to create a request.default CompletableFuture<DescribeStateMachineResponse> describeStateMachine(DescribeStateMachineRequest describeStateMachineRequest)
Describes a state machine.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
describeStateMachineRequest - default CompletableFuture<DescribeStateMachineResponse> describeStateMachine(Consumer<DescribeStateMachineRequest.Builder> describeStateMachineRequest)
Describes a state machine.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This is a convenience which creates an instance of the DescribeStateMachineRequest.Builder avoiding the
need to create one manually via DescribeStateMachineRequest.builder()
describeStateMachineRequest - A Consumer that will call methods on DescribeStateMachineInput.Builder to create a
request.default CompletableFuture<DescribeStateMachineForExecutionResponse> describeStateMachineForExecution(DescribeStateMachineForExecutionRequest describeStateMachineForExecutionRequest)
Describes 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.
This API action is not supported by EXPRESS state machines.
describeStateMachineForExecutionRequest - default CompletableFuture<DescribeStateMachineForExecutionResponse> describeStateMachineForExecution(Consumer<DescribeStateMachineForExecutionRequest.Builder> describeStateMachineForExecutionRequest)
Describes 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.
This API action is not supported by EXPRESS state machines.
This is a convenience which creates an instance of the DescribeStateMachineForExecutionRequest.Builder
avoiding the need to create one manually via DescribeStateMachineForExecutionRequest.builder()
describeStateMachineForExecutionRequest - A Consumer that will call methods on DescribeStateMachineForExecutionInput.Builder to
create a request.default CompletableFuture<GetActivityTaskResponse> getActivityTask(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).
Polling with GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling
for Activity Tasks in the Step Functions Developer Guide.
getActivityTaskRequest - default CompletableFuture<GetActivityTaskResponse> getActivityTask(Consumer<GetActivityTaskRequest.Builder> 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).
Polling with GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling
for Activity Tasks in the Step Functions Developer Guide.
This is a convenience which creates an instance of the GetActivityTaskRequest.Builder avoiding the need
to create one manually via GetActivityTaskRequest.builder()
getActivityTaskRequest - A Consumer that will call methods on GetActivityTaskInput.Builder to create a request.default CompletableFuture<GetExecutionHistoryResponse> getExecutionHistory(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 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 24 hours. Using an expired pagination
token will return an HTTP 400 InvalidToken error.
This API action is not supported by EXPRESS state machines.
getExecutionHistoryRequest - default CompletableFuture<GetExecutionHistoryResponse> getExecutionHistory(Consumer<GetExecutionHistoryRequest.Builder> 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 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 24 hours. Using an expired pagination
token will return an HTTP 400 InvalidToken error.
This API action is not supported by EXPRESS state machines.
This is a convenience which creates an instance of the GetExecutionHistoryRequest.Builder avoiding the
need to create one manually via GetExecutionHistoryRequest.builder()
getExecutionHistoryRequest - A Consumer that will call methods on GetExecutionHistoryInput.Builder to create a request.default GetExecutionHistoryPublisher getExecutionHistoryPaginator(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 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 24 hours. Using an expired pagination
token will return an HTTP 400 InvalidToken error.
This API action is not supported by EXPRESS state machines.
This is a variant of
getExecutionHistory(software.amazon.awssdk.services.sfn.model.GetExecutionHistoryRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.sfn.paginators.GetExecutionHistoryPublisher publisher = client.getExecutionHistoryPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sfn.paginators.GetExecutionHistoryPublisher publisher = client.getExecutionHistoryPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sfn.model.GetExecutionHistoryResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sfn.model.GetExecutionHistoryResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getExecutionHistory(software.amazon.awssdk.services.sfn.model.GetExecutionHistoryRequest) operation.
getExecutionHistoryRequest - default GetExecutionHistoryPublisher getExecutionHistoryPaginator(Consumer<GetExecutionHistoryRequest.Builder> 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 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 24 hours. Using an expired pagination
token will return an HTTP 400 InvalidToken error.
This API action is not supported by EXPRESS state machines.
This is a variant of
getExecutionHistory(software.amazon.awssdk.services.sfn.model.GetExecutionHistoryRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.sfn.paginators.GetExecutionHistoryPublisher publisher = client.getExecutionHistoryPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sfn.paginators.GetExecutionHistoryPublisher publisher = client.getExecutionHistoryPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sfn.model.GetExecutionHistoryResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sfn.model.GetExecutionHistoryResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getExecutionHistory(software.amazon.awssdk.services.sfn.model.GetExecutionHistoryRequest) operation.
This is a convenience which creates an instance of the GetExecutionHistoryRequest.Builder avoiding the
need to create one manually via GetExecutionHistoryRequest.builder()
getExecutionHistoryRequest - A Consumer that will call methods on GetExecutionHistoryInput.Builder to create a request.default CompletableFuture<ListActivitiesResponse> listActivities(ListActivitiesRequest listActivitiesRequest)
Lists 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 24 hours. 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.
listActivitiesRequest - default CompletableFuture<ListActivitiesResponse> listActivities(Consumer<ListActivitiesRequest.Builder> listActivitiesRequest)
Lists 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 24 hours. 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.
This is a convenience which creates an instance of the ListActivitiesRequest.Builder avoiding the need to
create one manually via ListActivitiesRequest.builder()
listActivitiesRequest - A Consumer that will call methods on ListActivitiesInput.Builder to create a request.default CompletableFuture<ListActivitiesResponse> listActivities()
Lists 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 24 hours. 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.
default ListActivitiesPublisher listActivitiesPaginator()
Lists 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 24 hours. 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.
This is a variant of listActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.sfn.paginators.ListActivitiesPublisher publisher = client.listActivitiesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sfn.paginators.ListActivitiesPublisher publisher = client.listActivitiesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sfn.model.ListActivitiesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sfn.model.ListActivitiesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest) operation.
default ListActivitiesPublisher listActivitiesPaginator(ListActivitiesRequest listActivitiesRequest)
Lists 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 24 hours. 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.
This is a variant of listActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.sfn.paginators.ListActivitiesPublisher publisher = client.listActivitiesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sfn.paginators.ListActivitiesPublisher publisher = client.listActivitiesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sfn.model.ListActivitiesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sfn.model.ListActivitiesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest) operation.
listActivitiesRequest - default ListActivitiesPublisher listActivitiesPaginator(Consumer<ListActivitiesRequest.Builder> listActivitiesRequest)
Lists 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 24 hours. 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.
This is a variant of listActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.sfn.paginators.ListActivitiesPublisher publisher = client.listActivitiesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sfn.paginators.ListActivitiesPublisher publisher = client.listActivitiesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sfn.model.ListActivitiesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sfn.model.ListActivitiesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest) operation.
This is a convenience which creates an instance of the ListActivitiesRequest.Builder avoiding the need to
create one manually via ListActivitiesRequest.builder()
listActivitiesRequest - A Consumer that will call methods on ListActivitiesInput.Builder to create a request.default CompletableFuture<ListExecutionsResponse> listExecutions(ListExecutionsRequest listExecutionsRequest)
Lists 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 24 hours. 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.
This API action is not supported by EXPRESS state machines.
listExecutionsRequest - default CompletableFuture<ListExecutionsResponse> listExecutions(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)
Lists 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 24 hours. 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.
This API action is not supported by EXPRESS state machines.
This is a convenience which creates an instance of the ListExecutionsRequest.Builder avoiding the need to
create one manually via ListExecutionsRequest.builder()
listExecutionsRequest - A Consumer that will call methods on ListExecutionsInput.Builder to create a request.default ListExecutionsPublisher listExecutionsPaginator(ListExecutionsRequest listExecutionsRequest)
Lists 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 24 hours. 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.
This API action is not supported by EXPRESS state machines.
This is a variant of listExecutions(software.amazon.awssdk.services.sfn.model.ListExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.sfn.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sfn.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sfn.model.ListExecutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sfn.model.ListExecutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExecutions(software.amazon.awssdk.services.sfn.model.ListExecutionsRequest) operation.
listExecutionsRequest - default ListExecutionsPublisher listExecutionsPaginator(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)
Lists 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 24 hours. 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.
This API action is not supported by EXPRESS state machines.
This is a variant of listExecutions(software.amazon.awssdk.services.sfn.model.ListExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.sfn.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sfn.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sfn.model.ListExecutionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sfn.model.ListExecutionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExecutions(software.amazon.awssdk.services.sfn.model.ListExecutionsRequest) operation.
This is a convenience which creates an instance of the ListExecutionsRequest.Builder avoiding the need to
create one manually via ListExecutionsRequest.builder()
listExecutionsRequest - A Consumer that will call methods on ListExecutionsInput.Builder to create a request.default CompletableFuture<ListStateMachinesResponse> listStateMachines(ListStateMachinesRequest listStateMachinesRequest)
Lists 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 24 hours. 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.
listStateMachinesRequest - default CompletableFuture<ListStateMachinesResponse> listStateMachines(Consumer<ListStateMachinesRequest.Builder> listStateMachinesRequest)
Lists 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 24 hours. 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.
This is a convenience which creates an instance of the ListStateMachinesRequest.Builder avoiding the need
to create one manually via ListStateMachinesRequest.builder()
listStateMachinesRequest - A Consumer that will call methods on ListStateMachinesInput.Builder to create a request.default CompletableFuture<ListStateMachinesResponse> listStateMachines()
Lists 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 24 hours. 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.
default ListStateMachinesPublisher listStateMachinesPaginator()
Lists 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 24 hours. 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.
This is a variant of
listStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.sfn.paginators.ListStateMachinesPublisher publisher = client.listStateMachinesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sfn.paginators.ListStateMachinesPublisher publisher = client.listStateMachinesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sfn.model.ListStateMachinesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sfn.model.ListStateMachinesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest) operation.
default ListStateMachinesPublisher listStateMachinesPaginator(ListStateMachinesRequest listStateMachinesRequest)
Lists 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 24 hours. 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.
This is a variant of
listStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.sfn.paginators.ListStateMachinesPublisher publisher = client.listStateMachinesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sfn.paginators.ListStateMachinesPublisher publisher = client.listStateMachinesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sfn.model.ListStateMachinesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sfn.model.ListStateMachinesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest) operation.
listStateMachinesRequest - default ListStateMachinesPublisher listStateMachinesPaginator(Consumer<ListStateMachinesRequest.Builder> listStateMachinesRequest)
Lists 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 24 hours. 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.
This is a variant of
listStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.sfn.paginators.ListStateMachinesPublisher publisher = client.listStateMachinesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sfn.paginators.ListStateMachinesPublisher publisher = client.listStateMachinesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sfn.model.ListStateMachinesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sfn.model.ListStateMachinesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest) operation.
This is a convenience which creates an instance of the ListStateMachinesRequest.Builder avoiding the need
to create one manually via ListStateMachinesRequest.builder()
listStateMachinesRequest - A Consumer that will call methods on ListStateMachinesInput.Builder to create a request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List tags for a given resource.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
List tags for a given resource.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceInput.Builder to create a request.default CompletableFuture<SendTaskFailureResponse> sendTaskFailure(SendTaskFailureRequest sendTaskFailureRequest)
Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed.
sendTaskFailureRequest - default CompletableFuture<SendTaskFailureResponse> sendTaskFailure(Consumer<SendTaskFailureRequest.Builder> sendTaskFailureRequest)
Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed.
This is a convenience which creates an instance of the SendTaskFailureRequest.Builder avoiding the need
to create one manually via SendTaskFailureRequest.builder()
sendTaskFailureRequest - A Consumer that will call methods on SendTaskFailureInput.Builder to create a request.default CompletableFuture<SendTaskHeartbeatResponse> sendTaskHeartbeat(SendTaskHeartbeatRequest sendTaskHeartbeatRequest)
Used by activity workers and task states using the callback pattern to report to Step Functions 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 (
HeartbeatSeconds). 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 entry for activities, or a
TaskTimedOut entry for for tasks using the job run or
callback pattern.
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. Use
HeartbeatSeconds to configure the timeout interval for heartbeats.
sendTaskHeartbeatRequest - default CompletableFuture<SendTaskHeartbeatResponse> sendTaskHeartbeat(Consumer<SendTaskHeartbeatRequest.Builder> sendTaskHeartbeatRequest)
Used by activity workers and task states using the callback pattern to report to Step Functions 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 (
HeartbeatSeconds). 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 entry for activities, or a
TaskTimedOut entry for for tasks using the job run or
callback pattern.
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. Use
HeartbeatSeconds to configure the timeout interval for heartbeats.
This is a convenience which creates an instance of the SendTaskHeartbeatRequest.Builder avoiding the need
to create one manually via SendTaskHeartbeatRequest.builder()
sendTaskHeartbeatRequest - A Consumer that will call methods on SendTaskHeartbeatInput.Builder to create a request.default CompletableFuture<SendTaskSuccessResponse> sendTaskSuccess(SendTaskSuccessRequest sendTaskSuccessRequest)
Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken completed successfully.
sendTaskSuccessRequest - default CompletableFuture<SendTaskSuccessResponse> sendTaskSuccess(Consumer<SendTaskSuccessRequest.Builder> sendTaskSuccessRequest)
Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken completed successfully.
This is a convenience which creates an instance of the SendTaskSuccessRequest.Builder avoiding the need
to create one manually via SendTaskSuccessRequest.builder()
sendTaskSuccessRequest - A Consumer that will call methods on SendTaskSuccessInput.Builder to create a request.default CompletableFuture<StartExecutionResponse> startExecution(StartExecutionRequest startExecutionRequest)
Starts 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.
startExecutionRequest - name as another execution
(but a different input).
Executions with the same name and input are considered idempotent.
default CompletableFuture<StartExecutionResponse> startExecution(Consumer<StartExecutionRequest.Builder> startExecutionRequest)
Starts 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.
This is a convenience which creates an instance of the StartExecutionRequest.Builder avoiding the need to
create one manually via StartExecutionRequest.builder()
startExecutionRequest - A Consumer that will call methods on StartExecutionInput.Builder to create a request.name as another execution
(but a different input).
Executions with the same name and input are considered idempotent.
default CompletableFuture<StartSyncExecutionResponse> startSyncExecution(StartSyncExecutionRequest startSyncExecutionRequest)
Starts a Synchronous Express state machine execution.
startSyncExecutionRequest - default CompletableFuture<StartSyncExecutionResponse> startSyncExecution(Consumer<StartSyncExecutionRequest.Builder> startSyncExecutionRequest)
Starts a Synchronous Express state machine execution.
This is a convenience which creates an instance of the StartSyncExecutionRequest.Builder avoiding the
need to create one manually via StartSyncExecutionRequest.builder()
startSyncExecutionRequest - A Consumer that will call methods on StartSyncExecutionInput.Builder to create a request.default CompletableFuture<StopExecutionResponse> stopExecution(StopExecutionRequest stopExecutionRequest)
Stops an execution.
This API action is not supported by EXPRESS state machines.
stopExecutionRequest - default CompletableFuture<StopExecutionResponse> stopExecution(Consumer<StopExecutionRequest.Builder> stopExecutionRequest)
Stops an execution.
This API action is not supported by EXPRESS state machines.
This is a convenience which creates an instance of the StopExecutionRequest.Builder avoiding the need to
create one manually via StopExecutionRequest.builder()
stopExecutionRequest - A Consumer that will call methods on StopExecutionInput.Builder to create a request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Add a tag to a Step Functions resource.
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Add a tag to a Step Functions resource.
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceInput.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Remove a tag from a Step Functions resource
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Remove a tag from a Step Functions resource
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceInput.Builder to create a request.default CompletableFuture<UpdateStateMachineResponse> updateStateMachine(UpdateStateMachineRequest updateStateMachineRequest)
Updates an existing state machine by modifying its definition, roleArn, or
loggingConfiguration. 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.
updateStateMachineRequest - tracingConfiguration key does not match, or
enabled has not been set to true or false.definition and roleArn are not specified.default CompletableFuture<UpdateStateMachineResponse> updateStateMachine(Consumer<UpdateStateMachineRequest.Builder> updateStateMachineRequest)
Updates an existing state machine by modifying its definition, roleArn, or
loggingConfiguration. 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.
This is a convenience which creates an instance of the UpdateStateMachineRequest.Builder avoiding the
need to create one manually via UpdateStateMachineRequest.builder()
updateStateMachineRequest - A Consumer that will call methods on UpdateStateMachineInput.Builder to create a request.tracingConfiguration key does not match, or
enabled has not been set to true or false.definition and roleArn are not specified.Copyright © 2022. All rights reserved.