Interface SfnAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
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 Amazon Web Services, your own servers, or any system that has access to Amazon Web Services. You can access and use Step Functions using the console, the Amazon Web Services SDKs, or an HTTP API. For more information about Step Functions, see the Step Functions Developer Guide .
If you use the Step Functions API actions using Amazon Web Services SDK integrations, make sure the API actions are
in camel case and parameter names are in Pascal case. For example, you could use Step Functions API action
startSyncExecution
and specify its parameter as StateMachineArn
.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic SfnAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aSfnAsyncClient
.static SfnAsyncClient
create()
Create aSfnAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateActivityResponse> createActivity
(Consumer<CreateActivityRequest.Builder> createActivityRequest) Creates an activity.default CompletableFuture
<CreateActivityResponse> createActivity
(CreateActivityRequest createActivityRequest) Creates an activity.createStateMachine
(Consumer<CreateStateMachineRequest.Builder> createStateMachineRequest) Creates a state machine.createStateMachine
(CreateStateMachineRequest createStateMachineRequest) Creates a state machine.createStateMachineAlias
(Consumer<CreateStateMachineAliasRequest.Builder> createStateMachineAliasRequest) createStateMachineAlias
(CreateStateMachineAliasRequest createStateMachineAliasRequest) default CompletableFuture
<DeleteActivityResponse> deleteActivity
(Consumer<DeleteActivityRequest.Builder> deleteActivityRequest) Deletes an activity.default CompletableFuture
<DeleteActivityResponse> deleteActivity
(DeleteActivityRequest deleteActivityRequest) Deletes an activity.deleteStateMachine
(Consumer<DeleteStateMachineRequest.Builder> deleteStateMachineRequest) Deletes a state machine.deleteStateMachine
(DeleteStateMachineRequest deleteStateMachineRequest) Deletes a state machine.deleteStateMachineAlias
(Consumer<DeleteStateMachineAliasRequest.Builder> deleteStateMachineAliasRequest) Deletes a state machine alias.deleteStateMachineAlias
(DeleteStateMachineAliasRequest deleteStateMachineAliasRequest) Deletes a state machine alias.deleteStateMachineVersion
(Consumer<DeleteStateMachineVersionRequest.Builder> deleteStateMachineVersionRequest) Deletes a state machine version.deleteStateMachineVersion
(DeleteStateMachineVersionRequest deleteStateMachineVersionRequest) Deletes a state machine version.describeActivity
(Consumer<DescribeActivityRequest.Builder> describeActivityRequest) Describes an activity.describeActivity
(DescribeActivityRequest describeActivityRequest) Describes an activity.describeExecution
(Consumer<DescribeExecutionRequest.Builder> describeExecutionRequest) Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata.describeExecution
(DescribeExecutionRequest describeExecutionRequest) Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata.default CompletableFuture
<DescribeMapRunResponse> describeMapRun
(Consumer<DescribeMapRunRequest.Builder> describeMapRunRequest) Provides information about a Map Run's configuration, progress, and results.default CompletableFuture
<DescribeMapRunResponse> describeMapRun
(DescribeMapRunRequest describeMapRunRequest) Provides information about a Map Run's configuration, progress, and results.describeStateMachine
(Consumer<DescribeStateMachineRequest.Builder> describeStateMachineRequest) Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration.describeStateMachine
(DescribeStateMachineRequest describeStateMachineRequest) Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration.describeStateMachineAlias
(Consumer<DescribeStateMachineAliasRequest.Builder> describeStateMachineAliasRequest) Returns details about a state machine alias.describeStateMachineAlias
(DescribeStateMachineAliasRequest describeStateMachineAliasRequest) Returns details about a state machine alias.describeStateMachineForExecution
(Consumer<DescribeStateMachineForExecutionRequest.Builder> describeStateMachineForExecutionRequest) Provides information about a state machine's definition, its execution role ARN, and configuration.describeStateMachineForExecution
(DescribeStateMachineForExecutionRequest describeStateMachineForExecutionRequest) Provides information about a state machine's definition, its execution role ARN, and configuration.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.getExecutionHistory
(Consumer<GetExecutionHistoryRequest.Builder> getExecutionHistoryRequest) Returns the history of the specified execution as a list of events.getExecutionHistory
(GetExecutionHistoryRequest getExecutionHistoryRequest) Returns the history of the specified execution as a list of events.default GetExecutionHistoryPublisher
getExecutionHistoryPaginator
(Consumer<GetExecutionHistoryRequest.Builder> getExecutionHistoryRequest) This is a variant ofgetExecutionHistory(software.amazon.awssdk.services.sfn.model.GetExecutionHistoryRequest)
operation.default GetExecutionHistoryPublisher
getExecutionHistoryPaginator
(GetExecutionHistoryRequest getExecutionHistoryRequest) This is a variant ofgetExecutionHistory(software.amazon.awssdk.services.sfn.model.GetExecutionHistoryRequest)
operation.default CompletableFuture
<ListActivitiesResponse> 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
This is a variant oflistActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest)
operation.default ListActivitiesPublisher
listActivitiesPaginator
(Consumer<ListActivitiesRequest.Builder> listActivitiesRequest) This is a variant oflistActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest)
operation.default ListActivitiesPublisher
listActivitiesPaginator
(ListActivitiesRequest listActivitiesRequest) This is a variant oflistActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest)
operation.default CompletableFuture
<ListExecutionsResponse> listExecutions
(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest) Lists all executions of a state machine or a Map Run.default CompletableFuture
<ListExecutionsResponse> listExecutions
(ListExecutionsRequest listExecutionsRequest) Lists all executions of a state machine or a Map Run.default ListExecutionsPublisher
listExecutionsPaginator
(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest) This is a variant oflistExecutions(software.amazon.awssdk.services.sfn.model.ListExecutionsRequest)
operation.default ListExecutionsPublisher
listExecutionsPaginator
(ListExecutionsRequest listExecutionsRequest) This is a variant oflistExecutions(software.amazon.awssdk.services.sfn.model.ListExecutionsRequest)
operation.default CompletableFuture
<ListMapRunsResponse> listMapRuns
(Consumer<ListMapRunsRequest.Builder> listMapRunsRequest) Lists all Map Runs that were started by a given state machine execution.default CompletableFuture
<ListMapRunsResponse> listMapRuns
(ListMapRunsRequest listMapRunsRequest) Lists all Map Runs that were started by a given state machine execution.default ListMapRunsPublisher
listMapRunsPaginator
(Consumer<ListMapRunsRequest.Builder> listMapRunsRequest) This is a variant oflistMapRuns(software.amazon.awssdk.services.sfn.model.ListMapRunsRequest)
operation.default ListMapRunsPublisher
listMapRunsPaginator
(ListMapRunsRequest listMapRunsRequest) This is a variant oflistMapRuns(software.amazon.awssdk.services.sfn.model.ListMapRunsRequest)
operation.listStateMachineAliases
(Consumer<ListStateMachineAliasesRequest.Builder> listStateMachineAliasesRequest) Lists aliases for a specified state machine ARN.listStateMachineAliases
(ListStateMachineAliasesRequest listStateMachineAliasesRequest) Lists aliases for a specified state machine ARN.Lists the existing state machines.listStateMachines
(Consumer<ListStateMachinesRequest.Builder> listStateMachinesRequest) Lists the existing state machines.listStateMachines
(ListStateMachinesRequest listStateMachinesRequest) Lists the existing state machines.default ListStateMachinesPublisher
This is a variant oflistStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest)
operation.default ListStateMachinesPublisher
listStateMachinesPaginator
(Consumer<ListStateMachinesRequest.Builder> listStateMachinesRequest) This is a variant oflistStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest)
operation.default ListStateMachinesPublisher
listStateMachinesPaginator
(ListStateMachinesRequest listStateMachinesRequest) This is a variant oflistStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest)
operation.listStateMachineVersions
(Consumer<ListStateMachineVersionsRequest.Builder> listStateMachineVersionsRequest) Lists versions for the specified state machine Amazon Resource Name (ARN).listStateMachineVersions
(ListStateMachineVersionsRequest listStateMachineVersionsRequest) Lists versions for the specified state machine Amazon Resource Name (ARN).listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List tags for a given resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) List tags for a given resource.publishStateMachineVersion
(Consumer<PublishStateMachineVersionRequest.Builder> publishStateMachineVersionRequest) Creates a version from the current revision of a state machine.publishStateMachineVersion
(PublishStateMachineVersionRequest publishStateMachineVersionRequest) Creates a version from the current revision of a state machine.redriveExecution
(Consumer<RedriveExecutionRequest.Builder> redriveExecutionRequest) Restarts unsuccessful executions of Standard workflows that didn't complete successfully in the last 14 days.redriveExecution
(RedriveExecutionRequest redriveExecutionRequest) Restarts unsuccessful executions of Standard workflows that didn't complete successfully in the last 14 days.default CompletableFuture
<SendTaskFailureResponse> sendTaskFailure
(Consumer<SendTaskFailureRequest.Builder> sendTaskFailureRequest) default CompletableFuture
<SendTaskFailureResponse> sendTaskFailure
(SendTaskFailureRequest sendTaskFailureRequest) sendTaskHeartbeat
(Consumer<SendTaskHeartbeatRequest.Builder> sendTaskHeartbeatRequest) sendTaskHeartbeat
(SendTaskHeartbeatRequest sendTaskHeartbeatRequest) default CompletableFuture
<SendTaskSuccessResponse> sendTaskSuccess
(Consumer<SendTaskSuccessRequest.Builder> sendTaskSuccessRequest) default CompletableFuture
<SendTaskSuccessResponse> sendTaskSuccess
(SendTaskSuccessRequest sendTaskSuccessRequest) default SfnServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<StartExecutionResponse> startExecution
(Consumer<StartExecutionRequest.Builder> startExecutionRequest) Starts a state machine execution.default CompletableFuture
<StartExecutionResponse> startExecution
(StartExecutionRequest startExecutionRequest) Starts a state machine execution.startSyncExecution
(Consumer<StartSyncExecutionRequest.Builder> startSyncExecutionRequest) Starts a Synchronous Express state machine execution.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
<TestStateResponse> testState
(Consumer<TestStateRequest.Builder> testStateRequest) Accepts the definition of a single state and executes it.default CompletableFuture
<TestStateResponse> testState
(TestStateRequest testStateRequest) Accepts the definition of a single state and executes it.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Remove a tag from a Step Functions resourcedefault CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Remove a tag from a Step Functions resourcedefault CompletableFuture
<UpdateMapRunResponse> updateMapRun
(Consumer<UpdateMapRunRequest.Builder> updateMapRunRequest) Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure.default CompletableFuture
<UpdateMapRunResponse> updateMapRun
(UpdateMapRunRequest updateMapRunRequest) Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure.updateStateMachine
(Consumer<UpdateStateMachineRequest.Builder> updateStateMachineRequest) Updates an existing state machine by modifying itsdefinition
,roleArn
, orloggingConfiguration
.updateStateMachine
(UpdateStateMachineRequest updateStateMachineRequest) Updates an existing state machine by modifying itsdefinition
,roleArn
, orloggingConfiguration
.updateStateMachineAlias
(Consumer<UpdateStateMachineAliasRequest.Builder> updateStateMachineAliasRequest) Updates the configuration of an existing state machine alias by modifying itsdescription
orroutingConfiguration
.updateStateMachineAlias
(UpdateStateMachineAliasRequest updateStateMachineAliasRequest) Updates the configuration of an existing state machine alias by modifying itsdescription
orroutingConfiguration
.validateStateMachineDefinition
(Consumer<ValidateStateMachineDefinitionRequest.Builder> validateStateMachineDefinitionRequest) Validates the syntax of a state machine definition.validateStateMachineDefinition
(ValidateStateMachineDefinitionRequest validateStateMachineDefinitionRequest) Validates the syntax of a state machine definition.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createActivity
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 Step Functions. Activities must poll Step Functions using the
GetActivityTask
API action and respond usingSendTask*
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 activityname
. If a following request has differenttags
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.- Parameters:
createActivityRequest
-- Returns:
- A Java Future containing the result of the CreateActivity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 not valid.
- TooManyTagsException You've exceeded the number of tags allowed for a resource. See the Limits Topic in the Step Functions Developer Guide.
- 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.
- See Also:
-
createActivity
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 Step Functions. Activities must poll Step Functions using the
GetActivityTask
API action and respond usingSendTask*
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 activityname
. If a following request has differenttags
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 viaCreateActivityRequest.builder()
- Parameters:
createActivityRequest
- AConsumer
that will call methods onCreateActivityRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateActivity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 not valid.
- TooManyTagsException You've exceeded the number of tags allowed for a resource. See the Limits Topic in the Step Functions Developer Guide.
- 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.
- See Also:
-
createStateMachine
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 Step Functions User Guide.If you set the
publish
parameter of this API action totrue
, it publishes version1
as the first revision of the state machine.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 machinename
,definition
,type
,LoggingConfiguration
, andTracingConfiguration
. The check is also based on thepublish
andversionDescription
parameters. If a following request has a differentroleArn
ortags
, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case,roleArn
andtags
will not be updated, even if they are different.- Parameters:
createStateMachineRequest
-- Returns:
- A Java Future containing the result of the CreateStateMachine operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- InvalidDefinitionException The provided Amazon States Language definition is not valid.
- InvalidNameException The provided name is not valid.
- InvalidLoggingConfigurationException
- InvalidTracingConfigurationException Your
tracingConfiguration
key does not match, orenabled
has not been set totrue
orfalse
. - 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.
- StateMachineTypeNotSupportedException
- TooManyTagsException You've exceeded the number of tags allowed for a resource. See the Limits Topic in the Step Functions Developer Guide.
- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs
when there're concurrent requests for DeleteStateMachineVersion,
PublishStateMachineVersion, or UpdateStateMachine with the
publish
parameter set totrue
.HTTP Status Code: 409
- 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.
- See Also:
-
createStateMachine
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 Step Functions User Guide.If you set the
publish
parameter of this API action totrue
, it publishes version1
as the first revision of the state machine.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 machinename
,definition
,type
,LoggingConfiguration
, andTracingConfiguration
. The check is also based on thepublish
andversionDescription
parameters. If a following request has a differentroleArn
ortags
, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case,roleArn
andtags
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 viaCreateStateMachineRequest.builder()
- Parameters:
createStateMachineRequest
- AConsumer
that will call methods onCreateStateMachineRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateStateMachine operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- InvalidDefinitionException The provided Amazon States Language definition is not valid.
- InvalidNameException The provided name is not valid.
- InvalidLoggingConfigurationException
- InvalidTracingConfigurationException Your
tracingConfiguration
key does not match, orenabled
has not been set totrue
orfalse
. - 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.
- StateMachineTypeNotSupportedException
- TooManyTagsException You've exceeded the number of tags allowed for a resource. See the Limits Topic in the Step Functions Developer Guide.
- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs
when there're concurrent requests for DeleteStateMachineVersion,
PublishStateMachineVersion, or UpdateStateMachine with the
publish
parameter set totrue
.HTTP Status Code: 409
- 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.
- See Also:
-
createStateMachineAlias
default CompletableFuture<CreateStateMachineAliasResponse> createStateMachineAlias(CreateStateMachineAliasRequest createStateMachineAliasRequest) Creates an alias for a state machine that points to one or two versions of the same state machine. You can set your application to call StartExecution with an alias and update the version the alias uses without changing the client's code.
You can also map an alias to split StartExecution requests between two versions of a state machine. To do this, add a second
RoutingConfig
object in theroutingConfiguration
parameter. You must also specify the percentage of execution run requests each version should receive in bothRoutingConfig
objects. Step Functions randomly chooses which version runs a given execution based on the percentage you specify.To create an alias that points to a single version, specify a single
RoutingConfig
object with aweight
set to 100.You can create up to 100 aliases for each state machine. You must delete unused aliases using the DeleteStateMachineAlias API action.
CreateStateMachineAlias
is an idempotent API. Step Functions bases the idempotency check on thestateMachineArn
,description
,name
, androutingConfiguration
parameters. Requests that contain the same values for these parameters return a successful idempotent response without creating a duplicate resource.Related operations:
- Parameters:
createStateMachineAliasRequest
-- Returns:
- A Java Future containing the result of the CreateStateMachineAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- InvalidNameException The provided name is not valid.
- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- StateMachineDeletingException The specified state machine is being deleted.
- ResourceNotFoundException Could not find the referenced resource.
- ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs
when there're concurrent requests for DeleteStateMachineVersion,
PublishStateMachineVersion, or UpdateStateMachine with the
publish
parameter set totrue
.HTTP Status Code: 409
- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
HTTP Status Code: 402
- 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.
- See Also:
-
createStateMachineAlias
default CompletableFuture<CreateStateMachineAliasResponse> createStateMachineAlias(Consumer<CreateStateMachineAliasRequest.Builder> createStateMachineAliasRequest) Creates an alias for a state machine that points to one or two versions of the same state machine. You can set your application to call StartExecution with an alias and update the version the alias uses without changing the client's code.
You can also map an alias to split StartExecution requests between two versions of a state machine. To do this, add a second
RoutingConfig
object in theroutingConfiguration
parameter. You must also specify the percentage of execution run requests each version should receive in bothRoutingConfig
objects. Step Functions randomly chooses which version runs a given execution based on the percentage you specify.To create an alias that points to a single version, specify a single
RoutingConfig
object with aweight
set to 100.You can create up to 100 aliases for each state machine. You must delete unused aliases using the DeleteStateMachineAlias API action.
CreateStateMachineAlias
is an idempotent API. Step Functions bases the idempotency check on thestateMachineArn
,description
,name
, androutingConfiguration
parameters. Requests that contain the same values for these parameters return a successful idempotent response without creating a duplicate resource.Related operations:
This is a convenience which creates an instance of the
CreateStateMachineAliasRequest.Builder
avoiding the need to create one manually viaCreateStateMachineAliasRequest.builder()
- Parameters:
createStateMachineAliasRequest
- AConsumer
that will call methods onCreateStateMachineAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateStateMachineAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- InvalidNameException The provided name is not valid.
- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- StateMachineDeletingException The specified state machine is being deleted.
- ResourceNotFoundException Could not find the referenced resource.
- ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs
when there're concurrent requests for DeleteStateMachineVersion,
PublishStateMachineVersion, or UpdateStateMachine with the
publish
parameter set totrue
.HTTP Status Code: 409
- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
HTTP Status Code: 402
- 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.
- See Also:
-
deleteActivity
default CompletableFuture<DeleteActivityResponse> deleteActivity(DeleteActivityRequest deleteActivityRequest) Deletes an activity.
- Parameters:
deleteActivityRequest
-- Returns:
- A Java Future containing the result of the DeleteActivity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- 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.
- See Also:
-
deleteActivity
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 viaDeleteActivityRequest.builder()
- Parameters:
deleteActivityRequest
- AConsumer
that will call methods onDeleteActivityRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteActivity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- 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.
- See Also:
-
deleteStateMachine
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. A state machine is deleted only when all its executions are completed. On the next state transition, the state machine's executions are terminated.A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.
The following are some examples of qualified and unqualified state machine ARNs:
-
The following qualified state machine ARN refers to a Distributed Map state with a label
mapStateLabel
in a state machine namedmyStateMachine
.arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with
ValidationException
. -
The following unqualified state machine ARN refers to a state machine named
myStateMachine
.arn:partition:states:region:account-id:stateMachine:myStateMachine
This API action also deletes all versions and aliases associated with a state machine.
For
EXPRESS
state machines, the deletion happens eventually (usually in less than a minute). Running executions may emit logs afterDeleteStateMachine
API is called.- Parameters:
deleteStateMachineRequest
-- Returns:
- A Java Future containing the result of the DeleteStateMachine operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- 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.
- See Also:
-
-
deleteStateMachine
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. A state machine is deleted only when all its executions are completed. On the next state transition, the state machine's executions are terminated.A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.
The following are some examples of qualified and unqualified state machine ARNs:
-
The following qualified state machine ARN refers to a Distributed Map state with a label
mapStateLabel
in a state machine namedmyStateMachine
.arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with
ValidationException
. -
The following unqualified state machine ARN refers to a state machine named
myStateMachine
.arn:partition:states:region:account-id:stateMachine:myStateMachine
This API action also deletes all versions and aliases associated with a state machine.
For
EXPRESS
state machines, the deletion happens eventually (usually in less than a minute). Running executions may emit logs afterDeleteStateMachine
API is called.
This is a convenience which creates an instance of the
DeleteStateMachineRequest.Builder
avoiding the need to create one manually viaDeleteStateMachineRequest.builder()
- Parameters:
deleteStateMachineRequest
- AConsumer
that will call methods onDeleteStateMachineRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteStateMachine operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- 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.
- See Also:
-
-
deleteStateMachineAlias
default CompletableFuture<DeleteStateMachineAliasResponse> deleteStateMachineAlias(DeleteStateMachineAliasRequest deleteStateMachineAliasRequest) Deletes a state machine alias.
After you delete a state machine alias, you can't use it to start executions. When you delete a state machine alias, Step Functions doesn't delete the state machine versions that alias references.
Related operations:
- Parameters:
deleteStateMachineAliasRequest
-- Returns:
- A Java Future containing the result of the DeleteStateMachineAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- ResourceNotFoundException Could not find the referenced resource.
- ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs
when there're concurrent requests for DeleteStateMachineVersion,
PublishStateMachineVersion, or UpdateStateMachine with the
publish
parameter set totrue
.HTTP Status Code: 409
- 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.
- See Also:
-
deleteStateMachineAlias
default CompletableFuture<DeleteStateMachineAliasResponse> deleteStateMachineAlias(Consumer<DeleteStateMachineAliasRequest.Builder> deleteStateMachineAliasRequest) Deletes a state machine alias.
After you delete a state machine alias, you can't use it to start executions. When you delete a state machine alias, Step Functions doesn't delete the state machine versions that alias references.
Related operations:
This is a convenience which creates an instance of the
DeleteStateMachineAliasRequest.Builder
avoiding the need to create one manually viaDeleteStateMachineAliasRequest.builder()
- Parameters:
deleteStateMachineAliasRequest
- AConsumer
that will call methods onDeleteStateMachineAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteStateMachineAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- ResourceNotFoundException Could not find the referenced resource.
- ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs
when there're concurrent requests for DeleteStateMachineVersion,
PublishStateMachineVersion, or UpdateStateMachine with the
publish
parameter set totrue
.HTTP Status Code: 409
- 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.
- See Also:
-
deleteStateMachineVersion
default CompletableFuture<DeleteStateMachineVersionResponse> deleteStateMachineVersion(DeleteStateMachineVersionRequest deleteStateMachineVersionRequest) Deletes a state machine version. After you delete a version, you can't call StartExecution using that version's ARN or use the version with a state machine alias.
Deleting a state machine version won't terminate its in-progress executions.
You can't delete a state machine version currently referenced by one or more aliases. Before you delete a version, you must either delete the aliases or update them to point to another state machine version.
Related operations:
- Parameters:
deleteStateMachineVersionRequest
-- Returns:
- A Java Future containing the result of the DeleteStateMachineVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs
when there're concurrent requests for DeleteStateMachineVersion,
PublishStateMachineVersion, or UpdateStateMachine with the
publish
parameter set totrue
.HTTP Status Code: 409
- 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.
- See Also:
-
deleteStateMachineVersion
default CompletableFuture<DeleteStateMachineVersionResponse> deleteStateMachineVersion(Consumer<DeleteStateMachineVersionRequest.Builder> deleteStateMachineVersionRequest) Deletes a state machine version. After you delete a version, you can't call StartExecution using that version's ARN or use the version with a state machine alias.
Deleting a state machine version won't terminate its in-progress executions.
You can't delete a state machine version currently referenced by one or more aliases. Before you delete a version, you must either delete the aliases or update them to point to another state machine version.
Related operations:
This is a convenience which creates an instance of the
DeleteStateMachineVersionRequest.Builder
avoiding the need to create one manually viaDeleteStateMachineVersionRequest.builder()
- Parameters:
deleteStateMachineVersionRequest
- AConsumer
that will call methods onDeleteStateMachineVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteStateMachineVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs
when there're concurrent requests for DeleteStateMachineVersion,
PublishStateMachineVersion, or UpdateStateMachine with the
publish
parameter set totrue
.HTTP Status Code: 409
- 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.
- See Also:
-
describeActivity
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.
- Parameters:
describeActivityRequest
-- Returns:
- A Java Future containing the result of the DescribeActivity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ActivityDoesNotExistException The specified activity does not exist.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- 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.
- See Also:
-
describeActivity
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 viaDescribeActivityRequest.builder()
- Parameters:
describeActivityRequest
- AConsumer
that will call methods onDescribeActivityRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeActivity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ActivityDoesNotExistException The specified activity does not exist.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- 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.
- See Also:
-
describeExecution
default CompletableFuture<DescribeExecutionResponse> describeExecution(DescribeExecutionRequest describeExecutionRequest) Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. If you've redriven an execution, you can use this API action to return information about the redrives of that execution. In addition, you can use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was dispatched by a Map Run.
If you specify a version or alias ARN when you call the StartExecution API action,
DescribeExecution
returns that ARN.This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Executions of an
EXPRESS
state machine aren't supported byDescribeExecution
unless a Map Run dispatched them.- Parameters:
describeExecutionRequest
-- Returns:
- A Java Future containing the result of the DescribeExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ExecutionDoesNotExistException The specified execution does not exist.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- 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.
- See Also:
-
describeExecution
default CompletableFuture<DescribeExecutionResponse> describeExecution(Consumer<DescribeExecutionRequest.Builder> describeExecutionRequest) Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. If you've redriven an execution, you can use this API action to return information about the redrives of that execution. In addition, you can use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was dispatched by a Map Run.
If you specify a version or alias ARN when you call the StartExecution API action,
DescribeExecution
returns that ARN.This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Executions of an
EXPRESS
state machine aren't supported byDescribeExecution
unless a Map Run dispatched them.
This is a convenience which creates an instance of the
DescribeExecutionRequest.Builder
avoiding the need to create one manually viaDescribeExecutionRequest.builder()
- Parameters:
describeExecutionRequest
- AConsumer
that will call methods onDescribeExecutionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ExecutionDoesNotExistException The specified execution does not exist.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- 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.
- See Also:
-
describeMapRun
default CompletableFuture<DescribeMapRunResponse> describeMapRun(DescribeMapRunRequest describeMapRunRequest) Provides information about a Map Run's configuration, progress, and results. If you've redriven a Map Run, this API action also returns information about the redrives of that Map Run. For more information, see Examining Map Run in the Step Functions Developer Guide.
- Parameters:
describeMapRunRequest
-- Returns:
- A Java Future containing the result of the DescribeMapRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Could not find the referenced resource.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- 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.
- See Also:
-
describeMapRun
default CompletableFuture<DescribeMapRunResponse> describeMapRun(Consumer<DescribeMapRunRequest.Builder> describeMapRunRequest) Provides information about a Map Run's configuration, progress, and results. If you've redriven a Map Run, this API action also returns information about the redrives of that Map Run. For more information, see Examining Map Run in the Step Functions Developer Guide.
This is a convenience which creates an instance of the
DescribeMapRunRequest.Builder
avoiding the need to create one manually viaDescribeMapRunRequest.builder()
- Parameters:
describeMapRunRequest
- AConsumer
that will call methods onDescribeMapRunRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeMapRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Could not find the referenced resource.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- 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.
- See Also:
-
describeStateMachine
default CompletableFuture<DescribeStateMachineResponse> describeStateMachine(DescribeStateMachineRequest describeStateMachineRequest) Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration.
A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.
The following are some examples of qualified and unqualified state machine ARNs:
-
The following qualified state machine ARN refers to a Distributed Map state with a label
mapStateLabel
in a state machine namedmyStateMachine
.arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with
ValidationException
. -
The following qualified state machine ARN refers to an alias named
PROD
.arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>
If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.
-
The following unqualified state machine ARN refers to a state machine named
myStateMachine
.arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>
This API action returns the details for a state machine version if the
stateMachineArn
you specify is a state machine version ARN.This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
- Parameters:
describeStateMachineRequest
-- Returns:
- A Java Future containing the result of the DescribeStateMachine operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- 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.
- See Also:
-
-
describeStateMachine
default CompletableFuture<DescribeStateMachineResponse> describeStateMachine(Consumer<DescribeStateMachineRequest.Builder> describeStateMachineRequest) Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration.
A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.
The following are some examples of qualified and unqualified state machine ARNs:
-
The following qualified state machine ARN refers to a Distributed Map state with a label
mapStateLabel
in a state machine namedmyStateMachine
.arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with
ValidationException
. -
The following qualified state machine ARN refers to an alias named
PROD
.arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>
If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.
-
The following unqualified state machine ARN refers to a state machine named
myStateMachine
.arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>
This API action returns the details for a state machine version if the
stateMachineArn
you specify is a state machine version ARN.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 viaDescribeStateMachineRequest.builder()
- Parameters:
describeStateMachineRequest
- AConsumer
that will call methods onDescribeStateMachineRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeStateMachine operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- 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.
- See Also:
-
-
describeStateMachineAlias
default CompletableFuture<DescribeStateMachineAliasResponse> describeStateMachineAlias(DescribeStateMachineAliasRequest describeStateMachineAliasRequest) Returns details about a state machine alias.
Related operations:
- Parameters:
describeStateMachineAliasRequest
-- Returns:
- A Java Future containing the result of the DescribeStateMachineAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- ResourceNotFoundException Could not find the referenced resource.
- 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.
- See Also:
-
describeStateMachineAlias
default CompletableFuture<DescribeStateMachineAliasResponse> describeStateMachineAlias(Consumer<DescribeStateMachineAliasRequest.Builder> describeStateMachineAliasRequest) Returns details about a state machine alias.
Related operations:
This is a convenience which creates an instance of the
DescribeStateMachineAliasRequest.Builder
avoiding the need to create one manually viaDescribeStateMachineAliasRequest.builder()
- Parameters:
describeStateMachineAliasRequest
- AConsumer
that will call methods onDescribeStateMachineAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeStateMachineAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- ResourceNotFoundException Could not find the referenced resource.
- 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.
- See Also:
-
describeStateMachineForExecution
default CompletableFuture<DescribeStateMachineForExecutionResponse> describeStateMachineForExecution(DescribeStateMachineForExecutionRequest describeStateMachineForExecutionRequest) Provides information about a state machine's definition, its execution role ARN, and configuration. If a Map Run dispatched the execution, this action returns the Map Run Amazon Resource Name (ARN) in the response. The state machine returned is the state machine associated with the Map Run.
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.- Parameters:
describeStateMachineForExecutionRequest
-- Returns:
- A Java Future containing the result of the DescribeStateMachineForExecution operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ExecutionDoesNotExistException The specified execution does not exist.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- 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.
- See Also:
-
describeStateMachineForExecution
default CompletableFuture<DescribeStateMachineForExecutionResponse> describeStateMachineForExecution(Consumer<DescribeStateMachineForExecutionRequest.Builder> describeStateMachineForExecutionRequest) Provides information about a state machine's definition, its execution role ARN, and configuration. If a Map Run dispatched the execution, this action returns the Map Run Amazon Resource Name (ARN) in the response. The state machine returned is the state machine associated with the Map Run.
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 viaDescribeStateMachineForExecutionRequest.builder()
- Parameters:
describeStateMachineForExecutionRequest
- AConsumer
that will call methods onDescribeStateMachineForExecutionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeStateMachineForExecution operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ExecutionDoesNotExistException The specified execution does not exist.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- 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.
- See Also:
-
getActivityTask
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.This API action isn't logged in CloudTrail.
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.- Parameters:
getActivityTaskRequest
-- Returns:
- A Java Future containing the result of the GetActivityTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 not valid.
- 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.
- See Also:
-
getActivityTask
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.This API action isn't logged in CloudTrail.
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 viaGetActivityTaskRequest.builder()
- Parameters:
getActivityTaskRequest
- AConsumer
that will call methods onGetActivityTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetActivityTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 not valid.
- 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.
- See Also:
-
getExecutionHistory
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 thereverseOrder
parameter to get the latest events first.If
nextToken
is returned, there are more results available. The value ofnextToken
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.- Parameters:
getExecutionHistoryRequest
-- Returns:
- A Java Future containing the result of the GetExecutionHistory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ExecutionDoesNotExistException The specified execution does not exist.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- InvalidTokenException The provided token is not valid.
- 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.
- See Also:
-
getExecutionHistory
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 thereverseOrder
parameter to get the latest events first.If
nextToken
is returned, there are more results available. The value ofnextToken
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 viaGetExecutionHistoryRequest.builder()
- Parameters:
getExecutionHistoryRequest
- AConsumer
that will call methods onGetExecutionHistoryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetExecutionHistory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ExecutionDoesNotExistException The specified execution does not exist.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- InvalidTokenException The provided token is not valid.
- 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.
- See Also:
-
getExecutionHistoryPaginator
default GetExecutionHistoryPublisher getExecutionHistoryPaginator(GetExecutionHistoryRequest getExecutionHistoryRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.sfn.paginators.GetExecutionHistoryPublisher publisher = client.getExecutionHistoryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
getExecutionHistoryRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ExecutionDoesNotExistException The specified execution does not exist.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- InvalidTokenException The provided token is not valid.
- 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.
- See Also:
-
getExecutionHistoryPaginator
default GetExecutionHistoryPublisher getExecutionHistoryPaginator(Consumer<GetExecutionHistoryRequest.Builder> getExecutionHistoryRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.sfn.paginators.GetExecutionHistoryPublisher publisher = client.getExecutionHistoryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaGetExecutionHistoryRequest.builder()
- Parameters:
getExecutionHistoryRequest
- AConsumer
that will call methods onGetExecutionHistoryRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ExecutionDoesNotExistException The specified execution does not exist.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- InvalidTokenException The provided token is not valid.
- 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.
- See Also:
-
listActivities
default CompletableFuture<ListActivitiesResponse> listActivities(ListActivitiesRequest listActivitiesRequest) Lists the existing activities.
If
nextToken
is returned, there are more results available. The value ofnextToken
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.
- Parameters:
listActivitiesRequest
-- Returns:
- A Java Future containing the result of the ListActivities operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidTokenException The provided token is not valid.
- 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.
- See Also:
-
listActivities
default CompletableFuture<ListActivitiesResponse> listActivities(Consumer<ListActivitiesRequest.Builder> listActivitiesRequest) Lists the existing activities.
If
nextToken
is returned, there are more results available. The value ofnextToken
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 viaListActivitiesRequest.builder()
- Parameters:
listActivitiesRequest
- AConsumer
that will call methods onListActivitiesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListActivities operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidTokenException The provided token is not valid.
- 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.
- See Also:
-
listActivities
Lists the existing activities.
If
nextToken
is returned, there are more results available. The value ofnextToken
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.
- Returns:
- A Java Future containing the result of the ListActivities operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidTokenException The provided token is not valid.
- 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.
- See Also:
-
listActivitiesPaginator
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 newSubscription
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 methodsoftware.amazon.awssdk.services.sfn.paginators.ListActivitiesPublisher publisher = client.listActivitiesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidTokenException The provided token is not valid.
- 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.
- See Also:
-
listActivitiesPaginator
default ListActivitiesPublisher listActivitiesPaginator(ListActivitiesRequest listActivitiesRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.sfn.paginators.ListActivitiesPublisher publisher = client.listActivitiesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listActivitiesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidTokenException The provided token is not valid.
- 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.
- See Also:
-
listActivitiesPaginator
default ListActivitiesPublisher listActivitiesPaginator(Consumer<ListActivitiesRequest.Builder> listActivitiesRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.sfn.paginators.ListActivitiesPublisher publisher = client.listActivitiesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListActivitiesRequest.builder()
- Parameters:
listActivitiesRequest
- AConsumer
that will call methods onListActivitiesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidTokenException The provided token is not valid.
- 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.
- See Also:
-
listExecutions
default CompletableFuture<ListExecutionsResponse> listExecutions(ListExecutionsRequest listExecutionsRequest) Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN. Using this API action, you can also list all redriven executions.
You can also provide a state machine alias ARN or version ARN to list the executions associated with a specific alias or version.
Results are sorted by time, with the most recent execution first.
If
nextToken
is returned, there are more results available. The value ofnextToken
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.- Parameters:
listExecutionsRequest
-- Returns:
- A Java Future containing the result of the ListExecutions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- InvalidTokenException The provided token is not valid.
- StateMachineDoesNotExistException The specified state machine does not exist.
- StateMachineTypeNotSupportedException
- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException Could not find the referenced resource.
- 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.
- See Also:
-
listExecutions
default CompletableFuture<ListExecutionsResponse> listExecutions(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest) Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN. Using this API action, you can also list all redriven executions.
You can also provide a state machine alias ARN or version ARN to list the executions associated with a specific alias or version.
Results are sorted by time, with the most recent execution first.
If
nextToken
is returned, there are more results available. The value ofnextToken
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 viaListExecutionsRequest.builder()
- Parameters:
listExecutionsRequest
- AConsumer
that will call methods onListExecutionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListExecutions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- InvalidTokenException The provided token is not valid.
- StateMachineDoesNotExistException The specified state machine does not exist.
- StateMachineTypeNotSupportedException
- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException Could not find the referenced resource.
- 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.
- See Also:
-
listExecutionsPaginator
default ListExecutionsPublisher listExecutionsPaginator(ListExecutionsRequest listExecutionsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.sfn.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listExecutionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- InvalidTokenException The provided token is not valid.
- StateMachineDoesNotExistException The specified state machine does not exist.
- StateMachineTypeNotSupportedException
- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException Could not find the referenced resource.
- 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.
- See Also:
-
listExecutionsPaginator
default ListExecutionsPublisher listExecutionsPaginator(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.sfn.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListExecutionsRequest.builder()
- Parameters:
listExecutionsRequest
- AConsumer
that will call methods onListExecutionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- InvalidTokenException The provided token is not valid.
- StateMachineDoesNotExistException The specified state machine does not exist.
- StateMachineTypeNotSupportedException
- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException Could not find the referenced resource.
- 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.
- See Also:
-
listMapRuns
Lists all Map Runs that were started by a given state machine execution. Use this API action to obtain Map Run ARNs, and then call
DescribeMapRun
to obtain more information, if needed.- Parameters:
listMapRunsRequest
-- Returns:
- A Java Future containing the result of the ListMapRuns operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ExecutionDoesNotExistException The specified execution does not exist.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- InvalidTokenException The provided token is not valid.
- 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.
- See Also:
-
listMapRuns
default CompletableFuture<ListMapRunsResponse> listMapRuns(Consumer<ListMapRunsRequest.Builder> listMapRunsRequest) Lists all Map Runs that were started by a given state machine execution. Use this API action to obtain Map Run ARNs, and then call
DescribeMapRun
to obtain more information, if needed.
This is a convenience which creates an instance of the
ListMapRunsRequest.Builder
avoiding the need to create one manually viaListMapRunsRequest.builder()
- Parameters:
listMapRunsRequest
- AConsumer
that will call methods onListMapRunsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListMapRuns operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ExecutionDoesNotExistException The specified execution does not exist.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- InvalidTokenException The provided token is not valid.
- 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.
- See Also:
-
listMapRunsPaginator
This is a variant of
listMapRuns(software.amazon.awssdk.services.sfn.model.ListMapRunsRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.sfn.paginators.ListMapRunsPublisher publisher = client.listMapRunsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.sfn.paginators.ListMapRunsPublisher publisher = client.listMapRunsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sfn.model.ListMapRunsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.sfn.model.ListMapRunsResponse response) { //... }; });
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
listMapRuns(software.amazon.awssdk.services.sfn.model.ListMapRunsRequest)
operation.- Parameters:
listMapRunsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ExecutionDoesNotExistException The specified execution does not exist.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- InvalidTokenException The provided token is not valid.
- 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.
- See Also:
-
listMapRunsPaginator
default ListMapRunsPublisher listMapRunsPaginator(Consumer<ListMapRunsRequest.Builder> listMapRunsRequest) This is a variant of
listMapRuns(software.amazon.awssdk.services.sfn.model.ListMapRunsRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.sfn.paginators.ListMapRunsPublisher publisher = client.listMapRunsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.sfn.paginators.ListMapRunsPublisher publisher = client.listMapRunsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sfn.model.ListMapRunsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.sfn.model.ListMapRunsResponse response) { //... }; });
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
listMapRuns(software.amazon.awssdk.services.sfn.model.ListMapRunsRequest)
operation.
This is a convenience which creates an instance of the
ListMapRunsRequest.Builder
avoiding the need to create one manually viaListMapRunsRequest.builder()
- Parameters:
listMapRunsRequest
- AConsumer
that will call methods onListMapRunsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ExecutionDoesNotExistException The specified execution does not exist.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- InvalidTokenException The provided token is not valid.
- 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.
- See Also:
-
listStateMachineAliases
default CompletableFuture<ListStateMachineAliasesResponse> listStateMachineAliases(ListStateMachineAliasesRequest listStateMachineAliasesRequest) Lists aliases for a specified state machine ARN. Results are sorted by time, with the most recently created aliases listed first.
To list aliases that reference a state machine version, you can specify the version ARN in the
stateMachineArn
parameter.If
nextToken
is returned, there are more results available. The value ofnextToken
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.Related operations:
- Parameters:
listStateMachineAliasesRequest
-- Returns:
- A Java Future containing the result of the ListStateMachineAliases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- InvalidTokenException The provided token is not valid.
- ResourceNotFoundException Could not find the referenced resource.
- 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.
- See Also:
-
listStateMachineAliases
default CompletableFuture<ListStateMachineAliasesResponse> listStateMachineAliases(Consumer<ListStateMachineAliasesRequest.Builder> listStateMachineAliasesRequest) Lists aliases for a specified state machine ARN. Results are sorted by time, with the most recently created aliases listed first.
To list aliases that reference a state machine version, you can specify the version ARN in the
stateMachineArn
parameter.If
nextToken
is returned, there are more results available. The value ofnextToken
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.Related operations:
This is a convenience which creates an instance of the
ListStateMachineAliasesRequest.Builder
avoiding the need to create one manually viaListStateMachineAliasesRequest.builder()
- Parameters:
listStateMachineAliasesRequest
- AConsumer
that will call methods onListStateMachineAliasesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListStateMachineAliases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- InvalidTokenException The provided token is not valid.
- ResourceNotFoundException Could not find the referenced resource.
- 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.
- See Also:
-
listStateMachineVersions
default CompletableFuture<ListStateMachineVersionsResponse> listStateMachineVersions(ListStateMachineVersionsRequest listStateMachineVersionsRequest) Lists versions for the specified state machine Amazon Resource Name (ARN).
The results are sorted in descending order of the version creation time.
If
nextToken
is returned, there are more results available. The value ofnextToken
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.Related operations:
- Parameters:
listStateMachineVersionsRequest
-- Returns:
- A Java Future containing the result of the ListStateMachineVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- InvalidTokenException The provided token is not valid.
- 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.
- See Also:
-
listStateMachineVersions
default CompletableFuture<ListStateMachineVersionsResponse> listStateMachineVersions(Consumer<ListStateMachineVersionsRequest.Builder> listStateMachineVersionsRequest) Lists versions for the specified state machine Amazon Resource Name (ARN).
The results are sorted in descending order of the version creation time.
If
nextToken
is returned, there are more results available. The value ofnextToken
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.Related operations:
This is a convenience which creates an instance of the
ListStateMachineVersionsRequest.Builder
avoiding the need to create one manually viaListStateMachineVersionsRequest.builder()
- Parameters:
listStateMachineVersionsRequest
- AConsumer
that will call methods onListStateMachineVersionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListStateMachineVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- InvalidTokenException The provided token is not valid.
- 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.
- See Also:
-
listStateMachines
default CompletableFuture<ListStateMachinesResponse> listStateMachines(ListStateMachinesRequest listStateMachinesRequest) Lists the existing state machines.
If
nextToken
is returned, there are more results available. The value ofnextToken
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.
- Parameters:
listStateMachinesRequest
-- Returns:
- A Java Future containing the result of the ListStateMachines operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidTokenException The provided token is not valid.
- 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.
- See Also:
-
listStateMachines
default CompletableFuture<ListStateMachinesResponse> listStateMachines(Consumer<ListStateMachinesRequest.Builder> listStateMachinesRequest) Lists the existing state machines.
If
nextToken
is returned, there are more results available. The value ofnextToken
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 viaListStateMachinesRequest.builder()
- Parameters:
listStateMachinesRequest
- AConsumer
that will call methods onListStateMachinesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListStateMachines operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidTokenException The provided token is not valid.
- 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.
- See Also:
-
listStateMachines
Lists the existing state machines.
If
nextToken
is returned, there are more results available. The value ofnextToken
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.
- Returns:
- A Java Future containing the result of the ListStateMachines operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidTokenException The provided token is not valid.
- 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.
- See Also:
-
listStateMachinesPaginator
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 newSubscription
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 methodsoftware.amazon.awssdk.services.sfn.paginators.ListStateMachinesPublisher publisher = client.listStateMachinesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidTokenException The provided token is not valid.
- 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.
- See Also:
-
listStateMachinesPaginator
default ListStateMachinesPublisher listStateMachinesPaginator(ListStateMachinesRequest listStateMachinesRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.sfn.paginators.ListStateMachinesPublisher publisher = client.listStateMachinesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listStateMachinesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidTokenException The provided token is not valid.
- 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.
- See Also:
-
listStateMachinesPaginator
default ListStateMachinesPublisher listStateMachinesPaginator(Consumer<ListStateMachinesRequest.Builder> listStateMachinesRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.sfn.paginators.ListStateMachinesPublisher publisher = client.listStateMachinesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListStateMachinesRequest.builder()
- Parameters:
listStateMachinesRequest
- AConsumer
that will call methods onListStateMachinesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidTokenException The provided token is not valid.
- 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.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) List tags for a given resource.
Tags may only contain Unicode letters, digits, white space, or these symbols:
_ . : / = + - @
.- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- ResourceNotFoundException Could not find the referenced resource.
- 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.
- See Also:
-
listTagsForResource
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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- ResourceNotFoundException Could not find the referenced resource.
- 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.
- See Also:
-
publishStateMachineVersion
default CompletableFuture<PublishStateMachineVersionResponse> publishStateMachineVersion(PublishStateMachineVersionRequest publishStateMachineVersionRequest) Creates a version from the current revision of a state machine. Use versions to create immutable snapshots of your state machine. You can start executions from versions either directly or with an alias. To create an alias, use CreateStateMachineAlias.
You can publish up to 1000 versions for each state machine. You must manually delete unused versions using the DeleteStateMachineVersion API action.
PublishStateMachineVersion
is an idempotent API. It doesn't create a duplicate state machine version if it already exists for the current revision. Step Functions basesPublishStateMachineVersion
's idempotency check on thestateMachineArn
,name
, andrevisionId
parameters. Requests with the same parameters return a successful idempotent response. If you don't specify arevisionId
, Step Functions checks for a previously published version of the state machine's current revision.Related operations:
- Parameters:
publishStateMachineVersionRequest
-- Returns:
- A Java Future containing the result of the PublishStateMachineVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- StateMachineDeletingException The specified state machine is being deleted.
- StateMachineDoesNotExistException The specified state machine does not exist.
- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
HTTP Status Code: 402
- ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs
when there're concurrent requests for DeleteStateMachineVersion,
PublishStateMachineVersion, or UpdateStateMachine with the
publish
parameter set totrue
.HTTP Status Code: 409
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- 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.
- See Also:
-
publishStateMachineVersion
default CompletableFuture<PublishStateMachineVersionResponse> publishStateMachineVersion(Consumer<PublishStateMachineVersionRequest.Builder> publishStateMachineVersionRequest) Creates a version from the current revision of a state machine. Use versions to create immutable snapshots of your state machine. You can start executions from versions either directly or with an alias. To create an alias, use CreateStateMachineAlias.
You can publish up to 1000 versions for each state machine. You must manually delete unused versions using the DeleteStateMachineVersion API action.
PublishStateMachineVersion
is an idempotent API. It doesn't create a duplicate state machine version if it already exists for the current revision. Step Functions basesPublishStateMachineVersion
's idempotency check on thestateMachineArn
,name
, andrevisionId
parameters. Requests with the same parameters return a successful idempotent response. If you don't specify arevisionId
, Step Functions checks for a previously published version of the state machine's current revision.Related operations:
This is a convenience which creates an instance of the
PublishStateMachineVersionRequest.Builder
avoiding the need to create one manually viaPublishStateMachineVersionRequest.builder()
- Parameters:
publishStateMachineVersionRequest
- AConsumer
that will call methods onPublishStateMachineVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PublishStateMachineVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- StateMachineDeletingException The specified state machine is being deleted.
- StateMachineDoesNotExistException The specified state machine does not exist.
- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
HTTP Status Code: 402
- ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs
when there're concurrent requests for DeleteStateMachineVersion,
PublishStateMachineVersion, or UpdateStateMachine with the
publish
parameter set totrue
.HTTP Status Code: 409
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- 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.
- See Also:
-
redriveExecution
default CompletableFuture<RedriveExecutionResponse> redriveExecution(RedriveExecutionRequest redriveExecutionRequest) Restarts unsuccessful executions of Standard workflows that didn't complete successfully in the last 14 days. These include failed, aborted, or timed out executions. When you redrive an execution, it continues the failed execution from the unsuccessful step and uses the same input. Step Functions preserves the results and execution history of the successful steps, and doesn't rerun these steps when you redrive an execution. Redriven executions use the same state machine definition and execution ARN as the original execution attempt.
For workflows that include an Inline Map or Parallel state,
RedriveExecution
API action reschedules and redrives only the iterations and branches that failed or aborted.To redrive a workflow that includes a Distributed Map state whose Map Run failed, you must redrive the parent workflow. The parent workflow redrives all the unsuccessful states, including a failed Map Run. If a Map Run was not started in the original execution attempt, the redriven parent workflow starts the Map Run.
This API action is not supported by
EXPRESS
state machines.However, you can restart the unsuccessful executions of Express child workflows in a Distributed Map by redriving its Map Run. When you redrive a Map Run, the Express child workflows are rerun using the StartExecution API action. For more information, see Redriving Map Runs.
You can redrive executions if your original execution meets the following conditions:
-
The execution status isn't
SUCCEEDED
. -
Your workflow execution has not exceeded the redrivable period of 14 days. Redrivable period refers to the time during which you can redrive a given execution. This period starts from the day a state machine completes its execution.
-
The workflow execution has not exceeded the maximum open time of one year. For more information about state machine quotas, see Quotas related to state machine executions.
-
The execution event history count is less than 24,999. Redriven executions append their event history to the existing event history. Make sure your workflow execution contains less than 24,999 events to accommodate the
ExecutionRedriven
history event and at least one other history event.
- Parameters:
redriveExecutionRequest
-- Returns:
- A Java Future containing the result of the RedriveExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ExecutionDoesNotExistException The specified execution does not exist.
- ExecutionNotRedrivableException The execution Amazon Resource Name (ARN) that you specified for
executionArn
cannot be redriven. - ExecutionLimitExceededException The maximum number of running executions has been reached. Running executions must end or be stopped before a new execution can be started.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- 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.
- See Also:
-
-
redriveExecution
default CompletableFuture<RedriveExecutionResponse> redriveExecution(Consumer<RedriveExecutionRequest.Builder> redriveExecutionRequest) Restarts unsuccessful executions of Standard workflows that didn't complete successfully in the last 14 days. These include failed, aborted, or timed out executions. When you redrive an execution, it continues the failed execution from the unsuccessful step and uses the same input. Step Functions preserves the results and execution history of the successful steps, and doesn't rerun these steps when you redrive an execution. Redriven executions use the same state machine definition and execution ARN as the original execution attempt.
For workflows that include an Inline Map or Parallel state,
RedriveExecution
API action reschedules and redrives only the iterations and branches that failed or aborted.To redrive a workflow that includes a Distributed Map state whose Map Run failed, you must redrive the parent workflow. The parent workflow redrives all the unsuccessful states, including a failed Map Run. If a Map Run was not started in the original execution attempt, the redriven parent workflow starts the Map Run.
This API action is not supported by
EXPRESS
state machines.However, you can restart the unsuccessful executions of Express child workflows in a Distributed Map by redriving its Map Run. When you redrive a Map Run, the Express child workflows are rerun using the StartExecution API action. For more information, see Redriving Map Runs.
You can redrive executions if your original execution meets the following conditions:
-
The execution status isn't
SUCCEEDED
. -
Your workflow execution has not exceeded the redrivable period of 14 days. Redrivable period refers to the time during which you can redrive a given execution. This period starts from the day a state machine completes its execution.
-
The workflow execution has not exceeded the maximum open time of one year. For more information about state machine quotas, see Quotas related to state machine executions.
-
The execution event history count is less than 24,999. Redriven executions append their event history to the existing event history. Make sure your workflow execution contains less than 24,999 events to accommodate the
ExecutionRedriven
history event and at least one other history event.
This is a convenience which creates an instance of the
RedriveExecutionRequest.Builder
avoiding the need to create one manually viaRedriveExecutionRequest.builder()
- Parameters:
redriveExecutionRequest
- AConsumer
that will call methods onRedriveExecutionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RedriveExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ExecutionDoesNotExistException The specified execution does not exist.
- ExecutionNotRedrivableException The execution Amazon Resource Name (ARN) that you specified for
executionArn
cannot be redriven. - ExecutionLimitExceededException The maximum number of running executions has been reached. Running executions must end or be stopped before a new execution can be started.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- 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.
- See Also:
-
-
sendTaskFailure
default CompletableFuture<SendTaskFailureResponse> sendTaskFailure(SendTaskFailureRequest sendTaskFailureRequest) Used by activity workers, Task states using the callback pattern, and optionally Task states using the job run pattern to report that the task identified by the
taskToken
failed.- Parameters:
sendTaskFailureRequest
-- Returns:
- A Java Future containing the result of the SendTaskFailure operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TaskDoesNotExistException The activity does not exist.
- InvalidTokenException The provided token is not valid.
- TaskTimedOutException The task token has either expired or the task associated with the token has already been closed.
- 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.
- See Also:
-
sendTaskFailure
default CompletableFuture<SendTaskFailureResponse> sendTaskFailure(Consumer<SendTaskFailureRequest.Builder> sendTaskFailureRequest) Used by activity workers, Task states using the callback pattern, and optionally Task states using the job run 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 viaSendTaskFailureRequest.builder()
- Parameters:
sendTaskFailureRequest
- AConsumer
that will call methods onSendTaskFailureRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SendTaskFailure operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TaskDoesNotExistException The activity does not exist.
- InvalidTokenException The provided token is not valid.
- TaskTimedOutException The task token has either expired or the task associated with the token has already been closed.
- 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.
- See Also:
-
sendTaskHeartbeat
default CompletableFuture<SendTaskHeartbeatResponse> sendTaskHeartbeat(SendTaskHeartbeatRequest sendTaskHeartbeatRequest) Used by activity workers and Task states using the callback pattern, and optionally Task states using the job run pattern to report to Step Functions that the task represented by the specified
taskToken
is still making progress. This action resets theHeartbeat
clock. TheHeartbeat
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 anActivityTimedOut
entry for activities, or aTaskTimedOut
entry 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. UseHeartbeatSeconds
to configure the timeout interval for heartbeats.- Parameters:
sendTaskHeartbeatRequest
-- Returns:
- A Java Future containing the result of the SendTaskHeartbeat operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TaskDoesNotExistException The activity does not exist.
- InvalidTokenException The provided token is not valid.
- TaskTimedOutException The task token has either expired or the task associated with the token has already been closed.
- 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.
- See Also:
-
sendTaskHeartbeat
default CompletableFuture<SendTaskHeartbeatResponse> sendTaskHeartbeat(Consumer<SendTaskHeartbeatRequest.Builder> sendTaskHeartbeatRequest) Used by activity workers and Task states using the callback pattern, and optionally Task states using the job run pattern to report to Step Functions that the task represented by the specified
taskToken
is still making progress. This action resets theHeartbeat
clock. TheHeartbeat
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 anActivityTimedOut
entry for activities, or aTaskTimedOut
entry 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. UseHeartbeatSeconds
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 viaSendTaskHeartbeatRequest.builder()
- Parameters:
sendTaskHeartbeatRequest
- AConsumer
that will call methods onSendTaskHeartbeatRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SendTaskHeartbeat operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TaskDoesNotExistException The activity does not exist.
- InvalidTokenException The provided token is not valid.
- TaskTimedOutException The task token has either expired or the task associated with the token has already been closed.
- 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.
- See Also:
-
sendTaskSuccess
default CompletableFuture<SendTaskSuccessResponse> sendTaskSuccess(SendTaskSuccessRequest sendTaskSuccessRequest) Used by activity workers, Task states using the callback pattern, and optionally Task states using the job run pattern to report that the task identified by the
taskToken
completed successfully.- Parameters:
sendTaskSuccessRequest
-- Returns:
- A Java Future containing the result of the SendTaskSuccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TaskDoesNotExistException The activity does not exist.
- InvalidOutputException The provided JSON output data is not valid.
- InvalidTokenException The provided token is not valid.
- TaskTimedOutException The task token has either expired or the task associated with the token has already been closed.
- 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.
- See Also:
-
sendTaskSuccess
default CompletableFuture<SendTaskSuccessResponse> sendTaskSuccess(Consumer<SendTaskSuccessRequest.Builder> sendTaskSuccessRequest) Used by activity workers, Task states using the callback pattern, and optionally Task states using the job run 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 viaSendTaskSuccessRequest.builder()
- Parameters:
sendTaskSuccessRequest
- AConsumer
that will call methods onSendTaskSuccessRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SendTaskSuccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- TaskDoesNotExistException The activity does not exist.
- InvalidOutputException The provided JSON output data is not valid.
- InvalidTokenException The provided token is not valid.
- TaskTimedOutException The task token has either expired or the task associated with the token has already been closed.
- 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.
- See Also:
-
startExecution
default CompletableFuture<StartExecutionResponse> startExecution(StartExecutionRequest startExecutionRequest) Starts a state machine execution.
A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.
The following are some examples of qualified and unqualified state machine ARNs:
-
The following qualified state machine ARN refers to a Distributed Map state with a label
mapStateLabel
in a state machine namedmyStateMachine
.arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with
ValidationException
. -
The following qualified state machine ARN refers to an alias named
PROD
.arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>
If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.
-
The following unqualified state machine ARN refers to a state machine named
myStateMachine
.arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>
If you start an execution with an unqualified state machine ARN, Step Functions uses the latest revision of the state machine for the execution.
To start executions of a state machine version, call
StartExecution
and provide the version ARN or the ARN of an alias that points to the version.StartExecution
is idempotent forSTANDARD
workflows. For aSTANDARD
workflow, if you callStartExecution
with the same name and input as a running execution, the call succeeds and return the same response as the original request. If the execution is closed or if the input is different, it returns a400 ExecutionAlreadyExists
error. You can reuse names after 90 days.StartExecution
isn't idempotent forEXPRESS
workflows.- Parameters:
startExecutionRequest
-- Returns:
- A Java Future containing the result of the StartExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 differentinput
).Executions with the same
name
andinput
are considered idempotent. - InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- InvalidExecutionInputException The provided JSON input data is not valid.
- InvalidNameException The provided name is not valid.
- StateMachineDoesNotExistException The specified state machine does not exist.
- StateMachineDeletingException The specified state machine is being deleted.
- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- 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.
- See Also:
-
-
startExecution
default CompletableFuture<StartExecutionResponse> startExecution(Consumer<StartExecutionRequest.Builder> startExecutionRequest) Starts a state machine execution.
A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.
The following are some examples of qualified and unqualified state machine ARNs:
-
The following qualified state machine ARN refers to a Distributed Map state with a label
mapStateLabel
in a state machine namedmyStateMachine
.arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with
ValidationException
. -
The following qualified state machine ARN refers to an alias named
PROD
.arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>
If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.
-
The following unqualified state machine ARN refers to a state machine named
myStateMachine
.arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>
If you start an execution with an unqualified state machine ARN, Step Functions uses the latest revision of the state machine for the execution.
To start executions of a state machine version, call
StartExecution
and provide the version ARN or the ARN of an alias that points to the version.StartExecution
is idempotent forSTANDARD
workflows. For aSTANDARD
workflow, if you callStartExecution
with the same name and input as a running execution, the call succeeds and return the same response as the original request. If the execution is closed or if the input is different, it returns a400 ExecutionAlreadyExists
error. You can reuse names after 90 days.StartExecution
isn't idempotent forEXPRESS
workflows.
This is a convenience which creates an instance of the
StartExecutionRequest.Builder
avoiding the need to create one manually viaStartExecutionRequest.builder()
- Parameters:
startExecutionRequest
- AConsumer
that will call methods onStartExecutionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 differentinput
).Executions with the same
name
andinput
are considered idempotent. - InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- InvalidExecutionInputException The provided JSON input data is not valid.
- InvalidNameException The provided name is not valid.
- StateMachineDoesNotExistException The specified state machine does not exist.
- StateMachineDeletingException The specified state machine is being deleted.
- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- 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.
- See Also:
-
-
startSyncExecution
default CompletableFuture<StartSyncExecutionResponse> startSyncExecution(StartSyncExecutionRequest startSyncExecutionRequest) Starts a Synchronous Express state machine execution.
StartSyncExecution
is not available forSTANDARD
workflows.StartSyncExecution
will return a200 OK
response, even if your execution fails, because the status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your execution from running, such as permissions errors, limit errors, or issues with your state machine code and configuration.This API action isn't logged in CloudTrail.
- Parameters:
startSyncExecutionRequest
-- Returns:
- A Java Future containing the result of the StartSyncExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- InvalidExecutionInputException The provided JSON input data is not valid.
- InvalidNameException The provided name is not valid.
- StateMachineDoesNotExistException The specified state machine does not exist.
- StateMachineDeletingException The specified state machine is being deleted.
- StateMachineTypeNotSupportedException
- 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.
- See Also:
-
startSyncExecution
default CompletableFuture<StartSyncExecutionResponse> startSyncExecution(Consumer<StartSyncExecutionRequest.Builder> startSyncExecutionRequest) Starts a Synchronous Express state machine execution.
StartSyncExecution
is not available forSTANDARD
workflows.StartSyncExecution
will return a200 OK
response, even if your execution fails, because the status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your execution from running, such as permissions errors, limit errors, or issues with your state machine code and configuration.This API action isn't logged in CloudTrail.
This is a convenience which creates an instance of the
StartSyncExecutionRequest.Builder
avoiding the need to create one manually viaStartSyncExecutionRequest.builder()
- Parameters:
startSyncExecutionRequest
- AConsumer
that will call methods onStartSyncExecutionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartSyncExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- InvalidExecutionInputException The provided JSON input data is not valid.
- InvalidNameException The provided name is not valid.
- StateMachineDoesNotExistException The specified state machine does not exist.
- StateMachineDeletingException The specified state machine is being deleted.
- StateMachineTypeNotSupportedException
- 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.
- See Also:
-
stopExecution
default CompletableFuture<StopExecutionResponse> stopExecution(StopExecutionRequest stopExecutionRequest) Stops an execution.
This API action is not supported by
EXPRESS
state machines.- Parameters:
stopExecutionRequest
-- Returns:
- A Java Future containing the result of the StopExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ExecutionDoesNotExistException The specified execution does not exist.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- 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.
- See Also:
-
stopExecution
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 viaStopExecutionRequest.builder()
- Parameters:
stopExecutionRequest
- AConsumer
that will call methods onStopExecutionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ExecutionDoesNotExistException The specified execution does not exist.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- 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.
- See Also:
-
tagResource
Add a tag to a Step Functions resource.
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these symbols:
_ . : / = + - @
.- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- ResourceNotFoundException Could not find the referenced resource.
- TooManyTagsException You've exceeded the number of tags allowed for a resource. See the Limits Topic in the Step Functions Developer Guide.
- 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.
- See Also:
-
tagResource
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 Amazon Web Services 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 viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- ResourceNotFoundException Could not find the referenced resource.
- TooManyTagsException You've exceeded the number of tags allowed for a resource. See the Limits Topic in the Step Functions Developer Guide.
- 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.
- See Also:
-
testState
Accepts the definition of a single state and executes it. You can test a state without creating a state machine or updating an existing state machine. Using this API, you can test the following:
-
A state's input and output processing data flow
-
An Amazon Web Services service integration request and response
-
An HTTP Task request and response
You can call this API on only one state at a time. The states that you can test include the following:
The
TestState
API assumes an IAM role which must contain the required IAM permissions for the resources your state is accessing. For information about the permissions a state might need, see IAM permissions to test a state.The
TestState
API can run for up to five minutes. If the execution of a state exceeds this duration, it fails with theStates.Timeout
error.TestState
doesn't support Activity tasks,.sync
or.waitForTaskToken
service integration patterns, Parallel, or Map states.- Parameters:
testStateRequest
-- Returns:
- A Java Future containing the result of the TestState operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- InvalidDefinitionException The provided Amazon States Language definition is not valid.
- InvalidExecutionInputException The provided JSON input data is not valid.
- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- 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.
- See Also:
-
-
testState
default CompletableFuture<TestStateResponse> testState(Consumer<TestStateRequest.Builder> testStateRequest) Accepts the definition of a single state and executes it. You can test a state without creating a state machine or updating an existing state machine. Using this API, you can test the following:
-
A state's input and output processing data flow
-
An Amazon Web Services service integration request and response
-
An HTTP Task request and response
You can call this API on only one state at a time. The states that you can test include the following:
The
TestState
API assumes an IAM role which must contain the required IAM permissions for the resources your state is accessing. For information about the permissions a state might need, see IAM permissions to test a state.The
TestState
API can run for up to five minutes. If the execution of a state exceeds this duration, it fails with theStates.Timeout
error.TestState
doesn't support Activity tasks,.sync
or.waitForTaskToken
service integration patterns, Parallel, or Map states.
This is a convenience which creates an instance of the
TestStateRequest.Builder
avoiding the need to create one manually viaTestStateRequest.builder()
- Parameters:
testStateRequest
- AConsumer
that will call methods onTestStateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TestState operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- InvalidDefinitionException The provided Amazon States Language definition is not valid.
- InvalidExecutionInputException The provided JSON input data is not valid.
- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- 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.
- See Also:
-
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Remove a tag from a Step Functions resource
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- ResourceNotFoundException Could not find the referenced resource.
- 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.
- See Also:
-
untagResource
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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- ResourceNotFoundException Could not find the referenced resource.
- 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.
- See Also:
-
updateMapRun
default CompletableFuture<UpdateMapRunResponse> updateMapRun(UpdateMapRunRequest updateMapRunRequest) Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure.
- Parameters:
updateMapRunRequest
-- Returns:
- A Java Future containing the result of the UpdateMapRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Could not find the referenced resource.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- 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.
- See Also:
-
updateMapRun
default CompletableFuture<UpdateMapRunResponse> updateMapRun(Consumer<UpdateMapRunRequest.Builder> updateMapRunRequest) Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure.
This is a convenience which creates an instance of the
UpdateMapRunRequest.Builder
avoiding the need to create one manually viaUpdateMapRunRequest.builder()
- Parameters:
updateMapRunRequest
- AConsumer
that will call methods onUpdateMapRunRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateMapRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException Could not find the referenced resource.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- 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.
- See Also:
-
updateStateMachine
default CompletableFuture<UpdateStateMachineResponse> updateStateMachine(UpdateStateMachineRequest updateStateMachineRequest) Updates an existing state machine by modifying its
definition
,roleArn
, orloggingConfiguration
. Running executions will continue to use the previousdefinition
androleArn
. You must include at least one ofdefinition
orroleArn
or you will receive aMissingRequiredParameter
error.A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN
arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel
refers to a Distributed Map state with a labelmapStateLabel
in the state machine namedstateMachineName
.A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.
The following are some examples of qualified and unqualified state machine ARNs:
-
The following qualified state machine ARN refers to a Distributed Map state with a label
mapStateLabel
in a state machine namedmyStateMachine
.arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with
ValidationException
. -
The following qualified state machine ARN refers to an alias named
PROD
.arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>
If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.
-
The following unqualified state machine ARN refers to a state machine named
myStateMachine
.arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>
After you update your state machine, you can set the
publish
parameter totrue
in the same action to publish a new version. This way, you can opt-in to strict versioning of your state machine.Step Functions assigns monotonically increasing integers for state machine versions, starting at version number 1.
All
StartExecution
calls within a few seconds use the updateddefinition
androleArn
. Executions started immediately after you callUpdateStateMachine
may use the previous state machinedefinition
androleArn
.- Parameters:
updateStateMachineRequest
-- Returns:
- A Java Future containing the result of the UpdateStateMachine operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- InvalidDefinitionException The provided Amazon States Language definition is not valid.
- InvalidLoggingConfigurationException
- InvalidTracingConfigurationException Your
tracingConfiguration
key does not match, orenabled
has not been set totrue
orfalse
. - MissingRequiredParameterException Request is missing a required parameter. This error occurs if both
definition
androleArn
are not specified. - StateMachineDeletingException The specified state machine is being deleted.
- StateMachineDoesNotExistException The specified state machine does not exist.
- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
HTTP Status Code: 402
- ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs
when there're concurrent requests for DeleteStateMachineVersion,
PublishStateMachineVersion, or UpdateStateMachine with the
publish
parameter set totrue
.HTTP Status Code: 409
- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- 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.
- See Also:
-
-
updateStateMachine
default CompletableFuture<UpdateStateMachineResponse> updateStateMachine(Consumer<UpdateStateMachineRequest.Builder> updateStateMachineRequest) Updates an existing state machine by modifying its
definition
,roleArn
, orloggingConfiguration
. Running executions will continue to use the previousdefinition
androleArn
. You must include at least one ofdefinition
orroleArn
or you will receive aMissingRequiredParameter
error.A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN
arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel
refers to a Distributed Map state with a labelmapStateLabel
in the state machine namedstateMachineName
.A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.
The following are some examples of qualified and unqualified state machine ARNs:
-
The following qualified state machine ARN refers to a Distributed Map state with a label
mapStateLabel
in a state machine namedmyStateMachine
.arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with
ValidationException
. -
The following qualified state machine ARN refers to an alias named
PROD
.arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>
If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.
-
The following unqualified state machine ARN refers to a state machine named
myStateMachine
.arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>
After you update your state machine, you can set the
publish
parameter totrue
in the same action to publish a new version. This way, you can opt-in to strict versioning of your state machine.Step Functions assigns monotonically increasing integers for state machine versions, starting at version number 1.
All
StartExecution
calls within a few seconds use the updateddefinition
androleArn
. Executions started immediately after you callUpdateStateMachine
may use the previous state machinedefinition
androleArn
.
This is a convenience which creates an instance of the
UpdateStateMachineRequest.Builder
avoiding the need to create one manually viaUpdateStateMachineRequest.builder()
- Parameters:
updateStateMachineRequest
- AConsumer
that will call methods onUpdateStateMachineRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateStateMachine operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- InvalidDefinitionException The provided Amazon States Language definition is not valid.
- InvalidLoggingConfigurationException
- InvalidTracingConfigurationException Your
tracingConfiguration
key does not match, orenabled
has not been set totrue
orfalse
. - MissingRequiredParameterException Request is missing a required parameter. This error occurs if both
definition
androleArn
are not specified. - StateMachineDeletingException The specified state machine is being deleted.
- StateMachineDoesNotExistException The specified state machine does not exist.
- ServiceQuotaExceededException The request would cause a service quota to be exceeded.
HTTP Status Code: 402
- ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs
when there're concurrent requests for DeleteStateMachineVersion,
PublishStateMachineVersion, or UpdateStateMachine with the
publish
parameter set totrue
.HTTP Status Code: 409
- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- 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.
- See Also:
-
-
updateStateMachineAlias
default CompletableFuture<UpdateStateMachineAliasResponse> updateStateMachineAlias(UpdateStateMachineAliasRequest updateStateMachineAliasRequest) Updates the configuration of an existing state machine alias by modifying its
description
orroutingConfiguration
.You must specify at least one of the
description
orroutingConfiguration
parameters to update a state machine alias.UpdateStateMachineAlias
is an idempotent API. Step Functions bases the idempotency check on thestateMachineAliasArn
,description
, androutingConfiguration
parameters. Requests with the same parameters return an idempotent response.This operation is eventually consistent. All StartExecution requests made within a few seconds use the latest alias configuration. Executions started immediately after calling
UpdateStateMachineAlias
may use the previous routing configuration.Related operations:
- Parameters:
updateStateMachineAliasRequest
-- Returns:
- A Java Future containing the result of the UpdateStateMachineAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- ResourceNotFoundException Could not find the referenced resource.
- ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs
when there're concurrent requests for DeleteStateMachineVersion,
PublishStateMachineVersion, or UpdateStateMachine with the
publish
parameter set totrue
.HTTP Status Code: 409
- 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.
- See Also:
-
updateStateMachineAlias
default CompletableFuture<UpdateStateMachineAliasResponse> updateStateMachineAlias(Consumer<UpdateStateMachineAliasRequest.Builder> updateStateMachineAliasRequest) Updates the configuration of an existing state machine alias by modifying its
description
orroutingConfiguration
.You must specify at least one of the
description
orroutingConfiguration
parameters to update a state machine alias.UpdateStateMachineAlias
is an idempotent API. Step Functions bases the idempotency check on thestateMachineAliasArn
,description
, androutingConfiguration
parameters. Requests with the same parameters return an idempotent response.This operation is eventually consistent. All StartExecution requests made within a few seconds use the latest alias configuration. Executions started immediately after calling
UpdateStateMachineAlias
may use the previous routing configuration.Related operations:
This is a convenience which creates an instance of the
UpdateStateMachineAliasRequest.Builder
avoiding the need to create one manually viaUpdateStateMachineAliasRequest.builder()
- Parameters:
updateStateMachineAliasRequest
- AConsumer
that will call methods onUpdateStateMachineAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateStateMachineAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
- ResourceNotFoundException Could not find the referenced resource.
- ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs
when there're concurrent requests for DeleteStateMachineVersion,
PublishStateMachineVersion, or UpdateStateMachine with the
publish
parameter set totrue
.HTTP Status Code: 409
- 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.
- See Also:
-
validateStateMachineDefinition
default CompletableFuture<ValidateStateMachineDefinitionResponse> validateStateMachineDefinition(ValidateStateMachineDefinitionRequest validateStateMachineDefinitionRequest) Validates the syntax of a state machine definition.
You can validate that a state machine definition is correct without creating a state machine resource. Step Functions will implicitly perform the same syntax check when you invoke
CreateStateMachine
andUpdateStateMachine
. State machine definitions are specified using a JSON-based, structured language. For more information on Amazon States Language see Amazon States Language (ASL).Suggested uses for
ValidateStateMachineDefinition
:-
Integrate automated checks into your code review or Continuous Integration (CI) process to validate state machine definitions before starting deployments.
-
Run the validation from a Git pre-commit hook to check your state machine definitions before committing them to your source repository.
Errors found in the state machine definition will be returned in the response as a list of diagnostic elements, rather than raise an exception.
- Parameters:
validateStateMachineDefinitionRequest
-- Returns:
- A Java Future containing the result of the ValidateStateMachineDefinition operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- 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.
- See Also:
-
-
validateStateMachineDefinition
default CompletableFuture<ValidateStateMachineDefinitionResponse> validateStateMachineDefinition(Consumer<ValidateStateMachineDefinitionRequest.Builder> validateStateMachineDefinitionRequest) Validates the syntax of a state machine definition.
You can validate that a state machine definition is correct without creating a state machine resource. Step Functions will implicitly perform the same syntax check when you invoke
CreateStateMachine
andUpdateStateMachine
. State machine definitions are specified using a JSON-based, structured language. For more information on Amazon States Language see Amazon States Language (ASL).Suggested uses for
ValidateStateMachineDefinition
:-
Integrate automated checks into your code review or Continuous Integration (CI) process to validate state machine definitions before starting deployments.
-
Run the validation from a Git pre-commit hook to check your state machine definitions before committing them to your source repository.
Errors found in the state machine definition will be returned in the response as a list of diagnostic elements, rather than raise an exception.
This is a convenience which creates an instance of the
ValidateStateMachineDefinitionRequest.Builder
avoiding the need to create one manually viaValidateStateMachineDefinitionRequest.builder()
- Parameters:
validateStateMachineDefinitionRequest
- AConsumer
that will call methods onValidateStateMachineDefinitionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ValidateStateMachineDefinition operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
- 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.
- See Also:
-
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aSfnAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aSfnAsyncClient
.
-