Home / general

SfnClient (AWS SDK for Java

Sophia Edwards | March 16, 2026

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

Step Functions is a service that lets you coordinate the components of distributed applications and microservices using visual workflows.

You can use Step Functions to build applications from individual components, each of which performs a discrete function, or task, allowing you to scale and change applications quickly. Step Functions provides a console that helps visualize the components of your application as a series of steps. Step Functions automatically triggers and tracks each step, and retries steps when there are errors, so your application executes predictably and in the right order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any issues.

Step Functions manages operations and underlying infrastructure to ensure your application is available at any scale. You can run tasks on Amazon Web Services, your own servers, or any system that has access to Amazon Web Services. You can access and use Step Functions using the console, the Amazon Web Services SDKs, or an HTTP API. For more information about Step Functions, see the Step Functions Developer Guide .

If you use the Step Functions API actions using Amazon Web Services SDK integrations, make sure the API actions are in camel case and parameter names are in Pascal case. For example, you could use Step Functions API action startSyncExecution and specify its parameter as StateMachineArn.

• Field Summary

  Fields

• Method Summary

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

  Creates an activity.

  Creates an activity.

  Creates a state machine.

  Creates a state machine.

  Creates an alias for a state machine that points to one or two versions of the same state machine. Creates an alias for a state machine that points to one or two versions of the same state machine.

  Deletes an activity.

  Deletes an activity.

  Deletes a state machine.

  Deletes a state machine.

  Deletes a state machine alias. Deletes a state machine alias.

  Describes an activity.

  Describes an activity.

  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.

  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.

  Provides information about a Map Run's configuration, progress, and results.

  Provides information about a Map Run's configuration, progress, and results.

  Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration.

  Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration.

  Returns details about a state machine alias. Returns details about a state machine alias.

  Provides information about a state machine's definition, its execution role ARN, and configuration.

  Provides information about a state machine's definition, its execution role ARN, and configuration.

  Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine.

  Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine.

  Returns the history of the specified execution as a list of events.

  Returns the history of the specified execution as a list of events.

  Lists the existing activities.

  Lists the existing activities.

  Lists the existing activities.

  Lists all executions of a state machine or a Map Run.

  Lists all executions of a state machine or a Map Run.

  Lists all Map Runs that were started by a given state machine execution.

  Lists all Map Runs that were started by a given state machine execution.

  Lists aliases for a specified state machine ARN. Lists aliases for a specified state machine ARN.

  Lists the existing state machines.

  Lists the existing state machines.

  Lists the existing state machines.

  Lists versions for the specified state machine Amazon Resource Name (ARN). Lists versions for the specified state machine Amazon Resource Name (ARN).

  List tags for a given resource.

  List tags for a given resource.

  Creates a version from the current revision of a state machine. Creates a version from the current revision of a state machine.

  Restarts unsuccessful executions of Standard workflows that didn't complete successfully in the last 14 days.

  Restarts unsuccessful executions of Standard workflows that didn't complete successfully in the last 14 days.

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

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

  Starts a state machine execution.

  Starts a state machine execution.

  Starts a Synchronous Express state machine execution.

  Starts a Synchronous Express state machine execution.

  Stops an execution.

  Stops an execution.

  Add a tag to a Step Functions resource.

  Add a tag to a Step Functions resource.

  Accepts the definition of a single state and executes it.

  Accepts the definition of a single state and executes it.

  Remove a tag from a Step Functions resource

  Remove a tag from a Step Functions resource

  Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure.

  Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure.

  Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration.

  Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration.

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

• Field Details

  • SERVICE_NAME

    static final String SERVICE_NAME

    See Also:

  • SERVICE_METADATA_ID

    static final String SERVICE_METADATA_ID

    See Also:

• Method Details

  • createActivity

    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:

  • createActivity

    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:

  • createStateMachine

    default CreateStateMachineResponse createStateMachine(CreateStateMachineRequest createStateMachineRequest) throws InvalidArnException,InvalidDefinitionException,InvalidNameException,InvalidLoggingConfigurationException,InvalidTracingConfigurationException,StateMachineAlreadyExistsException,StateMachineDeletingException,StateMachineLimitExceededException,StateMachineTypeNotSupportedException,TooManyTagsException,ValidationException,ConflictException,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.

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

    CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name, definition, type, LoggingConfiguration, and TracingConfiguration. 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:

  • createStateMachine

    default CreateStateMachineResponse createStateMachine(Consumer<CreateStateMachineRequest.Builder> createStateMachineRequest) throws InvalidArnException,InvalidDefinitionException,InvalidNameException,InvalidLoggingConfigurationException,InvalidTracingConfigurationException,StateMachineAlreadyExistsException,StateMachineDeletingException,StateMachineLimitExceededException,StateMachineTypeNotSupportedException,TooManyTagsException,ValidationException,ConflictException,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.

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

    CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name, definition, type, LoggingConfiguration, and TracingConfiguration. 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:

  • createStateMachineAlias

    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:

    Parameters:

    createStateMachineAliasRequest -

    Returns:

    Result of the CreateStateMachineAlias operation returned by the service.

    See Also:

  • createStateMachineAlias

    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:

    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:

  • deleteActivity

    Deletes an activity.

    Parameters:

    deleteActivityRequest -

    Returns:

    Result of the DeleteActivity operation returned by the service.

    See Also:

  • deleteActivity

    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:

  • deleteStateMachine

    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:

  • deleteStateMachine

    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:

  • deleteStateMachineAlias

    Deletes a state machine alias.

    After you delete a state machine alias, you can't use it to start executions. When you delete a state machine alias, Step Functions doesn't delete the state machine versions that alias references.

    Related operations:

    Parameters:

    deleteStateMachineAliasRequest -

    Returns:

    Result of the DeleteStateMachineAlias operation returned by the service.

    See Also:

  • deleteStateMachineAlias

    Deletes a state machine alias.

    After you delete a state machine alias, you can't use it to start executions. When you delete a state machine alias, Step Functions doesn't delete the state machine versions that alias references.

    Related operations:

    This is a convenience which creates an instance of the DeleteStateMachineAliasRequest.Builder avoiding the need to create one manually 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:

  • deleteStateMachineVersion

    Deletes a state machine version. After you delete a version, you can't call StartExecution using that version's ARN or use the version with a state machine alias.

    Deleting a state machine version won't terminate its in-progress executions.

    You can't delete a state machine version currently referenced by one or more aliases. Before you delete a version, you must either delete the aliases or update them to point to another state machine version.

    Related operations:

    Parameters:

    deleteStateMachineVersionRequest -

    Returns:

    Result of the DeleteStateMachineVersion operation returned by the service.

    See Also:

  • deleteStateMachineVersion

    Deletes a state machine version. After you delete a version, you can't call StartExecution using that version's ARN or use the version with a state machine alias.

    Deleting a state machine version won't terminate its in-progress executions.

    You can't delete a state machine version currently referenced by one or more aliases. Before you delete a version, you must either delete the aliases or update them to point to another state machine version.

    Related operations:

    This is a convenience which creates an instance of the DeleteStateMachineVersionRequest.Builder avoiding the need to create one manually 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:

  • describeActivity

    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:

  • describeActivity

    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:

  • describeExecution

    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:

  • describeExecution

    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:

  • describeMapRun

    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:

  • describeMapRun

    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:

  • describeStateMachine

    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:

  • describeStateMachine

    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:

  • describeStateMachineAlias

    Returns details about a state machine alias.

    Related operations:

    Parameters:

    describeStateMachineAliasRequest -

    Returns:

    Result of the DescribeStateMachineAlias operation returned by the service.

    See Also:

  • describeStateMachineAlias

    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:

  • describeStateMachineForExecution

    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:

  • describeStateMachineForExecution

    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:

  • getActivityTask

    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:

  • getActivityTask

    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:

  • getExecutionHistory

    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:

  • getExecutionHistory

    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:

  • getExecutionHistoryPaginator

    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:

  • getExecutionHistoryPaginator

    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:

  • listActivities

    Lists the existing activities.

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

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

    Parameters:

    listActivitiesRequest -

    Returns:

    Result of the ListActivities operation returned by the service.

    See Also:

  • listActivities

    Lists the existing activities.

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

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

    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:

  • listActivities

    Lists the existing activities.

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

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

    Returns:

    Result of the ListActivities operation returned by the service.

    See Also:

  • listActivitiesPaginator

    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

    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:

  • listActivitiesPaginator

    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:

  • listExecutions

    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:

  • listExecutions

    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:

  • listExecutionsPaginator

    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:

  • listExecutionsPaginator

    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:

  • listMapRuns

    Lists all Map Runs that were started by a given state machine execution. Use this API action to obtain Map Run ARNs, and then call DescribeMapRun to obtain more information, if needed.

    Parameters:

    listMapRunsRequest -

    Returns:

    Result of the ListMapRuns operation returned by the service.

    See Also:

  • listMapRuns

    Lists all Map Runs that were started by a given state machine execution. Use this API action to obtain Map Run ARNs, and then call DescribeMapRun to obtain more information, if needed.

    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:

  • listMapRunsPaginator

    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:

  • listMapRunsPaginator

    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:

  • listStateMachineAliases

    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:

    Parameters:

    listStateMachineAliasesRequest -

    Returns:

    Result of the ListStateMachineAliases operation returned by the service.

    See Also:

  • listStateMachineAliases

    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:

    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:

  • listStateMachineVersions

    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:

    Parameters:

    listStateMachineVersionsRequest -

    Returns:

    Result of the ListStateMachineVersions operation returned by the service.

    See Also:

  • listStateMachineVersions

    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:

    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:

  • listStateMachines

    Lists the existing state machines.

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

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

    Parameters:

    listStateMachinesRequest -

    Returns:

    Result of the ListStateMachines operation returned by the service.

    See Also:

  • listStateMachines

    Lists the existing state machines.

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

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

    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:

  • listStateMachines

    Lists the existing state machines.

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

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

    Returns:

    Result of the ListStateMachines operation returned by the service.

    See Also:

  • listStateMachinesPaginator

    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

    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:

  • listStateMachinesPaginator

    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:

  • listTagsForResource

    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:

  • listTagsForResource

    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:

  • publishStateMachineVersion

    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:

    Parameters:

    publishStateMachineVersionRequest -

    Returns:

    Result of the PublishStateMachineVersion operation returned by the service.

    See Also:

  • publishStateMachineVersion

    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:

    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:

  • redriveExecution

    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:

  • redriveExecution

    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:

  • sendTaskFailure

    Used by activity workers, Task states using the callback pattern, and optionally Task states using the job run pattern to report that the task identified by the taskToken failed.

    Parameters:

    sendTaskFailureRequest -

    Returns:

    Result of the SendTaskFailure operation returned by the service.

    See Also:

  • sendTaskFailure

    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:

  • sendTaskHeartbeat

    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:

  • sendTaskHeartbeat

    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:

  • sendTaskSuccess

    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:

  • sendTaskSuccess

    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:

  • startExecution

    default StartExecutionResponse startExecution(StartExecutionRequest startExecutionRequest) throws ExecutionLimitExceededException,ExecutionAlreadyExistsException,InvalidArnException,InvalidExecutionInputException,InvalidNameException,StateMachineDoesNotExistException,StateMachineDeletingException,ValidationException,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:

  • startExecution

    default StartExecutionResponse startExecution(Consumer<StartExecutionRequest.Builder> startExecutionRequest) throws ExecutionLimitExceededException,ExecutionAlreadyExistsException,InvalidArnException,InvalidExecutionInputException,InvalidNameException,StateMachineDoesNotExistException,StateMachineDeletingException,ValidationException,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:

  • startSyncExecution

    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:

  • startSyncExecution

    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:

  • stopExecution

    Stops an execution.

    This API action is not supported by EXPRESS state machines.

    Parameters:

    stopExecutionRequest -

    Returns:

    Result of the StopExecution operation returned by the service.

    See Also:

  • stopExecution

    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:

  • tagResource

    Add a tag to a Step Functions resource.

    An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

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

    Parameters:

    tagResourceRequest -

    Returns:

    Result of the TagResource operation returned by the service.

    See Also:

  • tagResource

    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:

  • testState

    Accepts the definition of a single state and executes it. You can test a state without creating a state machine or updating an existing state machine. Using this API, you can test the following:

    You can call this API on only one state at a time. The states that you can test include the following:

    The TestState API assumes an IAM role which must contain the required IAM permissions for the resources your state is accessing. For information about the permissions a state might need, see IAM permissions to test a state.

    The TestState API can run for up to five minutes. If the execution of a state exceeds this duration, it fails with 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:

  • testState

    Accepts the definition of a single state and executes it. You can test a state without creating a state machine or updating an existing state machine. Using this API, you can test the following:

    You can call this API on only one state at a time. The states that you can test include the following:

    The TestState API assumes an IAM role which must contain the required IAM permissions for the resources your state is accessing. For information about the permissions a state might need, see IAM permissions to test a state.

    The TestState API can run for up to five minutes. If the execution of a state exceeds this duration, it fails with 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:

  • untagResource

    Remove a tag from a Step Functions resource

    Parameters:

    untagResourceRequest -

    Returns:

    Result of the UntagResource operation returned by the service.

    See Also:

  • untagResource

    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:

  • updateMapRun

    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:

  • updateMapRun

    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:

  • updateStateMachine

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

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

    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:

  • updateStateMachine

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

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

    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:

  • updateStateMachineAlias

    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:

    Parameters:

    updateStateMachineAliasRequest -

    Returns:

    Result of the UpdateStateMachineAlias operation returned by the service.

    See Also:

  • updateStateMachineAlias

    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:

    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:

  • create

  • builder

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

  • serviceMetadata

  • 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

You Might Also Like

Unlocking The Secrets Of Brenda Lee's Towering Husband

Unveiling Paul Rudd's Star-Crossed Performance In Romeo And Juliet

Unveiling The Dynamic Duo: David And Sophie McCallum

Unveiling The Endearing Nickname: Elvis' Mother's Love Revealed

Table of Contents

1. Field Summary
2. Method Summary
3. Field Details
4. SERVICE_NAME
5. SERVICE_METADATA_ID
6. Method Details
7. createActivity
8. createActivity
9. createStateMachine
10. createStateMachine
11. createStateMachineAlias
12. createStateMachineAlias
13. deleteActivity
14. deleteActivity
15. deleteStateMachine
16. deleteStateMachine
17. deleteStateMachineAlias
18. deleteStateMachineAlias
19. deleteStateMachineVersion
20. deleteStateMachineVersion
21. describeActivity
22. describeActivity
23. describeExecution
24. describeExecution
25. describeMapRun
26. describeMapRun
27. describeStateMachine
28. describeStateMachine
29. describeStateMachineAlias
30. describeStateMachineAlias
31. describeStateMachineForExecution
32. describeStateMachineForExecution
33. getActivityTask
34. getActivityTask
35. getExecutionHistory
36. getExecutionHistory
37. getExecutionHistoryPaginator
38. getExecutionHistoryPaginator
39. listActivities
40. listActivities
41. listActivities
42. listActivitiesPaginator
43. listActivitiesPaginator
44. listActivitiesPaginator
45. listExecutions
46. listExecutions
47. listExecutionsPaginator
48. listExecutionsPaginator
49. listMapRuns
50. listMapRuns
51. listMapRunsPaginator
52. listMapRunsPaginator
53. listStateMachineAliases
54. listStateMachineAliases
55. listStateMachineVersions
56. listStateMachineVersions
57. listStateMachines
58. listStateMachines
59. listStateMachines
60. listStateMachinesPaginator
61. listStateMachinesPaginator
62. listStateMachinesPaginator
63. listTagsForResource
64. listTagsForResource
65. publishStateMachineVersion
66. publishStateMachineVersion
67. redriveExecution
68. redriveExecution
69. sendTaskFailure
70. sendTaskFailure
71. sendTaskHeartbeat
72. sendTaskHeartbeat
73. sendTaskSuccess
74. sendTaskSuccess
75. startExecution
76. startExecution
77. startSyncExecution
78. startSyncExecution
79. stopExecution
80. stopExecution
81. tagResource
82. tagResource
83. testState
84. testState
85. untagResource
86. untagResource
87. updateMapRun
88. updateMapRun
89. updateStateMachine
90. updateStateMachine
91. updateStateMachineAlias
92. updateStateMachineAlias
93. create
94. builder
95. serviceMetadata
96. serviceClientConfiguration

More on this Topic

• 

  Age, Expertise, And Wikipedia Impact

• 

  Is Hikaru Nakamura Married? Who is Hikaru Nakamura's Wife?

• 

  Selina Bar And Grill Mississippi

• 

  Uncover The Extraordinary Journey Of Young M.A: Discoveries And Insights

• 

  Martin Short Height

• 

  Uncovering The Identity Of Kem's First Wife