Interface SfnClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface SfnClient
extends AwsClient

Service client for accessing AWS SFN. This can be created using the static builder() method. Step Functions

Step Functions coordinates 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

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static SfnClientBuilder	builder()	Create a builder that can be used to configure and create a SfnClient.
static SfnClient	create()	Create a SfnClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateActivityResponse	createActivity(Consumer<CreateActivityRequest.Builder> createActivityRequest)	Creates an activity.
default CreateActivityResponse	createActivity(CreateActivityRequest createActivityRequest)	Creates an activity.
default CreateStateMachineResponse	createStateMachine(Consumer<CreateStateMachineRequest.Builder> createStateMachineRequest)	Creates a state machine.
default CreateStateMachineResponse	createStateMachine(CreateStateMachineRequest createStateMachineRequest)	Creates a state machine.
default 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.
default CreateStateMachineAliasResponse	createStateMachineAlias(CreateStateMachineAliasRequest createStateMachineAliasRequest)	Creates an alias for a state machine that points to one or two versions of the same state machine.
default DeleteActivityResponse	deleteActivity(Consumer<DeleteActivityRequest.Builder> deleteActivityRequest)	Deletes an activity.
default DeleteActivityResponse	deleteActivity(DeleteActivityRequest deleteActivityRequest)	Deletes an activity.
default DeleteStateMachineResponse	deleteStateMachine(Consumer<DeleteStateMachineRequest.Builder> deleteStateMachineRequest)	Deletes a state machine.
default DeleteStateMachineResponse	deleteStateMachine(DeleteStateMachineRequest deleteStateMachineRequest)	Deletes a state machine.
default DeleteStateMachineAliasResponse	deleteStateMachineAlias(Consumer<DeleteStateMachineAliasRequest.Builder> deleteStateMachineAliasRequest)	Deletes a state machine alias.
default DeleteStateMachineAliasResponse	deleteStateMachineAlias(DeleteStateMachineAliasRequest deleteStateMachineAliasRequest)	Deletes a state machine alias.
default DeleteStateMachineVersionResponse	deleteStateMachineVersion(Consumer<DeleteStateMachineVersionRequest.Builder> deleteStateMachineVersionRequest)	Deletes a state machine version.
default DeleteStateMachineVersionResponse	deleteStateMachineVersion(DeleteStateMachineVersionRequest deleteStateMachineVersionRequest)	Deletes a state machine version.
default DescribeActivityResponse	describeActivity(Consumer<DescribeActivityRequest.Builder> describeActivityRequest)	Describes an activity.
default DescribeActivityResponse	describeActivity(DescribeActivityRequest describeActivityRequest)	Describes an activity.
default DescribeExecutionResponse	describeExecution(Consumer<DescribeExecutionRequest.Builder> describeExecutionRequest)	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 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.
default DescribeMapRunResponse	describeMapRun(Consumer<DescribeMapRunRequest.Builder> describeMapRunRequest)	Provides information about a Map Run's configuration, progress, and results.
default DescribeMapRunResponse	describeMapRun(DescribeMapRunRequest describeMapRunRequest)	Provides information about a Map Run's configuration, progress, and results.
default DescribeStateMachineResponse	describeStateMachine(Consumer<DescribeStateMachineRequest.Builder> describeStateMachineRequest)	Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration.
default DescribeStateMachineResponse	describeStateMachine(DescribeStateMachineRequest describeStateMachineRequest)	Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration.
default DescribeStateMachineAliasResponse	describeStateMachineAlias(Consumer<DescribeStateMachineAliasRequest.Builder> describeStateMachineAliasRequest)	Returns details about a state machine alias.
default DescribeStateMachineAliasResponse	describeStateMachineAlias(DescribeStateMachineAliasRequest describeStateMachineAliasRequest)	Returns details about a state machine alias.
default DescribeStateMachineForExecutionResponse	describeStateMachineForExecution(Consumer<DescribeStateMachineForExecutionRequest.Builder> describeStateMachineForExecutionRequest)	Provides information about a state machine's definition, its execution role ARN, and configuration.
default DescribeStateMachineForExecutionResponse	describeStateMachineForExecution(DescribeStateMachineForExecutionRequest describeStateMachineForExecutionRequest)	Provides information about a state machine's definition, its execution role ARN, and configuration.
default GetActivityTaskResponse	getActivityTask(Consumer<GetActivityTaskRequest.Builder> getActivityTaskRequest)	Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine.
default GetActivityTaskResponse	getActivityTask(GetActivityTaskRequest getActivityTaskRequest)	Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine.
default GetExecutionHistoryResponse	getExecutionHistory(Consumer<GetExecutionHistoryRequest.Builder> getExecutionHistoryRequest)	Returns the history of the specified execution as a list of events.
default GetExecutionHistoryResponse	getExecutionHistory(GetExecutionHistoryRequest getExecutionHistoryRequest)	Returns the history of the specified execution as a list of events.
default GetExecutionHistoryIterable	getExecutionHistoryPaginator(Consumer<GetExecutionHistoryRequest.Builder> getExecutionHistoryRequest)	This is a variant of getExecutionHistory(software.amazon.awssdk.services.sfn.model.GetExecutionHistoryRequest) operation.
default GetExecutionHistoryIterable	getExecutionHistoryPaginator(GetExecutionHistoryRequest getExecutionHistoryRequest)	This is a variant of getExecutionHistory(software.amazon.awssdk.services.sfn.model.GetExecutionHistoryRequest) operation.
default ListActivitiesResponse	listActivities()	Lists the existing activities.
default ListActivitiesResponse	listActivities(Consumer<ListActivitiesRequest.Builder> listActivitiesRequest)	Lists the existing activities.
default ListActivitiesResponse	listActivities(ListActivitiesRequest listActivitiesRequest)	Lists the existing activities.
default ListActivitiesIterable	listActivitiesPaginator()	This is a variant of listActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest) operation.
default ListActivitiesIterable	listActivitiesPaginator(Consumer<ListActivitiesRequest.Builder> listActivitiesRequest)	This is a variant of listActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest) operation.
default ListActivitiesIterable	listActivitiesPaginator(ListActivitiesRequest listActivitiesRequest)	This is a variant of listActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest) operation.
default ListExecutionsResponse	listExecutions(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)	Lists all executions of a state machine or a Map Run.
default ListExecutionsResponse	listExecutions(ListExecutionsRequest listExecutionsRequest)	Lists all executions of a state machine or a Map Run.
default ListExecutionsIterable	listExecutionsPaginator(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)	This is a variant of listExecutions(software.amazon.awssdk.services.sfn.model.ListExecutionsRequest) operation.
default ListExecutionsIterable	listExecutionsPaginator(ListExecutionsRequest listExecutionsRequest)	This is a variant of listExecutions(software.amazon.awssdk.services.sfn.model.ListExecutionsRequest) operation.
default ListMapRunsResponse	listMapRuns(Consumer<ListMapRunsRequest.Builder> listMapRunsRequest)	Lists all Map Runs that were started by a given state machine execution.
default ListMapRunsResponse	listMapRuns(ListMapRunsRequest listMapRunsRequest)	Lists all Map Runs that were started by a given state machine execution.
default ListMapRunsIterable	listMapRunsPaginator(Consumer<ListMapRunsRequest.Builder> listMapRunsRequest)	This is a variant of listMapRuns(software.amazon.awssdk.services.sfn.model.ListMapRunsRequest) operation.
default ListMapRunsIterable	listMapRunsPaginator(ListMapRunsRequest listMapRunsRequest)	This is a variant of listMapRuns(software.amazon.awssdk.services.sfn.model.ListMapRunsRequest) operation.
default ListStateMachineAliasesResponse	listStateMachineAliases(Consumer<ListStateMachineAliasesRequest.Builder> listStateMachineAliasesRequest)	Lists aliases for a specified state machine ARN.
default ListStateMachineAliasesResponse	listStateMachineAliases(ListStateMachineAliasesRequest listStateMachineAliasesRequest)	Lists aliases for a specified state machine ARN.
default ListStateMachinesResponse	listStateMachines()	Lists the existing state machines.
default ListStateMachinesResponse	listStateMachines(Consumer<ListStateMachinesRequest.Builder> listStateMachinesRequest)	Lists the existing state machines.
default ListStateMachinesResponse	listStateMachines(ListStateMachinesRequest listStateMachinesRequest)	Lists the existing state machines.
default ListStateMachinesIterable	listStateMachinesPaginator()	This is a variant of listStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest) operation.
default ListStateMachinesIterable	listStateMachinesPaginator(Consumer<ListStateMachinesRequest.Builder> listStateMachinesRequest)	This is a variant of listStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest) operation.
default ListStateMachinesIterable	listStateMachinesPaginator(ListStateMachinesRequest listStateMachinesRequest)	This is a variant of listStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest) operation.
default ListStateMachineVersionsResponse	listStateMachineVersions(Consumer<ListStateMachineVersionsRequest.Builder> listStateMachineVersionsRequest)	Lists versions for the specified state machine Amazon Resource Name (ARN).
default ListStateMachineVersionsResponse	listStateMachineVersions(ListStateMachineVersionsRequest listStateMachineVersionsRequest)	Lists versions for the specified state machine Amazon Resource Name (ARN).
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	List tags for a given resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	List tags for a given resource.
default PublishStateMachineVersionResponse	publishStateMachineVersion(Consumer<PublishStateMachineVersionRequest.Builder> publishStateMachineVersionRequest)	Creates a version from the current revision of a state machine.
default PublishStateMachineVersionResponse	publishStateMachineVersion(PublishStateMachineVersionRequest publishStateMachineVersionRequest)	Creates a version from the current revision of a state machine.
default RedriveExecutionResponse	redriveExecution(Consumer<RedriveExecutionRequest.Builder> redriveExecutionRequest)	Restarts unsuccessful executions of Standard workflows that didn't complete successfully in the last 14 days.
default RedriveExecutionResponse	redriveExecution(RedriveExecutionRequest redriveExecutionRequest)	Restarts unsuccessful executions of Standard workflows that didn't complete successfully in the last 14 days.
default 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.
default 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.
default 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.
default 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.
default 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.
default 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.
default SfnServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartExecutionResponse	startExecution(Consumer<StartExecutionRequest.Builder> startExecutionRequest)	Starts a state machine execution.
default StartExecutionResponse	startExecution(StartExecutionRequest startExecutionRequest)	Starts a state machine execution.
default StartSyncExecutionResponse	startSyncExecution(Consumer<StartSyncExecutionRequest.Builder> startSyncExecutionRequest)	Starts a Synchronous Express state machine execution.
default StartSyncExecutionResponse	startSyncExecution(StartSyncExecutionRequest startSyncExecutionRequest)	Starts a Synchronous Express state machine execution.
default StopExecutionResponse	stopExecution(Consumer<StopExecutionRequest.Builder> stopExecutionRequest)	Stops an execution.
default StopExecutionResponse	stopExecution(StopExecutionRequest stopExecutionRequest)	Stops an execution.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Add a tag to a Step Functions resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Add a tag to a Step Functions resource.
default TestStateResponse	testState(Consumer<TestStateRequest.Builder> testStateRequest)	Accepts the definition of a single state and executes it.
default TestStateResponse	testState(TestStateRequest testStateRequest)	Accepts the definition of a single state and executes it.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Remove a tag from a Step Functions resource
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Remove a tag from a Step Functions resource
default 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 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.
default UpdateStateMachineResponse	updateStateMachine(Consumer<UpdateStateMachineRequest.Builder> updateStateMachineRequest)	Updates an existing state machine by modifying its definition, roleArn, loggingConfiguration, or EncryptionConfiguration.
default UpdateStateMachineResponse	updateStateMachine(UpdateStateMachineRequest updateStateMachineRequest)	Updates an existing state machine by modifying its definition, roleArn, loggingConfiguration, or EncryptionConfiguration.
default UpdateStateMachineAliasResponse	updateStateMachineAlias(Consumer<UpdateStateMachineAliasRequest.Builder> updateStateMachineAliasRequest)	Updates the configuration of an existing state machine alias by modifying its description or routingConfiguration.
default UpdateStateMachineAliasResponse	updateStateMachineAlias(UpdateStateMachineAliasRequest updateStateMachineAliasRequest)	Updates the configuration of an existing state machine alias by modifying its description or routingConfiguration.
default ValidateStateMachineDefinitionResponse	validateStateMachineDefinition(Consumer<ValidateStateMachineDefinitionRequest.Builder> validateStateMachineDefinitionRequest)	Validates the syntax of a state machine definition.
default ValidateStateMachineDefinitionResponse	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

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createActivity

default CreateActivityResponse createActivity(CreateActivityRequest createActivityRequest)
                                       throws ActivityLimitExceededException,
ActivityAlreadyExistsException,
InvalidNameException,
TooManyTagsException,
InvalidEncryptionConfigurationException,
KmsAccessDeniedException,
KmsThrottlingException,
AwsServiceException,
SdkClientException,
SfnException

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 using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

CreateActivity is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateActivity's idempotency check is based on the activity name. If a following request has different tags values, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.

Parameters:

createActivityRequest -

Returns:

Result of the CreateActivity operation returned by the service.

See Also:

• AWS API Documentation

createActivity

default CreateActivityResponse createActivity(Consumer<CreateActivityRequest.Builder> createActivityRequest)
                                       throws ActivityLimitExceededException,
ActivityAlreadyExistsException,
InvalidNameException,
TooManyTagsException,
InvalidEncryptionConfigurationException,
KmsAccessDeniedException,
KmsThrottlingException,
AwsServiceException,
SdkClientException,
SfnException

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 using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

CreateActivity is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateActivity's idempotency check is based on the activity name. If a following request has different tags values, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.

This is a convenience which creates an instance of the CreateActivityRequest.Builder avoiding the need to create one manually via CreateActivityRequest.builder()

Parameters:

createActivityRequest - A Consumer that will call methods on CreateActivityRequest.Builder to create a request.

Returns:

Result of the CreateActivity operation returned by the service.

See Also:

• AWS API Documentation

createStateMachine

default CreateStateMachineResponse createStateMachine(CreateStateMachineRequest createStateMachineRequest)
                                               throws InvalidArnException,
InvalidDefinitionException,
InvalidNameException,
InvalidLoggingConfigurationException,
InvalidTracingConfigurationException,
StateMachineAlreadyExistsException,
StateMachineDeletingException,
StateMachineLimitExceededException,
StateMachineTypeNotSupportedException,
TooManyTagsException,
ValidationException,
ConflictException,
InvalidEncryptionConfigurationException,
KmsAccessDeniedException,
KmsThrottlingException,
AwsServiceException,
SdkClientException,
SfnException

Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. For more information, see Amazon States Language in the Step Functions User Guide.

If you set the publish parameter of this API action to true, it publishes version 1 as the first revision of the state machine.

For additional control over security, you can encrypt your data using a customer-managed key for Step Functions state machines. You can configure a symmetric KMS key and data key reuse period when creating or updating a State Machine. The execution history and state machine definition will be encrypted with the key applied to 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 machine name, definition, type, LoggingConfiguration, TracingConfiguration, and EncryptionConfiguration The check is also based on the publish and versionDescription parameters. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.

Parameters:

createStateMachineRequest -

Returns:

Result of the CreateStateMachine operation returned by the service.

See Also:

• AWS API Documentation

createStateMachine

default CreateStateMachineResponse createStateMachine(Consumer<CreateStateMachineRequest.Builder> createStateMachineRequest)
                                               throws InvalidArnException,
InvalidDefinitionException,
InvalidNameException,
InvalidLoggingConfigurationException,
InvalidTracingConfigurationException,
StateMachineAlreadyExistsException,
StateMachineDeletingException,
StateMachineLimitExceededException,
StateMachineTypeNotSupportedException,
TooManyTagsException,
ValidationException,
ConflictException,
InvalidEncryptionConfigurationException,
KmsAccessDeniedException,
KmsThrottlingException,
AwsServiceException,
SdkClientException,
SfnException

Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. For more information, see Amazon States Language in the Step Functions User Guide.

If you set the publish parameter of this API action to true, it publishes version 1 as the first revision of the state machine.

For additional control over security, you can encrypt your data using a customer-managed key for Step Functions state machines. You can configure a symmetric KMS key and data key reuse period when creating or updating a State Machine. The execution history and state machine definition will be encrypted with the key applied to 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 machine name, definition, type, LoggingConfiguration, TracingConfiguration, and EncryptionConfiguration The check is also based on the publish and versionDescription parameters. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.

This is a convenience which creates an instance of the CreateStateMachineRequest.Builder avoiding the need to create one manually via CreateStateMachineRequest.builder()

Parameters:

createStateMachineRequest - A Consumer that will call methods on CreateStateMachineRequest.Builder to create a request.

Returns:

Result of the CreateStateMachine operation returned by the service.

See Also:

• AWS API Documentation

createStateMachineAlias

default CreateStateMachineAliasResponse createStateMachineAlias(CreateStateMachineAliasRequest createStateMachineAliasRequest)
                                                         throws InvalidArnException,
InvalidNameException,
ValidationException,
StateMachineDeletingException,
ResourceNotFoundException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
SfnException

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 the routingConfiguration parameter. You must also specify the percentage of execution run requests each version should receive in both RoutingConfig 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 a weight 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 the stateMachineArn, description, name, and routingConfiguration parameters. Requests that contain the same values for these parameters return a successful idempotent response without creating a duplicate resource.

Related operations:

• DescribeStateMachineAlias

• ListStateMachineAliases

• UpdateStateMachineAlias

• DeleteStateMachineAlias

Parameters:

createStateMachineAliasRequest -

Returns:

Result of the CreateStateMachineAlias operation returned by the service.

See Also:

• AWS API Documentation

createStateMachineAlias

default CreateStateMachineAliasResponse createStateMachineAlias(Consumer<CreateStateMachineAliasRequest.Builder> createStateMachineAliasRequest)
                                                         throws InvalidArnException,
InvalidNameException,
ValidationException,
StateMachineDeletingException,
ResourceNotFoundException,
ConflictException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
SfnException

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 the routingConfiguration parameter. You must also specify the percentage of execution run requests each version should receive in both RoutingConfig 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 a weight 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 the stateMachineArn, description, name, and routingConfiguration parameters. Requests that contain the same values for these parameters return a successful idempotent response without creating a duplicate resource.

Related operations:

• DescribeStateMachineAlias

• ListStateMachineAliases

• UpdateStateMachineAlias

• DeleteStateMachineAlias

This is a convenience which creates an instance of the CreateStateMachineAliasRequest.Builder avoiding the need to create one manually via CreateStateMachineAliasRequest.builder()

Parameters:

createStateMachineAliasRequest - A Consumer that will call methods on CreateStateMachineAliasRequest.Builder to create a request.

Returns:

Result of the CreateStateMachineAlias operation returned by the service.

See Also:

• AWS API Documentation

deleteActivity

default DeleteActivityResponse deleteActivity(DeleteActivityRequest deleteActivityRequest)
                                       throws InvalidArnException,
AwsServiceException,
SdkClientException,
SfnException

Deletes an activity.

Parameters:

deleteActivityRequest -

Returns:

Result of the DeleteActivity operation returned by the service.

See Also:

• AWS API Documentation

deleteActivity

default DeleteActivityResponse deleteActivity(Consumer<DeleteActivityRequest.Builder> deleteActivityRequest)
                                       throws InvalidArnException,
AwsServiceException,
SdkClientException,
SfnException

Deletes an activity.

This is a convenience which creates an instance of the DeleteActivityRequest.Builder avoiding the need to create one manually via DeleteActivityRequest.builder()

Parameters:

deleteActivityRequest - A Consumer that will call methods on DeleteActivityRequest.Builder to create a request.

Returns:

Result of the DeleteActivity operation returned by the service.

See Also:

• AWS API Documentation

deleteStateMachine

default DeleteStateMachineResponse deleteStateMachine(DeleteStateMachineRequest deleteStateMachineRequest)
                                               throws InvalidArnException,
ValidationException,
AwsServiceException,
SdkClientException,
SfnException

Deletes a state machine. This is an asynchronous operation. It sets the state machine's status to DELETING and begins the deletion process. 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 named myStateMachine.

  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 after DeleteStateMachine API is called.

Parameters:

deleteStateMachineRequest -

Returns:

Result of the DeleteStateMachine operation returned by the service.

See Also:

• AWS API Documentation

deleteStateMachine

default DeleteStateMachineResponse deleteStateMachine(Consumer<DeleteStateMachineRequest.Builder> deleteStateMachineRequest)
                                               throws InvalidArnException,
ValidationException,
AwsServiceException,
SdkClientException,
SfnException

Deletes a state machine. This is an asynchronous operation. It sets the state machine's status to DELETING and begins the deletion process. 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 named myStateMachine.

  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 after DeleteStateMachine API is called.

This is a convenience which creates an instance of the DeleteStateMachineRequest.Builder avoiding the need to create one manually via DeleteStateMachineRequest.builder()

Parameters:

deleteStateMachineRequest - A Consumer that will call methods on DeleteStateMachineRequest.Builder to create a request.

Returns:

Result of the DeleteStateMachine operation returned by the service.

See Also:

• AWS API Documentation

deleteStateMachineAlias

default DeleteStateMachineAliasResponse deleteStateMachineAlias(DeleteStateMachineAliasRequest deleteStateMachineAliasRequest)
                                                         throws ValidationException,
InvalidArnException,
ResourceNotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
SfnException

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:

• CreateStateMachineAlias

• DescribeStateMachineAlias

• ListStateMachineAliases

• UpdateStateMachineAlias

Parameters:

deleteStateMachineAliasRequest -

Returns:

Result of the DeleteStateMachineAlias operation returned by the service.

See Also:

• AWS API Documentation

deleteStateMachineAlias

default DeleteStateMachineAliasResponse deleteStateMachineAlias(Consumer<DeleteStateMachineAliasRequest.Builder> deleteStateMachineAliasRequest)
                                                         throws ValidationException,
InvalidArnException,
ResourceNotFoundException,
ConflictException,
AwsServiceException,
SdkClientException,
SfnException

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:

• CreateStateMachineAlias

• DescribeStateMachineAlias

• ListStateMachineAliases

• UpdateStateMachineAlias

This is a convenience which creates an instance of the DeleteStateMachineAliasRequest.Builder avoiding the need to create one manually via DeleteStateMachineAliasRequest.builder()

Parameters:

deleteStateMachineAliasRequest - A Consumer that will call methods on DeleteStateMachineAliasRequest.Builder to create a request.

Returns:

Result of the DeleteStateMachineAlias operation returned by the service.

See Also:

• AWS API Documentation

deleteStateMachineVersion

default DeleteStateMachineVersionResponse deleteStateMachineVersion(DeleteStateMachineVersionRequest deleteStateMachineVersionRequest)
                                                             throws ValidationException,
InvalidArnException,
ConflictException,
AwsServiceException,
SdkClientException,
SfnException

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:

• PublishStateMachineVersion

• ListStateMachineVersions

Parameters:

deleteStateMachineVersionRequest -

Returns:

Result of the DeleteStateMachineVersion operation returned by the service.

See Also:

• AWS API Documentation

deleteStateMachineVersion

default DeleteStateMachineVersionResponse deleteStateMachineVersion(Consumer<DeleteStateMachineVersionRequest.Builder> deleteStateMachineVersionRequest)
                                                             throws ValidationException,
InvalidArnException,
ConflictException,
AwsServiceException,
SdkClientException,
SfnException

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:

• PublishStateMachineVersion

• ListStateMachineVersions

This is a convenience which creates an instance of the DeleteStateMachineVersionRequest.Builder avoiding the need to create one manually via DeleteStateMachineVersionRequest.builder()

Parameters:

deleteStateMachineVersionRequest - A Consumer that will call methods on DeleteStateMachineVersionRequest.Builder to create a request.

Returns:

Result of the DeleteStateMachineVersion operation returned by the service.

See Also:

• AWS API Documentation

describeActivity

default DescribeActivityResponse describeActivity(DescribeActivityRequest describeActivityRequest)
                                           throws ActivityDoesNotExistException,
InvalidArnException,
AwsServiceException,
SdkClientException,
SfnException

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:

Result of the DescribeActivity operation returned by the service.

See Also:

• AWS API Documentation

describeActivity

default DescribeActivityResponse describeActivity(Consumer<DescribeActivityRequest.Builder> describeActivityRequest)
                                           throws ActivityDoesNotExistException,
InvalidArnException,
AwsServiceException,
SdkClientException,
SfnException

Describes an activity.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

This is a convenience which creates an instance of the DescribeActivityRequest.Builder avoiding the need to create one manually via DescribeActivityRequest.builder()

Parameters:

describeActivityRequest - A Consumer that will call methods on DescribeActivityRequest.Builder to create a request.

Returns:

Result of the DescribeActivity operation returned by the service.

See Also:

• AWS API Documentation

describeExecution

default DescribeExecutionResponse describeExecution(DescribeExecutionRequest describeExecutionRequest)
                                             throws ExecutionDoesNotExistException,
InvalidArnException,
KmsAccessDeniedException,
KmsInvalidStateException,
KmsThrottlingException,
AwsServiceException,
SdkClientException,
SfnException

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 by DescribeExecution unless a Map Run dispatched them.

Parameters:

describeExecutionRequest -

Returns:

Result of the DescribeExecution operation returned by the service.

See Also:

• AWS API Documentation

describeExecution

default DescribeExecutionResponse describeExecution(Consumer<DescribeExecutionRequest.Builder> describeExecutionRequest)
                                             throws ExecutionDoesNotExistException,
InvalidArnException,
KmsAccessDeniedException,
KmsInvalidStateException,
KmsThrottlingException,
AwsServiceException,
SdkClientException,
SfnException

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 by DescribeExecution 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 via DescribeExecutionRequest.builder()

Parameters:

describeExecutionRequest - A Consumer that will call methods on DescribeExecutionRequest.Builder to create a request.

Returns:

Result of the DescribeExecution operation returned by the service.

See Also:

• AWS API Documentation

describeMapRun

default DescribeMapRunResponse describeMapRun(DescribeMapRunRequest describeMapRunRequest)
                                       throws ResourceNotFoundException,
InvalidArnException,
AwsServiceException,
SdkClientException,
SfnException

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:

Result of the DescribeMapRun operation returned by the service.

See Also:

• AWS API Documentation

describeMapRun

default DescribeMapRunResponse describeMapRun(Consumer<DescribeMapRunRequest.Builder> describeMapRunRequest)
                                       throws ResourceNotFoundException,
InvalidArnException,
AwsServiceException,
SdkClientException,
SfnException

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 via DescribeMapRunRequest.builder()

Parameters:

describeMapRunRequest - A Consumer that will call methods on DescribeMapRunRequest.Builder to create a request.

Returns:

Result of the DescribeMapRun operation returned by the service.

See Also:

• AWS API Documentation

describeStateMachine

default DescribeStateMachineResponse describeStateMachine(DescribeStateMachineRequest describeStateMachineRequest)
                                                   throws InvalidArnException,
StateMachineDoesNotExistException,
KmsAccessDeniedException,
KmsInvalidStateException,
KmsThrottlingException,
AwsServiceException,
SdkClientException,
SfnException

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 named myStateMachine.

  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:

Result of the DescribeStateMachine operation returned by the service.

See Also:

• AWS API Documentation

describeStateMachine

default DescribeStateMachineResponse describeStateMachine(Consumer<DescribeStateMachineRequest.Builder> describeStateMachineRequest)
                                                   throws InvalidArnException,
StateMachineDoesNotExistException,
KmsAccessDeniedException,
KmsInvalidStateException,
KmsThrottlingException,
AwsServiceException,
SdkClientException,
SfnException

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 named myStateMachine.

  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 via DescribeStateMachineRequest.builder()

Parameters:

describeStateMachineRequest - A Consumer that will call methods on DescribeStateMachineRequest.Builder to create a request.

Returns:

Result of the DescribeStateMachine operation returned by the service.

See Also:

• AWS API Documentation

describeStateMachineAlias

default DescribeStateMachineAliasResponse describeStateMachineAlias(DescribeStateMachineAliasRequest describeStateMachineAliasRequest)
                                                             throws ValidationException,
InvalidArnException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
SfnException

Returns details about a state machine alias.

Related operations:

• CreateStateMachineAlias

• ListStateMachineAliases

• UpdateStateMachineAlias

• DeleteStateMachineAlias

Parameters:

describeStateMachineAliasRequest -

Returns:

Result of the DescribeStateMachineAlias operation returned by the service.

See Also:

• AWS API Documentation

describeStateMachineAlias

default DescribeStateMachineAliasResponse describeStateMachineAlias(Consumer<DescribeStateMachineAliasRequest.Builder> describeStateMachineAliasRequest)
                                                             throws ValidationException,
InvalidArnException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
SfnException

Returns details about a state machine alias.

Related operations:

• CreateStateMachineAlias

• ListStateMachineAliases

• UpdateStateMachineAlias

• DeleteStateMachineAlias

This is a convenience which creates an instance of the DescribeStateMachineAliasRequest.Builder avoiding the need to create one manually via DescribeStateMachineAliasRequest.builder()

Parameters:

describeStateMachineAliasRequest - A Consumer that will call methods on DescribeStateMachineAliasRequest.Builder to create a request.

Returns:

Result of the DescribeStateMachineAlias operation returned by the service.

See Also:

• AWS API Documentation

describeStateMachineForExecution

default DescribeStateMachineForExecutionResponse describeStateMachineForExecution(DescribeStateMachineForExecutionRequest describeStateMachineForExecutionRequest)
                                                                           throws ExecutionDoesNotExistException,
InvalidArnException,
KmsAccessDeniedException,
KmsInvalidStateException,
KmsThrottlingException,
AwsServiceException,
SdkClientException,
SfnException

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:

Result of the DescribeStateMachineForExecution operation returned by the service.

See Also:

• AWS API Documentation

describeStateMachineForExecution

default DescribeStateMachineForExecutionResponse describeStateMachineForExecution(Consumer<DescribeStateMachineForExecutionRequest.Builder> describeStateMachineForExecutionRequest)
                                                                           throws ExecutionDoesNotExistException,
InvalidArnException,
KmsAccessDeniedException,
KmsInvalidStateException,
KmsThrottlingException,
AwsServiceException,
SdkClientException,
SfnException

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 via DescribeStateMachineForExecutionRequest.builder()

Parameters:

describeStateMachineForExecutionRequest - A Consumer that will call methods on DescribeStateMachineForExecutionRequest.Builder to create a request.

Returns:

Result of the DescribeStateMachineForExecution operation returned by the service.

See Also:

• AWS API Documentation

getActivityTask

default GetActivityTaskResponse getActivityTask(GetActivityTaskRequest getActivityTaskRequest)
                                         throws ActivityDoesNotExistException,
ActivityWorkerLimitExceededException,
InvalidArnException,
KmsAccessDeniedException,
KmsInvalidStateException,
KmsThrottlingException,
AwsServiceException,
SdkClientException,
SfnException

Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken with a null string.

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:

Result of the GetActivityTask operation returned by the service.

See Also:

• AWS API Documentation

getActivityTask

default GetActivityTaskResponse getActivityTask(Consumer<GetActivityTaskRequest.Builder> getActivityTaskRequest)
                                         throws ActivityDoesNotExistException,
ActivityWorkerLimitExceededException,
InvalidArnException,
KmsAccessDeniedException,
KmsInvalidStateException,
KmsThrottlingException,
AwsServiceException,
SdkClientException,
SfnException

Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken with a null string.

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 via GetActivityTaskRequest.builder()

Parameters:

getActivityTaskRequest - A Consumer that will call methods on GetActivityTaskRequest.Builder to create a request.

Returns:

Result of the GetActivityTask operation returned by the service.

See Also:

• AWS API Documentation

getExecutionHistory

default GetExecutionHistoryResponse getExecutionHistory(GetExecutionHistoryRequest getExecutionHistoryRequest)
                                                 throws ExecutionDoesNotExistException,
InvalidArnException,
InvalidTokenException,
KmsAccessDeniedException,
KmsInvalidStateException,
KmsThrottlingException,
AwsServiceException,
SdkClientException,
SfnException

Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first.

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

This API action is not supported by EXPRESS state machines.

Parameters:

getExecutionHistoryRequest -

Returns:

Result of the GetExecutionHistory operation returned by the service.

See Also:

• AWS API Documentation

getExecutionHistory

default GetExecutionHistoryResponse getExecutionHistory(Consumer<GetExecutionHistoryRequest.Builder> getExecutionHistoryRequest)
                                                 throws ExecutionDoesNotExistException,
InvalidArnException,
InvalidTokenException,
KmsAccessDeniedException,
KmsInvalidStateException,
KmsThrottlingException,
AwsServiceException,
SdkClientException,
SfnException

Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first.

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

This API action is not supported by EXPRESS state machines.

This is a convenience which creates an instance of the GetExecutionHistoryRequest.Builder avoiding the need to create one manually via GetExecutionHistoryRequest.builder()

Parameters:

getExecutionHistoryRequest - A Consumer that will call methods on GetExecutionHistoryRequest.Builder to create a request.

Returns:

Result of the GetExecutionHistory operation returned by the service.

See Also:

• AWS API Documentation

getExecutionHistoryPaginator

default GetExecutionHistoryIterable getExecutionHistoryPaginator(GetExecutionHistoryRequest getExecutionHistoryRequest)
                                                          throws ExecutionDoesNotExistException,
InvalidArnException,
InvalidTokenException,
KmsAccessDeniedException,
KmsInvalidStateException,
KmsThrottlingException,
AwsServiceException,
SdkClientException,
SfnException

This is a variant of getExecutionHistory(software.amazon.awssdk.services.sfn.model.GetExecutionHistoryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.sfn.paginators.GetExecutionHistoryIterable responses = client.getExecutionHistoryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.sfn.paginators.GetExecutionHistoryIterable responses = client
             .getExecutionHistoryPaginator(request);
     for (software.amazon.awssdk.services.sfn.model.GetExecutionHistoryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.sfn.paginators.GetExecutionHistoryIterable responses = client.getExecutionHistoryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getExecutionHistoryPaginator

default GetExecutionHistoryIterable getExecutionHistoryPaginator(Consumer<GetExecutionHistoryRequest.Builder> getExecutionHistoryRequest)
                                                          throws ExecutionDoesNotExistException,
InvalidArnException,
InvalidTokenException,
KmsAccessDeniedException,
KmsInvalidStateException,
KmsThrottlingException,
AwsServiceException,
SdkClientException,
SfnException

This is a variant of getExecutionHistory(software.amazon.awssdk.services.sfn.model.GetExecutionHistoryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.sfn.paginators.GetExecutionHistoryIterable responses = client.getExecutionHistoryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.sfn.paginators.GetExecutionHistoryIterable responses = client
             .getExecutionHistoryPaginator(request);
     for (software.amazon.awssdk.services.sfn.model.GetExecutionHistoryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.sfn.paginators.GetExecutionHistoryIterable responses = client.getExecutionHistoryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getExecutionHistory(software.amazon.awssdk.services.sfn.model.GetExecutionHistoryRequest) operation.

This is a convenience which creates an instance of the GetExecutionHistoryRequest.Builder avoiding the need to create one manually via GetExecutionHistoryRequest.builder()

Parameters:

getExecutionHistoryRequest - A Consumer that will call methods on GetExecutionHistoryRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listActivities

default ListActivitiesResponse listActivities(ListActivitiesRequest listActivitiesRequest)
                                       throws InvalidTokenException,
AwsServiceException,
SdkClientException,
SfnException

Lists the existing activities.

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Parameters:

listActivitiesRequest -

Returns:

Result of the ListActivities operation returned by the service.

See Also:

• AWS API Documentation

listActivities

default ListActivitiesResponse listActivities(Consumer<ListActivitiesRequest.Builder> listActivitiesRequest)
                                       throws InvalidTokenException,
AwsServiceException,
SdkClientException,
SfnException

Lists the existing activities.

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

This is a convenience which creates an instance of the ListActivitiesRequest.Builder avoiding the need to create one manually via ListActivitiesRequest.builder()

Parameters:

listActivitiesRequest - A Consumer that will call methods on ListActivitiesRequest.Builder to create a request.

Returns:

Result of the ListActivities operation returned by the service.

See Also:

• AWS API Documentation

listActivities

default ListActivitiesResponse listActivities()
                                       throws InvalidTokenException,
AwsServiceException,
SdkClientException,
SfnException

Lists the existing activities.

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Returns:

Result of the ListActivities operation returned by the service.

See Also:

• listActivities(ListActivitiesRequest)
• AWS API Documentation

listActivitiesPaginator

default ListActivitiesIterable listActivitiesPaginator()
                                                throws InvalidTokenException,
AwsServiceException,
SdkClientException,
SfnException

This is a variant of listActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.sfn.paginators.ListActivitiesIterable responses = client.listActivitiesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.sfn.paginators.ListActivitiesIterable responses = client.listActivitiesPaginator(request);
     for (software.amazon.awssdk.services.sfn.model.ListActivitiesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.sfn.paginators.ListActivitiesIterable responses = client.listActivitiesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• listActivitiesPaginator(ListActivitiesRequest)
• AWS API Documentation

listActivitiesPaginator

default ListActivitiesIterable listActivitiesPaginator(ListActivitiesRequest listActivitiesRequest)
                                                throws InvalidTokenException,
AwsServiceException,
SdkClientException,
SfnException

This is a variant of listActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.sfn.paginators.ListActivitiesIterable responses = client.listActivitiesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.sfn.paginators.ListActivitiesIterable responses = client.listActivitiesPaginator(request);
     for (software.amazon.awssdk.services.sfn.model.ListActivitiesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.sfn.paginators.ListActivitiesIterable responses = client.listActivitiesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listActivitiesPaginator

default ListActivitiesIterable listActivitiesPaginator(Consumer<ListActivitiesRequest.Builder> listActivitiesRequest)
                                                throws InvalidTokenException,
AwsServiceException,
SdkClientException,
SfnException

This is a variant of listActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.sfn.paginators.ListActivitiesIterable responses = client.listActivitiesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.sfn.paginators.ListActivitiesIterable responses = client.listActivitiesPaginator(request);
     for (software.amazon.awssdk.services.sfn.model.ListActivitiesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.sfn.paginators.ListActivitiesIterable responses = client.listActivitiesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest) operation.

This is a convenience which creates an instance of the ListActivitiesRequest.Builder avoiding the need to create one manually via ListActivitiesRequest.builder()

Parameters:

listActivitiesRequest - A Consumer that will call methods on ListActivitiesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listExecutions

default ListExecutionsResponse listExecutions(ListExecutionsRequest listExecutionsRequest)
                                       throws InvalidArnException,
InvalidTokenException,
StateMachineDoesNotExistException,
StateMachineTypeNotSupportedException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
SfnException

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 of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

This API action is not supported by EXPRESS state machines.

Parameters:

listExecutionsRequest -

Returns:

Result of the ListExecutions operation returned by the service.

See Also:

• AWS API Documentation

listExecutions

default ListExecutionsResponse listExecutions(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)
                                       throws InvalidArnException,
InvalidTokenException,
StateMachineDoesNotExistException,
StateMachineTypeNotSupportedException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
SfnException

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 of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

This API action is not supported by EXPRESS state machines.

This is a convenience which creates an instance of the ListExecutionsRequest.Builder avoiding the need to create one manually via ListExecutionsRequest.builder()

Parameters:

listExecutionsRequest - A Consumer that will call methods on ListExecutionsRequest.Builder to create a request.

Returns:

Result of the ListExecutions operation returned by the service.

See Also:

• AWS API Documentation

listExecutionsPaginator

default ListExecutionsIterable listExecutionsPaginator(ListExecutionsRequest listExecutionsRequest)
                                                throws InvalidArnException,
InvalidTokenException,
StateMachineDoesNotExistException,
StateMachineTypeNotSupportedException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
SfnException

This is a variant of listExecutions(software.amazon.awssdk.services.sfn.model.ListExecutionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.sfn.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.sfn.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request);
     for (software.amazon.awssdk.services.sfn.model.ListExecutionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.sfn.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listExecutionsPaginator

default ListExecutionsIterable listExecutionsPaginator(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)
                                                throws InvalidArnException,
InvalidTokenException,
StateMachineDoesNotExistException,
StateMachineTypeNotSupportedException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
SfnException

This is a variant of listExecutions(software.amazon.awssdk.services.sfn.model.ListExecutionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.sfn.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.sfn.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request);
     for (software.amazon.awssdk.services.sfn.model.ListExecutionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.sfn.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listExecutions(software.amazon.awssdk.services.sfn.model.ListExecutionsRequest) operation.

This is a convenience which creates an instance of the ListExecutionsRequest.Builder avoiding the need to create one manually via ListExecutionsRequest.builder()

Parameters:

listExecutionsRequest - A Consumer that will call methods on ListExecutionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listMapRuns

default ListMapRunsResponse listMapRuns(ListMapRunsRequest listMapRunsRequest)
                                 throws ExecutionDoesNotExistException,
InvalidArnException,
InvalidTokenException,
AwsServiceException,
SdkClientException,
SfnException

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:

Result of the ListMapRuns operation returned by the service.

See Also:

• AWS API Documentation

listMapRuns

default ListMapRunsResponse listMapRuns(Consumer<ListMapRunsRequest.Builder> listMapRunsRequest)
                                 throws ExecutionDoesNotExistException,
InvalidArnException,
InvalidTokenException,
AwsServiceException,
SdkClientException,
SfnException

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 via ListMapRunsRequest.builder()

Parameters:

listMapRunsRequest - A Consumer that will call methods on ListMapRunsRequest.Builder to create a request.

Returns:

Result of the ListMapRuns operation returned by the service.

See Also:

• AWS API Documentation

listMapRunsPaginator

default ListMapRunsIterable listMapRunsPaginator(ListMapRunsRequest listMapRunsRequest)
                                          throws ExecutionDoesNotExistException,
InvalidArnException,
InvalidTokenException,
AwsServiceException,
SdkClientException,
SfnException

This is a variant of listMapRuns(software.amazon.awssdk.services.sfn.model.ListMapRunsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.sfn.paginators.ListMapRunsIterable responses = client.listMapRunsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.sfn.paginators.ListMapRunsIterable responses = client.listMapRunsPaginator(request);
     for (software.amazon.awssdk.services.sfn.model.ListMapRunsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.sfn.paginators.ListMapRunsIterable responses = client.listMapRunsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listMapRunsPaginator

default ListMapRunsIterable listMapRunsPaginator(Consumer<ListMapRunsRequest.Builder> listMapRunsRequest)
                                          throws ExecutionDoesNotExistException,
InvalidArnException,
InvalidTokenException,
AwsServiceException,
SdkClientException,
SfnException

This is a variant of listMapRuns(software.amazon.awssdk.services.sfn.model.ListMapRunsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.sfn.paginators.ListMapRunsIterable responses = client.listMapRunsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.sfn.paginators.ListMapRunsIterable responses = client.listMapRunsPaginator(request);
     for (software.amazon.awssdk.services.sfn.model.ListMapRunsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.sfn.paginators.ListMapRunsIterable responses = client.listMapRunsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 via ListMapRunsRequest.builder()

Parameters:

listMapRunsRequest - A Consumer that will call methods on ListMapRunsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listStateMachineAliases

default ListStateMachineAliasesResponse listStateMachineAliases(ListStateMachineAliasesRequest listStateMachineAliasesRequest)
                                                         throws InvalidArnException,
InvalidTokenException,
ResourceNotFoundException,
StateMachineDoesNotExistException,
StateMachineDeletingException,
AwsServiceException,
SdkClientException,
SfnException

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 of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Related operations:

• CreateStateMachineAlias

• DescribeStateMachineAlias

• UpdateStateMachineAlias

• DeleteStateMachineAlias

Parameters:

listStateMachineAliasesRequest -

Returns:

Result of the ListStateMachineAliases operation returned by the service.

See Also:

• AWS API Documentation

listStateMachineAliases

default ListStateMachineAliasesResponse listStateMachineAliases(Consumer<ListStateMachineAliasesRequest.Builder> listStateMachineAliasesRequest)
                                                         throws InvalidArnException,
InvalidTokenException,
ResourceNotFoundException,
StateMachineDoesNotExistException,
StateMachineDeletingException,
AwsServiceException,
SdkClientException,
SfnException

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 of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Related operations:

• CreateStateMachineAlias

• DescribeStateMachineAlias

• UpdateStateMachineAlias

• DeleteStateMachineAlias

This is a convenience which creates an instance of the ListStateMachineAliasesRequest.Builder avoiding the need to create one manually via ListStateMachineAliasesRequest.builder()

Parameters:

listStateMachineAliasesRequest - A Consumer that will call methods on ListStateMachineAliasesRequest.Builder to create a request.

Returns:

Result of the ListStateMachineAliases operation returned by the service.

See Also:

• AWS API Documentation

listStateMachineVersions

default ListStateMachineVersionsResponse listStateMachineVersions(ListStateMachineVersionsRequest listStateMachineVersionsRequest)
                                                           throws ValidationException,
InvalidArnException,
InvalidTokenException,
AwsServiceException,
SdkClientException,
SfnException

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 of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Related operations:

• PublishStateMachineVersion

• DeleteStateMachineVersion

Parameters:

listStateMachineVersionsRequest -

Returns:

Result of the ListStateMachineVersions operation returned by the service.

See Also:

• AWS API Documentation

listStateMachineVersions

default ListStateMachineVersionsResponse listStateMachineVersions(Consumer<ListStateMachineVersionsRequest.Builder> listStateMachineVersionsRequest)
                                                           throws ValidationException,
InvalidArnException,
InvalidTokenException,
AwsServiceException,
SdkClientException,
SfnException

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 of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Related operations:

• PublishStateMachineVersion

• DeleteStateMachineVersion

This is a convenience which creates an instance of the ListStateMachineVersionsRequest.Builder avoiding the need to create one manually via ListStateMachineVersionsRequest.builder()

Parameters:

listStateMachineVersionsRequest - A Consumer that will call methods on ListStateMachineVersionsRequest.Builder to create a request.

Returns:

Result of the ListStateMachineVersions operation returned by the service.

See Also:

• AWS API Documentation

listStateMachines

default ListStateMachinesResponse listStateMachines(ListStateMachinesRequest listStateMachinesRequest)
                                             throws InvalidTokenException,
AwsServiceException,
SdkClientException,
SfnException

Lists the existing state machines.

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Parameters:

listStateMachinesRequest -

Returns:

Result of the ListStateMachines operation returned by the service.

See Also:

• AWS API Documentation

listStateMachines

default ListStateMachinesResponse listStateMachines(Consumer<ListStateMachinesRequest.Builder> listStateMachinesRequest)
                                             throws InvalidTokenException,
AwsServiceException,
SdkClientException,
SfnException

Lists the existing state machines.

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

This is a convenience which creates an instance of the ListStateMachinesRequest.Builder avoiding the need to create one manually via ListStateMachinesRequest.builder()

Parameters:

listStateMachinesRequest - A Consumer that will call methods on ListStateMachinesRequest.Builder to create a request.

Returns:

Result of the ListStateMachines operation returned by the service.

See Also:

• AWS API Documentation

listStateMachines

default ListStateMachinesResponse listStateMachines()
                                             throws InvalidTokenException,
AwsServiceException,
SdkClientException,
SfnException

Lists the existing state machines.

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Returns:

Result of the ListStateMachines operation returned by the service.

See Also:

• listStateMachines(ListStateMachinesRequest)
• AWS API Documentation

listStateMachinesPaginator

default ListStateMachinesIterable listStateMachinesPaginator()
                                                      throws InvalidTokenException,
AwsServiceException,
SdkClientException,
SfnException

This is a variant of listStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.sfn.paginators.ListStateMachinesIterable responses = client.listStateMachinesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.sfn.paginators.ListStateMachinesIterable responses = client
             .listStateMachinesPaginator(request);
     for (software.amazon.awssdk.services.sfn.model.ListStateMachinesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.sfn.paginators.ListStateMachinesIterable responses = client.listStateMachinesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• listStateMachinesPaginator(ListStateMachinesRequest)
• AWS API Documentation

listStateMachinesPaginator

default ListStateMachinesIterable listStateMachinesPaginator(ListStateMachinesRequest listStateMachinesRequest)
                                                      throws InvalidTokenException,
AwsServiceException,
SdkClientException,
SfnException

This is a variant of listStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.sfn.paginators.ListStateMachinesIterable responses = client.listStateMachinesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.sfn.paginators.ListStateMachinesIterable responses = client
             .listStateMachinesPaginator(request);
     for (software.amazon.awssdk.services.sfn.model.ListStateMachinesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.sfn.paginators.ListStateMachinesIterable responses = client.listStateMachinesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listStateMachinesPaginator

default ListStateMachinesIterable listStateMachinesPaginator(Consumer<ListStateMachinesRequest.Builder> listStateMachinesRequest)
                                                      throws InvalidTokenException,
AwsServiceException,
SdkClientException,
SfnException

This is a variant of listStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.sfn.paginators.ListStateMachinesIterable responses = client.listStateMachinesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.sfn.paginators.ListStateMachinesIterable responses = client
             .listStateMachinesPaginator(request);
     for (software.amazon.awssdk.services.sfn.model.ListStateMachinesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.sfn.paginators.ListStateMachinesIterable responses = client.listStateMachinesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest) operation.

This is a convenience which creates an instance of the ListStateMachinesRequest.Builder avoiding the need to create one manually via ListStateMachinesRequest.builder()

Parameters:

listStateMachinesRequest - A Consumer that will call methods on ListStateMachinesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws InvalidArnException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
SfnException

List tags for a given resource.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws InvalidArnException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
SfnException

List tags for a given resource.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

publishStateMachineVersion

default PublishStateMachineVersionResponse publishStateMachineVersion(PublishStateMachineVersionRequest publishStateMachineVersionRequest)
                                                               throws ValidationException,
StateMachineDeletingException,
StateMachineDoesNotExistException,
ServiceQuotaExceededException,
ConflictException,
InvalidArnException,
AwsServiceException,
SdkClientException,
SfnException

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 bases PublishStateMachineVersion's idempotency check on the stateMachineArn, name, and revisionId parameters. Requests with the same parameters return a successful idempotent response. If you don't specify a revisionId, Step Functions checks for a previously published version of the state machine's current revision.

Related operations:

• DeleteStateMachineVersion

• ListStateMachineVersions

Parameters:

publishStateMachineVersionRequest -

Returns:

Result of the PublishStateMachineVersion operation returned by the service.

See Also:

• AWS API Documentation

publishStateMachineVersion

default PublishStateMachineVersionResponse publishStateMachineVersion(Consumer<PublishStateMachineVersionRequest.Builder> publishStateMachineVersionRequest)
                                                               throws ValidationException,
StateMachineDeletingException,
StateMachineDoesNotExistException,
ServiceQuotaExceededException,
ConflictException,
InvalidArnException,
AwsServiceException,
SdkClientException,
SfnException

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 bases PublishStateMachineVersion's idempotency check on the stateMachineArn, name, and revisionId parameters. Requests with the same parameters return a successful idempotent response. If you don't specify a revisionId, Step Functions checks for a previously published version of the state machine's current revision.

Related operations:

• DeleteStateMachineVersion

• ListStateMachineVersions

This is a convenience which creates an instance of the PublishStateMachineVersionRequest.Builder avoiding the need to create one manually via PublishStateMachineVersionRequest.builder()

Parameters:

publishStateMachineVersionRequest - A Consumer that will call methods on PublishStateMachineVersionRequest.Builder to create a request.

Returns:

Result of the PublishStateMachineVersion operation returned by the service.

See Also:

• AWS API Documentation

redriveExecution

default RedriveExecutionResponse redriveExecution(RedriveExecutionRequest redriveExecutionRequest)
                                           throws ExecutionDoesNotExistException,
ExecutionNotRedrivableException,
ExecutionLimitExceededException,
InvalidArnException,
ValidationException,
AwsServiceException,
SdkClientException,
SfnException

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:

Result of the RedriveExecution operation returned by the service.

See Also:

• AWS API Documentation

redriveExecution

default RedriveExecutionResponse redriveExecution(Consumer<RedriveExecutionRequest.Builder> redriveExecutionRequest)
                                           throws ExecutionDoesNotExistException,
ExecutionNotRedrivableException,
ExecutionLimitExceededException,
InvalidArnException,
ValidationException,
AwsServiceException,
SdkClientException,
SfnException

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 via RedriveExecutionRequest.builder()

Parameters:

redriveExecutionRequest - A Consumer that will call methods on RedriveExecutionRequest.Builder to create a request.

Returns:

Result of the RedriveExecution operation returned by the service.

See Also:

• AWS API Documentation

sendTaskFailure

default SendTaskFailureResponse sendTaskFailure(SendTaskFailureRequest sendTaskFailureRequest)
                                         throws TaskDoesNotExistException,
InvalidTokenException,
TaskTimedOutException,
KmsAccessDeniedException,
KmsInvalidStateException,
KmsThrottlingException,
AwsServiceException,
SdkClientException,
SfnException

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.

For an execution with encryption enabled, Step Functions will encrypt the error and cause fields using the KMS key for the execution role.

A caller can mark a task as fail without using any KMS permissions in the execution role if the caller provides a null value for both error and cause fields because no data needs to be encrypted.

Parameters:

sendTaskFailureRequest -

Returns:

Result of the SendTaskFailure operation returned by the service.

See Also:

• AWS API Documentation

sendTaskFailure

default SendTaskFailureResponse sendTaskFailure(Consumer<SendTaskFailureRequest.Builder> sendTaskFailureRequest)
                                         throws TaskDoesNotExistException,
InvalidTokenException,
TaskTimedOutException,
KmsAccessDeniedException,
KmsInvalidStateException,
KmsThrottlingException,
AwsServiceException,
SdkClientException,
SfnException

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.

For an execution with encryption enabled, Step Functions will encrypt the error and cause fields using the KMS key for the execution role.

A caller can mark a task as fail without using any KMS permissions in the execution role if the caller provides a null value for both error and cause fields because no data needs to be encrypted.

This is a convenience which creates an instance of the SendTaskFailureRequest.Builder avoiding the need to create one manually via SendTaskFailureRequest.builder()

Parameters:

sendTaskFailureRequest - A Consumer that will call methods on SendTaskFailureRequest.Builder to create a request.

Returns:

Result of the SendTaskFailure operation returned by the service.

See Also:

• AWS API Documentation

sendTaskHeartbeat

default SendTaskHeartbeatResponse sendTaskHeartbeat(SendTaskHeartbeatRequest sendTaskHeartbeatRequest)
                                             throws TaskDoesNotExistException,
InvalidTokenException,
TaskTimedOutException,
AwsServiceException,
SdkClientException,
SfnException

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 the Heartbeat clock. The Heartbeat threshold is specified in the state machine's Amazon States Language definition (HeartbeatSeconds). This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an ActivityTimedOut entry for activities, or a TaskTimedOut entry for tasks using the job run or callback pattern.

The Timeout of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received. Use HeartbeatSeconds to configure the timeout interval for heartbeats.

Parameters:

sendTaskHeartbeatRequest -

Returns:

Result of the SendTaskHeartbeat operation returned by the service.

See Also:

• AWS API Documentation

sendTaskHeartbeat

default SendTaskHeartbeatResponse sendTaskHeartbeat(Consumer<SendTaskHeartbeatRequest.Builder> sendTaskHeartbeatRequest)
                                             throws TaskDoesNotExistException,
InvalidTokenException,
TaskTimedOutException,
AwsServiceException,
SdkClientException,
SfnException

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 the Heartbeat clock. The Heartbeat threshold is specified in the state machine's Amazon States Language definition (HeartbeatSeconds). This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an ActivityTimedOut entry for activities, or a TaskTimedOut entry for tasks using the job run or callback pattern.

The Timeout of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received. Use HeartbeatSeconds to configure the timeout interval for heartbeats.

This is a convenience which creates an instance of the SendTaskHeartbeatRequest.Builder avoiding the need to create one manually via SendTaskHeartbeatRequest.builder()

Parameters:

sendTaskHeartbeatRequest - A Consumer that will call methods on SendTaskHeartbeatRequest.Builder to create a request.

Returns:

Result of the SendTaskHeartbeat operation returned by the service.

See Also:

• AWS API Documentation

sendTaskSuccess

default SendTaskSuccessResponse sendTaskSuccess(SendTaskSuccessRequest sendTaskSuccessRequest)
                                         throws TaskDoesNotExistException,
InvalidOutputException,
InvalidTokenException,
TaskTimedOutException,
KmsAccessDeniedException,
KmsInvalidStateException,
KmsThrottlingException,
AwsServiceException,
SdkClientException,
SfnException

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:

Result of the SendTaskSuccess operation returned by the service.

See Also:

• AWS API Documentation

sendTaskSuccess

default SendTaskSuccessResponse sendTaskSuccess(Consumer<SendTaskSuccessRequest.Builder> sendTaskSuccessRequest)
                                         throws TaskDoesNotExistException,
InvalidOutputException,
InvalidTokenException,
TaskTimedOutException,
KmsAccessDeniedException,
KmsInvalidStateException,
KmsThrottlingException,
AwsServiceException,
SdkClientException,
SfnException

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 via SendTaskSuccessRequest.builder()

Parameters:

sendTaskSuccessRequest - A Consumer that will call methods on SendTaskSuccessRequest.Builder to create a request.

Returns:

Result of the SendTaskSuccess operation returned by the service.

See Also:

• AWS API Documentation

startExecution

default StartExecutionResponse startExecution(StartExecutionRequest startExecutionRequest)
                                       throws ExecutionLimitExceededException,
ExecutionAlreadyExistsException,
InvalidArnException,
InvalidExecutionInputException,
InvalidNameException,
StateMachineDoesNotExistException,
StateMachineDeletingException,
ValidationException,
KmsAccessDeniedException,
KmsInvalidStateException,
KmsThrottlingException,
AwsServiceException,
SdkClientException,
SfnException

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 named myStateMachine.

  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 for STANDARD workflows. For a STANDARD workflow, if you call StartExecution 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 a 400 ExecutionAlreadyExists error. You can reuse names after 90 days.

StartExecution isn't idempotent for EXPRESS workflows.

Parameters:

startExecutionRequest -

Returns:

Result of the StartExecution operation returned by the service.

See Also:

• AWS API Documentation

startExecution

default StartExecutionResponse startExecution(Consumer<StartExecutionRequest.Builder> startExecutionRequest)
                                       throws ExecutionLimitExceededException,
ExecutionAlreadyExistsException,
InvalidArnException,
InvalidExecutionInputException,
InvalidNameException,
StateMachineDoesNotExistException,
StateMachineDeletingException,
ValidationException,
KmsAccessDeniedException,
KmsInvalidStateException,
KmsThrottlingException,
AwsServiceException,
SdkClientException,
SfnException

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 named myStateMachine.

  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 for STANDARD workflows. For a STANDARD workflow, if you call StartExecution 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 a 400 ExecutionAlreadyExists error. You can reuse names after 90 days.

StartExecution isn't idempotent for EXPRESS workflows.

This is a convenience which creates an instance of the StartExecutionRequest.Builder avoiding the need to create one manually via StartExecutionRequest.builder()

Parameters:

startExecutionRequest - A Consumer that will call methods on StartExecutionRequest.Builder to create a request.

Returns:

Result of the StartExecution operation returned by the service.

See Also:

• AWS API Documentation

startSyncExecution

default StartSyncExecutionResponse startSyncExecution(StartSyncExecutionRequest startSyncExecutionRequest)
                                               throws InvalidArnException,
InvalidExecutionInputException,
InvalidNameException,
StateMachineDoesNotExistException,
StateMachineDeletingException,
StateMachineTypeNotSupportedException,
KmsAccessDeniedException,
KmsInvalidStateException,
KmsThrottlingException,
AwsServiceException,
SdkClientException,
SfnException

Starts a Synchronous Express state machine execution. StartSyncExecution is not available for STANDARD workflows.

StartSyncExecution will return a 200 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:

Result of the StartSyncExecution operation returned by the service.

See Also:

• AWS API Documentation

startSyncExecution

default StartSyncExecutionResponse startSyncExecution(Consumer<StartSyncExecutionRequest.Builder> startSyncExecutionRequest)
                                               throws InvalidArnException,
InvalidExecutionInputException,
InvalidNameException,
StateMachineDoesNotExistException,
StateMachineDeletingException,
StateMachineTypeNotSupportedException,
KmsAccessDeniedException,
KmsInvalidStateException,
KmsThrottlingException,
AwsServiceException,
SdkClientException,
SfnException

Starts a Synchronous Express state machine execution. StartSyncExecution is not available for STANDARD workflows.

StartSyncExecution will return a 200 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 via StartSyncExecutionRequest.builder()

Parameters:

startSyncExecutionRequest - A Consumer that will call methods on StartSyncExecutionRequest.Builder to create a request.

Returns:

Result of the StartSyncExecution operation returned by the service.

See Also:

• AWS API Documentation

stopExecution

default StopExecutionResponse stopExecution(StopExecutionRequest stopExecutionRequest)
                                     throws ExecutionDoesNotExistException,
InvalidArnException,
ValidationException,
KmsAccessDeniedException,
KmsInvalidStateException,
KmsThrottlingException,
AwsServiceException,
SdkClientException,
SfnException

Stops an execution.

This API action is not supported by EXPRESS state machines.

For an execution with encryption enabled, Step Functions will encrypt the error and cause fields using the KMS key for the execution role.

A caller can stop an execution without using any KMS permissions in the execution role if the caller provides a null value for both error and cause fields because no data needs to be encrypted.

Parameters:

stopExecutionRequest -

Returns:

Result of the StopExecution operation returned by the service.

See Also:

• AWS API Documentation

stopExecution

default StopExecutionResponse stopExecution(Consumer<StopExecutionRequest.Builder> stopExecutionRequest)
                                     throws ExecutionDoesNotExistException,
InvalidArnException,
ValidationException,
KmsAccessDeniedException,
KmsInvalidStateException,
KmsThrottlingException,
AwsServiceException,
SdkClientException,
SfnException

Stops an execution.

This API action is not supported by EXPRESS state machines.

For an execution with encryption enabled, Step Functions will encrypt the error and cause fields using the KMS key for the execution role.

A caller can stop an execution without using any KMS permissions in the execution role if the caller provides a null value for both error and cause fields because no data needs to be encrypted.

This is a convenience which creates an instance of the StopExecutionRequest.Builder avoiding the need to create one manually via StopExecutionRequest.builder()

Parameters:

stopExecutionRequest - A Consumer that will call methods on StopExecutionRequest.Builder to create a request.

Returns:

Result of the StopExecution operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws InvalidArnException,
ResourceNotFoundException,
TooManyTagsException,
AwsServiceException,
SdkClientException,
SfnException

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:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws InvalidArnException,
ResourceNotFoundException,
TooManyTagsException,
AwsServiceException,
SdkClientException,
SfnException

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 via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

testState

default TestStateResponse testState(TestStateRequest testStateRequest)
                             throws InvalidArnException,
InvalidDefinitionException,
InvalidExecutionInputException,
ValidationException,
AwsServiceException,
SdkClientException,
SfnException

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:

• All Task types except Activity

• Pass

• Wait

• Choice

• Succeed

• Fail

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 the States.Timeout error.

TestState doesn't support Activity tasks, .sync or .waitForTaskToken service integration patterns, Parallel, or Map states.

Parameters:

testStateRequest -

Returns:

Result of the TestState operation returned by the service.

See Also:

• AWS API Documentation

testState

default TestStateResponse testState(Consumer<TestStateRequest.Builder> testStateRequest)
                             throws InvalidArnException,
InvalidDefinitionException,
InvalidExecutionInputException,
ValidationException,
AwsServiceException,
SdkClientException,
SfnException

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:

• All Task types except Activity

• Pass

• Wait

• Choice

• Succeed

• Fail

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 the States.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 via TestStateRequest.builder()

Parameters:

testStateRequest - A Consumer that will call methods on TestStateRequest.Builder to create a request.

Returns:

Result of the TestState operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws InvalidArnException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
SfnException

Remove a tag from a Step Functions resource

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws InvalidArnException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
SfnException

Remove a tag from a Step Functions resource

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateMapRun

default UpdateMapRunResponse updateMapRun(UpdateMapRunRequest updateMapRunRequest)
                                   throws ResourceNotFoundException,
InvalidArnException,
ValidationException,
AwsServiceException,
SdkClientException,
SfnException

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:

Result of the UpdateMapRun operation returned by the service.

See Also:

• AWS API Documentation

updateMapRun

default UpdateMapRunResponse updateMapRun(Consumer<UpdateMapRunRequest.Builder> updateMapRunRequest)
                                   throws ResourceNotFoundException,
InvalidArnException,
ValidationException,
AwsServiceException,
SdkClientException,
SfnException

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 via UpdateMapRunRequest.builder()

Parameters:

updateMapRunRequest - A Consumer that will call methods on UpdateMapRunRequest.Builder to create a request.

Returns:

Result of the UpdateMapRun operation returned by the service.

See Also:

• AWS API Documentation

updateStateMachine

default UpdateStateMachineResponse updateStateMachine(UpdateStateMachineRequest updateStateMachineRequest)
                                               throws InvalidArnException,
InvalidDefinitionException,
InvalidLoggingConfigurationException,
InvalidTracingConfigurationException,
MissingRequiredParameterException,
StateMachineDeletingException,
StateMachineDoesNotExistException,
ServiceQuotaExceededException,
ConflictException,
ValidationException,
InvalidEncryptionConfigurationException,
KmsAccessDeniedException,
KmsThrottlingException,
AwsServiceException,
SdkClientException,
SfnException

Updates an existing state machine by modifying its definition, roleArn, loggingConfiguration, or EncryptionConfiguration. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error.

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 label mapStateLabel in the state machine named stateMachineName.

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 named myStateMachine.

  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 to true 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 updated definition and roleArn. Executions started immediately after you call UpdateStateMachine may use the previous state machine definition and roleArn.

Parameters:

updateStateMachineRequest -

Returns:

Result of the UpdateStateMachine operation returned by the service.

See Also:

• AWS API Documentation

updateStateMachine

default UpdateStateMachineResponse updateStateMachine(Consumer<UpdateStateMachineRequest.Builder> updateStateMachineRequest)
                                               throws InvalidArnException,
InvalidDefinitionException,
InvalidLoggingConfigurationException,
InvalidTracingConfigurationException,
MissingRequiredParameterException,
StateMachineDeletingException,
StateMachineDoesNotExistException,
ServiceQuotaExceededException,
ConflictException,
ValidationException,
InvalidEncryptionConfigurationException,
KmsAccessDeniedException,
KmsThrottlingException,
AwsServiceException,
SdkClientException,
SfnException

Updates an existing state machine by modifying its definition, roleArn, loggingConfiguration, or EncryptionConfiguration. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error.

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 label mapStateLabel in the state machine named stateMachineName.

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 named myStateMachine.

  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 to true 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 updated definition and roleArn. Executions started immediately after you call UpdateStateMachine may use the previous state machine definition and roleArn.

This is a convenience which creates an instance of the UpdateStateMachineRequest.Builder avoiding the need to create one manually via UpdateStateMachineRequest.builder()

Parameters:

updateStateMachineRequest - A Consumer that will call methods on UpdateStateMachineRequest.Builder to create a request.

Returns:

Result of the UpdateStateMachine operation returned by the service.

See Also:

• AWS API Documentation

updateStateMachineAlias

default UpdateStateMachineAliasResponse updateStateMachineAlias(UpdateStateMachineAliasRequest updateStateMachineAliasRequest)
                                                         throws ValidationException,
InvalidArnException,
ResourceNotFoundException,
ConflictException,
StateMachineDeletingException,
AwsServiceException,
SdkClientException,
SfnException

Updates the configuration of an existing state machine alias by modifying its description or routingConfiguration.

You must specify at least one of the description or routingConfiguration parameters to update a state machine alias.

UpdateStateMachineAlias is an idempotent API. Step Functions bases the idempotency check on the stateMachineAliasArn, description, and routingConfiguration 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:

• CreateStateMachineAlias

• DescribeStateMachineAlias

• ListStateMachineAliases

• DeleteStateMachineAlias

Parameters:

updateStateMachineAliasRequest -

Returns:

Result of the UpdateStateMachineAlias operation returned by the service.

See Also:

• AWS API Documentation

updateStateMachineAlias

default UpdateStateMachineAliasResponse updateStateMachineAlias(Consumer<UpdateStateMachineAliasRequest.Builder> updateStateMachineAliasRequest)
                                                         throws ValidationException,
InvalidArnException,
ResourceNotFoundException,
ConflictException,
StateMachineDeletingException,
AwsServiceException,
SdkClientException,
SfnException

Updates the configuration of an existing state machine alias by modifying its description or routingConfiguration.

You must specify at least one of the description or routingConfiguration parameters to update a state machine alias.

UpdateStateMachineAlias is an idempotent API. Step Functions bases the idempotency check on the stateMachineAliasArn, description, and routingConfiguration 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:

• CreateStateMachineAlias

• DescribeStateMachineAlias

• ListStateMachineAliases

• DeleteStateMachineAlias

This is a convenience which creates an instance of the UpdateStateMachineAliasRequest.Builder avoiding the need to create one manually via UpdateStateMachineAliasRequest.builder()

Parameters:

updateStateMachineAliasRequest - A Consumer that will call methods on UpdateStateMachineAliasRequest.Builder to create a request.

Returns:

Result of the UpdateStateMachineAlias operation returned by the service.

See Also:

• AWS API Documentation

validateStateMachineDefinition

default ValidateStateMachineDefinitionResponse validateStateMachineDefinition(ValidateStateMachineDefinitionRequest validateStateMachineDefinitionRequest)
                                                                       throws ValidationException,
AwsServiceException,
SdkClientException,
SfnException

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 and UpdateStateMachine. 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:

Result of the ValidateStateMachineDefinition operation returned by the service.

See Also:

• AWS API Documentation

validateStateMachineDefinition

default ValidateStateMachineDefinitionResponse validateStateMachineDefinition(Consumer<ValidateStateMachineDefinitionRequest.Builder> validateStateMachineDefinitionRequest)
                                                                       throws ValidationException,
AwsServiceException,
SdkClientException,
SfnException

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 and UpdateStateMachine. 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 via ValidateStateMachineDefinitionRequest.builder()

Parameters:

validateStateMachineDefinitionRequest - A Consumer that will call methods on ValidateStateMachineDefinitionRequest.Builder to create a request.

Returns:

Result of the ValidateStateMachineDefinition operation returned by the service.

See Also:

• AWS API Documentation

create

static SfnClient create()

Create a SfnClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static SfnClientBuilder builder()

Create a builder that can be used to configure and create a SfnClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default SfnServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration