@Generated(value="software.amazon.awssdk:codegen") public interface SfnClient 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_NAME |
Modifier and Type | Method and Description |
---|---|
static SfnClientBuilder |
builder()
Create a builder that can be used to configure and create a
SfnClient . |
static SfnClient |
create()
Create a
SfnClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateActivityResponse |
createActivity(Consumer<CreateActivityRequest.Builder> createActivityRequest)
Creates an activity.
|
default CreateActivityResponse |
createActivity(CreateActivityRequest createActivityRequest)
Creates an activity.
|
default CreateStateMachineResponse |
createStateMachine(Consumer<CreateStateMachineRequest.Builder> createStateMachineRequest)
Creates a state machine.
|
default CreateStateMachineResponse |
createStateMachine(CreateStateMachineRequest createStateMachineRequest)
Creates a state machine.
|
default DeleteActivityResponse |
deleteActivity(Consumer<DeleteActivityRequest.Builder> deleteActivityRequest)
Deletes an activity.
|
default DeleteActivityResponse |
deleteActivity(DeleteActivityRequest deleteActivityRequest)
Deletes an activity.
|
default DeleteStateMachineResponse |
deleteStateMachine(Consumer<DeleteStateMachineRequest.Builder> deleteStateMachineRequest)
Deletes a state machine.
|
default DeleteStateMachineResponse |
deleteStateMachine(DeleteStateMachineRequest deleteStateMachineRequest)
Deletes a state machine.
|
default DescribeActivityResponse |
describeActivity(Consumer<DescribeActivityRequest.Builder> describeActivityRequest)
Describes an activity.
|
default DescribeActivityResponse |
describeActivity(DescribeActivityRequest describeActivityRequest)
Describes an activity.
|
default DescribeExecutionResponse |
describeExecution(Consumer<DescribeExecutionRequest.Builder> describeExecutionRequest)
Describes an execution.
|
default DescribeExecutionResponse |
describeExecution(DescribeExecutionRequest describeExecutionRequest)
Describes an execution.
|
default DescribeStateMachineResponse |
describeStateMachine(Consumer<DescribeStateMachineRequest.Builder> describeStateMachineRequest)
Describes a state machine.
|
default DescribeStateMachineResponse |
describeStateMachine(DescribeStateMachineRequest describeStateMachineRequest)
Describes a state machine.
|
default DescribeStateMachineForExecutionResponse |
describeStateMachineForExecution(Consumer<DescribeStateMachineForExecutionRequest.Builder> describeStateMachineForExecutionRequest)
Describes the state machine associated with a specific execution.
|
default DescribeStateMachineForExecutionResponse |
describeStateMachineForExecution(DescribeStateMachineForExecutionRequest describeStateMachineForExecutionRequest)
Describes the state machine associated with a specific execution.
|
default 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 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 GetExecutionHistoryResponse |
getExecutionHistory(Consumer<GetExecutionHistoryRequest.Builder> getExecutionHistoryRequest)
Returns the history of the specified execution as a list of events.
|
default GetExecutionHistoryResponse |
getExecutionHistory(GetExecutionHistoryRequest getExecutionHistoryRequest)
Returns the history of the specified execution as a list of events.
|
default GetExecutionHistoryIterable |
getExecutionHistoryPaginator(Consumer<GetExecutionHistoryRequest.Builder> getExecutionHistoryRequest)
Returns the history of the specified execution as a list of events.
|
default GetExecutionHistoryIterable |
getExecutionHistoryPaginator(GetExecutionHistoryRequest getExecutionHistoryRequest)
Returns the history of the specified execution as a list of events.
|
default ListActivitiesResponse |
listActivities()
Lists the existing activities.
|
default ListActivitiesResponse |
listActivities(Consumer<ListActivitiesRequest.Builder> listActivitiesRequest)
Lists the existing activities.
|
default ListActivitiesResponse |
listActivities(ListActivitiesRequest listActivitiesRequest)
Lists the existing activities.
|
default ListActivitiesIterable |
listActivitiesPaginator()
Lists the existing activities.
|
default ListActivitiesIterable |
listActivitiesPaginator(Consumer<ListActivitiesRequest.Builder> listActivitiesRequest)
Lists the existing activities.
|
default ListActivitiesIterable |
listActivitiesPaginator(ListActivitiesRequest listActivitiesRequest)
Lists the existing activities.
|
default ListExecutionsResponse |
listExecutions(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)
Lists the executions of a state machine that meet the filtering criteria.
|
default ListExecutionsResponse |
listExecutions(ListExecutionsRequest listExecutionsRequest)
Lists the executions of a state machine that meet the filtering criteria.
|
default ListExecutionsIterable |
listExecutionsPaginator(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)
Lists the executions of a state machine that meet the filtering criteria.
|
default ListExecutionsIterable |
listExecutionsPaginator(ListExecutionsRequest listExecutionsRequest)
Lists the executions of a state machine that meet the filtering criteria.
|
default ListStateMachinesResponse |
listStateMachines()
Lists the existing state machines.
|
default ListStateMachinesResponse |
listStateMachines(Consumer<ListStateMachinesRequest.Builder> listStateMachinesRequest)
Lists the existing state machines.
|
default ListStateMachinesResponse |
listStateMachines(ListStateMachinesRequest listStateMachinesRequest)
Lists the existing state machines.
|
default ListStateMachinesIterable |
listStateMachinesPaginator()
Lists the existing state machines.
|
default ListStateMachinesIterable |
listStateMachinesPaginator(Consumer<ListStateMachinesRequest.Builder> listStateMachinesRequest)
Lists the existing state machines.
|
default ListStateMachinesIterable |
listStateMachinesPaginator(ListStateMachinesRequest listStateMachinesRequest)
Lists the existing state machines.
|
default SendTaskFailureResponse |
sendTaskFailure(Consumer<SendTaskFailureRequest.Builder> sendTaskFailureRequest)
Used by workers to report that the task identified by the
taskToken failed. |
default SendTaskFailureResponse |
sendTaskFailure(SendTaskFailureRequest sendTaskFailureRequest)
Used by workers to report that the task identified by the
taskToken failed. |
default SendTaskHeartbeatResponse |
sendTaskHeartbeat(Consumer<SendTaskHeartbeatRequest.Builder> sendTaskHeartbeatRequest)
Used by workers to report to the service that the task represented by the specified
taskToken is
still making progress. |
default SendTaskHeartbeatResponse |
sendTaskHeartbeat(SendTaskHeartbeatRequest sendTaskHeartbeatRequest)
Used by workers to report to the service that the task represented by the specified
taskToken is
still making progress. |
default SendTaskSuccessResponse |
sendTaskSuccess(Consumer<SendTaskSuccessRequest.Builder> sendTaskSuccessRequest)
Used by workers to report that the task identified by the
taskToken completed successfully. |
default SendTaskSuccessResponse |
sendTaskSuccess(SendTaskSuccessRequest sendTaskSuccessRequest)
Used by workers to report that the task identified by the
taskToken completed successfully. |
static ServiceMetadata |
serviceMetadata() |
default StartExecutionResponse |
startExecution(Consumer<StartExecutionRequest.Builder> startExecutionRequest)
Starts a state machine execution.
|
default StartExecutionResponse |
startExecution(StartExecutionRequest startExecutionRequest)
Starts a state machine execution.
|
default StopExecutionResponse |
stopExecution(Consumer<StopExecutionRequest.Builder> stopExecutionRequest)
Stops an execution.
|
default StopExecutionResponse |
stopExecution(StopExecutionRequest stopExecutionRequest)
Stops an execution.
|
default UpdateStateMachineResponse |
updateStateMachine(Consumer<UpdateStateMachineRequest.Builder> updateStateMachineRequest)
Updates an existing state machine by modifying its
definition and/or roleArn . |
default UpdateStateMachineResponse |
updateStateMachine(UpdateStateMachineRequest updateStateMachineRequest)
Updates an existing state machine by modifying its
definition and/or roleArn . |
serviceName
close
static final String SERVICE_NAME
static SfnClient create()
SfnClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static SfnClientBuilder builder()
SfnClient
.default CreateActivityResponse createActivity(CreateActivityRequest createActivityRequest) throws ActivityLimitExceededException, InvalidNameException, AwsServiceException, SdkClientException, SfnException
Creates an activity. An activity is a task which you write in any programming language and host on any machine
which has access to AWS Step Functions. Activities must poll Step Functions using the
GetActivityTask
API action and respond using SendTask*
API actions. This function lets
Step Functions know the existence of your activity and returns an identifier for use in a state machine and when
polling from the activity.
createActivityRequest
- ActivityLimitExceededException
- The maximum number of activities has been reached. Existing activities must be deleted before a new
activity can be created.InvalidNameException
- The provided name is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateActivityResponse createActivity(Consumer<CreateActivityRequest.Builder> createActivityRequest) throws ActivityLimitExceededException, InvalidNameException, AwsServiceException, SdkClientException, SfnException
Creates an activity. An activity is a task which you write in any programming language and host on any machine
which has access to AWS Step Functions. Activities must poll Step Functions using the
GetActivityTask
API action and respond using SendTask*
API actions. This function lets
Step Functions know the existence of your activity and returns an identifier for use in a state machine and when
polling from the activity.
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.ActivityLimitExceededException
- The maximum number of activities has been reached. Existing activities must be deleted before a new
activity can be created.InvalidNameException
- The provided name is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateStateMachineResponse createStateMachine(CreateStateMachineRequest createStateMachineRequest) throws InvalidArnException, InvalidDefinitionException, InvalidNameException, StateMachineAlreadyExistsException, StateMachineDeletingException, StateMachineLimitExceededException, AwsServiceException, SdkClientException, SfnException
Creates a state machine. A state machine consists of a collection of states that can do work (Task
states), determine to which states to transition next (Choice
states), stop an execution with an
error (Fail
states), and so on. State machines are specified using a JSON-based, structured
language.
createStateMachineRequest
- InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.InvalidDefinitionException
- The provided Amazon States Language definition is invalid.InvalidNameException
- The provided name is invalid.StateMachineAlreadyExistsException
- A state machine with the same name but a different definition or role ARN already exists.StateMachineDeletingException
- The specified state machine is being deleted.StateMachineLimitExceededException
- The maximum number of state machines has been reached. Existing state machines must be deleted before a
new state machine can be created.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateStateMachineResponse createStateMachine(Consumer<CreateStateMachineRequest.Builder> createStateMachineRequest) throws InvalidArnException, InvalidDefinitionException, InvalidNameException, StateMachineAlreadyExistsException, StateMachineDeletingException, StateMachineLimitExceededException, AwsServiceException, SdkClientException, SfnException
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.
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.InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.InvalidDefinitionException
- The provided Amazon States Language definition is invalid.InvalidNameException
- The provided name is invalid.StateMachineAlreadyExistsException
- A state machine with the same name but a different definition or role ARN already exists.StateMachineDeletingException
- The specified state machine is being deleted.StateMachineLimitExceededException
- The maximum number of state machines has been reached. Existing state machines must be deleted before a
new state machine can be created.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteActivityResponse deleteActivity(DeleteActivityRequest deleteActivityRequest) throws InvalidArnException, AwsServiceException, SdkClientException, SfnException
Deletes an activity.
deleteActivityRequest
- InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteActivityResponse deleteActivity(Consumer<DeleteActivityRequest.Builder> deleteActivityRequest) throws InvalidArnException, AwsServiceException, SdkClientException, SfnException
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.InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteStateMachineResponse deleteStateMachine(DeleteStateMachineRequest deleteStateMachineRequest) throws InvalidArnException, AwsServiceException, SdkClientException, SfnException
Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to
DELETING
and begins the deletion process. Each state machine execution is deleted the next time it
makes a state transition.
The state machine itself is deleted after all executions are completed or deleted.
deleteStateMachineRequest
- InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteStateMachineResponse deleteStateMachine(Consumer<DeleteStateMachineRequest.Builder> deleteStateMachineRequest) throws InvalidArnException, AwsServiceException, SdkClientException, SfnException
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.
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.InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeActivityResponse describeActivity(DescribeActivityRequest describeActivityRequest) throws ActivityDoesNotExistException, InvalidArnException, AwsServiceException, SdkClientException, SfnException
Describes an activity.
describeActivityRequest
- ActivityDoesNotExistException
- The specified activity does not exist.InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeActivityResponse describeActivity(Consumer<DescribeActivityRequest.Builder> describeActivityRequest) throws ActivityDoesNotExistException, InvalidArnException, AwsServiceException, SdkClientException, SfnException
Describes an activity.
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.ActivityDoesNotExistException
- The specified activity does not exist.InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeExecutionResponse describeExecution(DescribeExecutionRequest describeExecutionRequest) throws ExecutionDoesNotExistException, InvalidArnException, AwsServiceException, SdkClientException, SfnException
Describes an execution.
describeExecutionRequest
- ExecutionDoesNotExistException
- The specified execution does not exist.InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeExecutionResponse describeExecution(Consumer<DescribeExecutionRequest.Builder> describeExecutionRequest) throws ExecutionDoesNotExistException, InvalidArnException, AwsServiceException, SdkClientException, SfnException
Describes an execution.
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.ExecutionDoesNotExistException
- The specified execution does not exist.InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeStateMachineResponse describeStateMachine(DescribeStateMachineRequest describeStateMachineRequest) throws InvalidArnException, StateMachineDoesNotExistException, AwsServiceException, SdkClientException, SfnException
Describes a state machine.
describeStateMachineRequest
- InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.StateMachineDoesNotExistException
- The specified state machine does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeStateMachineResponse describeStateMachine(Consumer<DescribeStateMachineRequest.Builder> describeStateMachineRequest) throws InvalidArnException, StateMachineDoesNotExistException, AwsServiceException, SdkClientException, SfnException
Describes a state machine.
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.InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.StateMachineDoesNotExistException
- The specified state machine does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeStateMachineForExecutionResponse describeStateMachineForExecution(DescribeStateMachineForExecutionRequest describeStateMachineForExecutionRequest) throws ExecutionDoesNotExistException, InvalidArnException, AwsServiceException, SdkClientException, SfnException
Describes the state machine associated with a specific execution.
describeStateMachineForExecutionRequest
- ExecutionDoesNotExistException
- The specified execution does not exist.InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeStateMachineForExecutionResponse describeStateMachineForExecution(Consumer<DescribeStateMachineForExecutionRequest.Builder> describeStateMachineForExecutionRequest) throws ExecutionDoesNotExistException, InvalidArnException, AwsServiceException, SdkClientException, SfnException
Describes the state machine associated with a specific execution.
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.ExecutionDoesNotExistException
- The specified execution does not exist.InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetActivityTaskResponse getActivityTask(GetActivityTaskRequest getActivityTaskRequest) throws ActivityDoesNotExistException, ActivityWorkerLimitExceededException, InvalidArnException, AwsServiceException, SdkClientException, SfnException
Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a
running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds
as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the
service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the
poll returns a taskToken
with a null string.
Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request).
getActivityTaskRequest
- ActivityDoesNotExistException
- The specified activity does not exist.ActivityWorkerLimitExceededException
- The maximum number of workers concurrently polling for activity tasks has been reached.InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetActivityTaskResponse getActivityTask(Consumer<GetActivityTaskRequest.Builder> getActivityTaskRequest) throws ActivityDoesNotExistException, ActivityWorkerLimitExceededException, InvalidArnException, AwsServiceException, SdkClientException, SfnException
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).
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.ActivityDoesNotExistException
- The specified activity does not exist.ActivityWorkerLimitExceededException
- The maximum number of workers concurrently polling for activity tasks has been reached.InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetExecutionHistoryResponse getExecutionHistory(GetExecutionHistoryRequest getExecutionHistoryRequest) throws ExecutionDoesNotExistException, InvalidArnException, InvalidTokenException, AwsServiceException, SdkClientException, SfnException
Returns the history of the specified execution as a list of events. By default, the results are returned in
ascending order of the timeStamp
of the events. Use the reverseOrder
parameter to get
the latest events first.
If a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
getExecutionHistoryRequest
- ExecutionDoesNotExistException
- The specified execution does not exist.InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.InvalidTokenException
- The provided token is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetExecutionHistoryResponse getExecutionHistory(Consumer<GetExecutionHistoryRequest.Builder> getExecutionHistoryRequest) throws ExecutionDoesNotExistException, InvalidArnException, InvalidTokenException, AwsServiceException, SdkClientException, SfnException
Returns the history of the specified execution as a list of events. By default, the results are returned in
ascending order of the timeStamp
of the events. Use the reverseOrder
parameter to get
the latest events first.
If a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
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.ExecutionDoesNotExistException
- The specified execution does not exist.InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.InvalidTokenException
- The provided token is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetExecutionHistoryIterable getExecutionHistoryPaginator(GetExecutionHistoryRequest getExecutionHistoryRequest) throws ExecutionDoesNotExistException, InvalidArnException, InvalidTokenException, AwsServiceException, SdkClientException, SfnException
Returns the history of the specified execution as a list of events. By default, the results are returned in
ascending order of the timeStamp
of the events. Use the reverseOrder
parameter to get
the latest events first.
If a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
This is a variant of
getExecutionHistory(software.amazon.awssdk.services.sfn.model.GetExecutionHistoryRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sfn.paginators.GetExecutionHistoryIterable responses = client.getExecutionHistoryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.sfn.paginators.GetExecutionHistoryIterable responses = client .getExecutionHistoryPaginator(request); for (software.amazon.awssdk.services.sfn.model.GetExecutionHistoryResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.sfn.paginators.GetExecutionHistoryIterable responses = client.getExecutionHistoryPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getExecutionHistory(software.amazon.awssdk.services.sfn.model.GetExecutionHistoryRequest)
operation.
getExecutionHistoryRequest
- ExecutionDoesNotExistException
- The specified execution does not exist.InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.InvalidTokenException
- The provided token is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetExecutionHistoryIterable getExecutionHistoryPaginator(Consumer<GetExecutionHistoryRequest.Builder> getExecutionHistoryRequest) throws ExecutionDoesNotExistException, InvalidArnException, InvalidTokenException, AwsServiceException, SdkClientException, SfnException
Returns the history of the specified execution as a list of events. By default, the results are returned in
ascending order of the timeStamp
of the events. Use the reverseOrder
parameter to get
the latest events first.
If a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
This is a variant of
getExecutionHistory(software.amazon.awssdk.services.sfn.model.GetExecutionHistoryRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sfn.paginators.GetExecutionHistoryIterable responses = client.getExecutionHistoryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.sfn.paginators.GetExecutionHistoryIterable responses = client .getExecutionHistoryPaginator(request); for (software.amazon.awssdk.services.sfn.model.GetExecutionHistoryResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.sfn.paginators.GetExecutionHistoryIterable responses = client.getExecutionHistoryPaginator(request);
responses.iterator().forEachRemaining(....);
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.ExecutionDoesNotExistException
- The specified execution does not exist.InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.InvalidTokenException
- The provided token is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListActivitiesResponse listActivities() throws InvalidTokenException, AwsServiceException, SdkClientException, SfnException
Lists the existing activities.
If a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
InvalidTokenException
- The provided token is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listActivities(ListActivitiesRequest)
,
AWS API
Documentationdefault ListActivitiesResponse listActivities(ListActivitiesRequest listActivitiesRequest) throws InvalidTokenException, AwsServiceException, SdkClientException, SfnException
Lists the existing activities.
If a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
listActivitiesRequest
- InvalidTokenException
- The provided token is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListActivitiesResponse listActivities(Consumer<ListActivitiesRequest.Builder> listActivitiesRequest) throws InvalidTokenException, AwsServiceException, SdkClientException, SfnException
Lists the existing activities.
If a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
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.InvalidTokenException
- The provided token is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListActivitiesIterable listActivitiesPaginator() throws InvalidTokenException, AwsServiceException, SdkClientException, SfnException
Lists the existing activities.
If a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
This is a variant of listActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sfn.paginators.ListActivitiesIterable responses = client.listActivitiesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.sfn.paginators.ListActivitiesIterable responses = client.listActivitiesPaginator(request); for (software.amazon.awssdk.services.sfn.model.ListActivitiesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.sfn.paginators.ListActivitiesIterable responses = client.listActivitiesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest)
operation.
InvalidTokenException
- The provided token is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listActivitiesPaginator(ListActivitiesRequest)
,
AWS API
Documentationdefault ListActivitiesIterable listActivitiesPaginator(ListActivitiesRequest listActivitiesRequest) throws InvalidTokenException, AwsServiceException, SdkClientException, SfnException
Lists the existing activities.
If a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
This is a variant of listActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sfn.paginators.ListActivitiesIterable responses = client.listActivitiesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.sfn.paginators.ListActivitiesIterable responses = client.listActivitiesPaginator(request); for (software.amazon.awssdk.services.sfn.model.ListActivitiesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.sfn.paginators.ListActivitiesIterable responses = client.listActivitiesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest)
operation.
listActivitiesRequest
- InvalidTokenException
- The provided token is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListActivitiesIterable listActivitiesPaginator(Consumer<ListActivitiesRequest.Builder> listActivitiesRequest) throws InvalidTokenException, AwsServiceException, SdkClientException, SfnException
Lists the existing activities.
If a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
This is a variant of listActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sfn.paginators.ListActivitiesIterable responses = client.listActivitiesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.sfn.paginators.ListActivitiesIterable responses = client.listActivitiesPaginator(request); for (software.amazon.awssdk.services.sfn.model.ListActivitiesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.sfn.paginators.ListActivitiesIterable responses = client.listActivitiesPaginator(request);
responses.iterator().forEachRemaining(....);
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.InvalidTokenException
- The provided token is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListExecutionsResponse listExecutions(ListExecutionsRequest listExecutionsRequest) throws InvalidArnException, InvalidTokenException, StateMachineDoesNotExistException, AwsServiceException, SdkClientException, SfnException
Lists the executions of a state machine that meet the filtering criteria.
If a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
listExecutionsRequest
- InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.InvalidTokenException
- The provided token is invalid.StateMachineDoesNotExistException
- The specified state machine does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListExecutionsResponse listExecutions(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest) throws InvalidArnException, InvalidTokenException, StateMachineDoesNotExistException, AwsServiceException, SdkClientException, SfnException
Lists the executions of a state machine that meet the filtering criteria.
If a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
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.InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.InvalidTokenException
- The provided token is invalid.StateMachineDoesNotExistException
- The specified state machine does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListExecutionsIterable listExecutionsPaginator(ListExecutionsRequest listExecutionsRequest) throws InvalidArnException, InvalidTokenException, StateMachineDoesNotExistException, AwsServiceException, SdkClientException, SfnException
Lists the executions of a state machine that meet the filtering criteria.
If a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
This is a variant of listExecutions(software.amazon.awssdk.services.sfn.model.ListExecutionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sfn.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.sfn.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request); for (software.amazon.awssdk.services.sfn.model.ListExecutionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.sfn.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listExecutions(software.amazon.awssdk.services.sfn.model.ListExecutionsRequest)
operation.
listExecutionsRequest
- InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.InvalidTokenException
- The provided token is invalid.StateMachineDoesNotExistException
- The specified state machine does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListExecutionsIterable listExecutionsPaginator(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest) throws InvalidArnException, InvalidTokenException, StateMachineDoesNotExistException, AwsServiceException, SdkClientException, SfnException
Lists the executions of a state machine that meet the filtering criteria.
If a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
This is a variant of listExecutions(software.amazon.awssdk.services.sfn.model.ListExecutionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sfn.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.sfn.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request); for (software.amazon.awssdk.services.sfn.model.ListExecutionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.sfn.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request);
responses.iterator().forEachRemaining(....);
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.InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.InvalidTokenException
- The provided token is invalid.StateMachineDoesNotExistException
- The specified state machine does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListStateMachinesResponse listStateMachines() throws InvalidTokenException, AwsServiceException, SdkClientException, SfnException
Lists the existing state machines.
If a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
InvalidTokenException
- The provided token is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listStateMachines(ListStateMachinesRequest)
,
AWS API
Documentationdefault ListStateMachinesResponse listStateMachines(ListStateMachinesRequest listStateMachinesRequest) throws InvalidTokenException, AwsServiceException, SdkClientException, SfnException
Lists the existing state machines.
If a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
listStateMachinesRequest
- InvalidTokenException
- The provided token is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListStateMachinesResponse listStateMachines(Consumer<ListStateMachinesRequest.Builder> listStateMachinesRequest) throws InvalidTokenException, AwsServiceException, SdkClientException, SfnException
Lists the existing state machines.
If a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
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.InvalidTokenException
- The provided token is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListStateMachinesIterable listStateMachinesPaginator() throws InvalidTokenException, AwsServiceException, SdkClientException, SfnException
Lists the existing state machines.
If a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
This is a variant of
listStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sfn.paginators.ListStateMachinesIterable responses = client.listStateMachinesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.sfn.paginators.ListStateMachinesIterable responses = client .listStateMachinesPaginator(request); for (software.amazon.awssdk.services.sfn.model.ListStateMachinesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.sfn.paginators.ListStateMachinesIterable responses = client.listStateMachinesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest)
operation.
InvalidTokenException
- The provided token is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listStateMachinesPaginator(ListStateMachinesRequest)
,
AWS API
Documentationdefault ListStateMachinesIterable listStateMachinesPaginator(ListStateMachinesRequest listStateMachinesRequest) throws InvalidTokenException, AwsServiceException, SdkClientException, SfnException
Lists the existing state machines.
If a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
This is a variant of
listStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sfn.paginators.ListStateMachinesIterable responses = client.listStateMachinesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.sfn.paginators.ListStateMachinesIterable responses = client .listStateMachinesPaginator(request); for (software.amazon.awssdk.services.sfn.model.ListStateMachinesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.sfn.paginators.ListStateMachinesIterable responses = client.listStateMachinesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest)
operation.
listStateMachinesRequest
- InvalidTokenException
- The provided token is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListStateMachinesIterable listStateMachinesPaginator(Consumer<ListStateMachinesRequest.Builder> listStateMachinesRequest) throws InvalidTokenException, AwsServiceException, SdkClientException, SfnException
Lists the existing state machines.
If a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
This is a variant of
listStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sfn.paginators.ListStateMachinesIterable responses = client.listStateMachinesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.sfn.paginators.ListStateMachinesIterable responses = client .listStateMachinesPaginator(request); for (software.amazon.awssdk.services.sfn.model.ListStateMachinesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.sfn.paginators.ListStateMachinesIterable responses = client.listStateMachinesPaginator(request);
responses.iterator().forEachRemaining(....);
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.InvalidTokenException
- The provided token is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SendTaskFailureResponse sendTaskFailure(SendTaskFailureRequest sendTaskFailureRequest) throws TaskDoesNotExistException, InvalidTokenException, TaskTimedOutException, AwsServiceException, SdkClientException, SfnException
Used by workers to report that the task identified by the taskToken
failed.
sendTaskFailureRequest
- TaskDoesNotExistException
InvalidTokenException
- The provided token is invalid.TaskTimedOutException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SendTaskFailureResponse sendTaskFailure(Consumer<SendTaskFailureRequest.Builder> sendTaskFailureRequest) throws TaskDoesNotExistException, InvalidTokenException, TaskTimedOutException, AwsServiceException, SdkClientException, SfnException
Used by workers 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.TaskDoesNotExistException
InvalidTokenException
- The provided token is invalid.TaskTimedOutException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SendTaskHeartbeatResponse sendTaskHeartbeat(SendTaskHeartbeatRequest sendTaskHeartbeatRequest) throws TaskDoesNotExistException, InvalidTokenException, TaskTimedOutException, AwsServiceException, SdkClientException, SfnException
Used by workers to report to the service that the task represented by the specified taskToken
is
still making progress. This action resets the Heartbeat
clock. The Heartbeat
threshold
is specified in the state machine's Amazon States Language definition. This action does not in itself create an
event in the execution history. However, if the task times out, the execution history contains an
ActivityTimedOut
event.
The Timeout
of a task, defined in the state machine's Amazon States Language definition, is its
maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received.
This operation is only useful for long-lived tasks to report the liveliness of the task.
sendTaskHeartbeatRequest
- TaskDoesNotExistException
InvalidTokenException
- The provided token is invalid.TaskTimedOutException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SendTaskHeartbeatResponse sendTaskHeartbeat(Consumer<SendTaskHeartbeatRequest.Builder> sendTaskHeartbeatRequest) throws TaskDoesNotExistException, InvalidTokenException, TaskTimedOutException, AwsServiceException, SdkClientException, SfnException
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.
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.TaskDoesNotExistException
InvalidTokenException
- The provided token is invalid.TaskTimedOutException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SendTaskSuccessResponse sendTaskSuccess(SendTaskSuccessRequest sendTaskSuccessRequest) throws TaskDoesNotExistException, InvalidOutputException, InvalidTokenException, TaskTimedOutException, AwsServiceException, SdkClientException, SfnException
Used by workers to report that the task identified by the taskToken
completed successfully.
sendTaskSuccessRequest
- TaskDoesNotExistException
InvalidOutputException
- The provided JSON output data is invalid.InvalidTokenException
- The provided token is invalid.TaskTimedOutException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SendTaskSuccessResponse sendTaskSuccess(Consumer<SendTaskSuccessRequest.Builder> sendTaskSuccessRequest) throws TaskDoesNotExistException, InvalidOutputException, InvalidTokenException, TaskTimedOutException, AwsServiceException, SdkClientException, SfnException
Used by workers 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.TaskDoesNotExistException
InvalidOutputException
- The provided JSON output data is invalid.InvalidTokenException
- The provided token is invalid.TaskTimedOutException
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartExecutionResponse startExecution(StartExecutionRequest startExecutionRequest) throws ExecutionLimitExceededException, ExecutionAlreadyExistsException, InvalidArnException, InvalidExecutionInputException, InvalidNameException, StateMachineDoesNotExistException, StateMachineDeletingException, AwsServiceException, SdkClientException, SfnException
Starts a state machine execution.
startExecutionRequest
- ExecutionLimitExceededException
- The maximum number of running executions has been reached. Running executions must end or be stopped
before a new execution can be started.ExecutionAlreadyExistsException
- The execution has the same name
as another execution (but a different input
).
Executions with the same name
and input
are considered idempotent.
InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.InvalidExecutionInputException
- The provided JSON input data is invalid.InvalidNameException
- The provided name is invalid.StateMachineDoesNotExistException
- The specified state machine does not exist.StateMachineDeletingException
- The specified state machine is being deleted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartExecutionResponse startExecution(Consumer<StartExecutionRequest.Builder> startExecutionRequest) throws ExecutionLimitExceededException, ExecutionAlreadyExistsException, InvalidArnException, InvalidExecutionInputException, InvalidNameException, StateMachineDoesNotExistException, StateMachineDeletingException, AwsServiceException, SdkClientException, SfnException
Starts a state machine execution.
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.ExecutionLimitExceededException
- The maximum number of running executions has been reached. Running executions must end or be stopped
before a new execution can be started.ExecutionAlreadyExistsException
- The execution has the same name
as another execution (but a different input
).
Executions with the same name
and input
are considered idempotent.
InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.InvalidExecutionInputException
- The provided JSON input data is invalid.InvalidNameException
- The provided name is invalid.StateMachineDoesNotExistException
- The specified state machine does not exist.StateMachineDeletingException
- The specified state machine is being deleted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopExecutionResponse stopExecution(StopExecutionRequest stopExecutionRequest) throws ExecutionDoesNotExistException, InvalidArnException, AwsServiceException, SdkClientException, SfnException
Stops an execution.
stopExecutionRequest
- ExecutionDoesNotExistException
- The specified execution does not exist.InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopExecutionResponse stopExecution(Consumer<StopExecutionRequest.Builder> stopExecutionRequest) throws ExecutionDoesNotExistException, InvalidArnException, AwsServiceException, SdkClientException, SfnException
Stops an execution.
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.ExecutionDoesNotExistException
- The specified execution does not exist.InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateStateMachineResponse updateStateMachine(UpdateStateMachineRequest updateStateMachineRequest) throws InvalidArnException, InvalidDefinitionException, MissingRequiredParameterException, StateMachineDeletingException, StateMachineDoesNotExistException, AwsServiceException, SdkClientException, SfnException
Updates an existing state machine by modifying its definition
and/or roleArn
. Running
executions will continue to use the previous definition
and roleArn
.
All StartExecution
calls within a few seconds will use the updated definition
and
roleArn
. Executions started immediately after calling UpdateStateMachine
may use the
previous state machine definition
and roleArn
. You must include at least one of
definition
or roleArn
or you will receive a MissingRequiredParameter
error.
updateStateMachineRequest
- InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.InvalidDefinitionException
- The provided Amazon States Language definition is invalid.MissingRequiredParameterException
- Request is missing a required parameter. This error occurs if both definition
and
roleArn
are not specified.StateMachineDeletingException
- The specified state machine is being deleted.StateMachineDoesNotExistException
- The specified state machine does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateStateMachineResponse updateStateMachine(Consumer<UpdateStateMachineRequest.Builder> updateStateMachineRequest) throws InvalidArnException, InvalidDefinitionException, MissingRequiredParameterException, StateMachineDeletingException, StateMachineDoesNotExistException, AwsServiceException, SdkClientException, SfnException
Updates an existing state machine by modifying its definition
and/or roleArn
. Running
executions will continue to use the previous definition
and roleArn
.
All StartExecution
calls within a few seconds will use the updated definition
and
roleArn
. Executions started immediately after calling UpdateStateMachine
may use the
previous state machine definition
and roleArn
. You must include at least one of
definition
or roleArn
or you will receive a MissingRequiredParameter
error.
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.InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.InvalidDefinitionException
- The provided Amazon States Language definition is invalid.MissingRequiredParameterException
- Request is missing a required parameter. This error occurs if both definition
and
roleArn
are not specified.StateMachineDeletingException
- The specified state machine is being deleted.StateMachineDoesNotExistException
- The specified state machine does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.