Interface SfnAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface SfnAsyncClient extends AwsClient
Service client for accessing AWS SFN asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call. Step Functions

With Step Functions, you can create workflows, also called state machines, to build distributed applications, automate processes, orchestrate microservices, and create data and machine learning pipelines.

Through the Step Functions API, you can create, list, update, and delete state machines, activities, and other data types. You can start, stop, and redrive your state machines. Your activity workers can send task success, heartbeat, and failure responses.

With API calls, you can also manage other aspects of your workflow, such as tags, versions, and aliases.

For more information about developing solutions with 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 might use Step Functions API action startSyncExecution and specify its parameter as StateMachineArn.

  • Field Details

  • Method Details

    • createActivity

      default CompletableFuture<CreateActivityResponse> createActivity(CreateActivityRequest createActivityRequest)

      Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond 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:
      A Java Future containing the result of the CreateActivity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ActivityLimitExceededException The maximum number of activities has been reached. Existing activities must be deleted before a new activity can be created.
      • ActivityAlreadyExistsException Activity already exists. EncryptionConfiguration may not be updated.
      • InvalidNameException The provided name is not valid.
      • TooManyTagsException You've exceeded the number of tags allowed for a resource. See the Limits Topic in the Step Functions Developer Guide.
      • InvalidEncryptionConfigurationException Received when encryptionConfiguration is specified but various conditions exist which make the configuration invalid. For example, if type is set to CUSTOMER_MANAGED_KMS_KEY, but kmsKeyId is null, or kmsDataKeyReusePeriodSeconds is not between 60 and 900, or the KMS key is not symmetric or inactive.
      • KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
      • KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createActivity

      default CompletableFuture<CreateActivityResponse> createActivity(Consumer<CreateActivityRequest.Builder> createActivityRequest)

      Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond 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:
      A Java Future containing the result of the CreateActivity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ActivityLimitExceededException The maximum number of activities has been reached. Existing activities must be deleted before a new activity can be created.
      • ActivityAlreadyExistsException Activity already exists. EncryptionConfiguration may not be updated.
      • InvalidNameException The provided name is not valid.
      • TooManyTagsException You've exceeded the number of tags allowed for a resource. See the Limits Topic in the Step Functions Developer Guide.
      • InvalidEncryptionConfigurationException Received when encryptionConfiguration is specified but various conditions exist which make the configuration invalid. For example, if type is set to CUSTOMER_MANAGED_KMS_KEY, but kmsKeyId is null, or kmsDataKeyReusePeriodSeconds is not between 60 and 900, or the KMS key is not symmetric or inactive.
      • KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
      • KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createStateMachine

      default CompletableFuture<CreateStateMachineResponse> createStateMachine(CreateStateMachineRequest createStateMachineRequest)

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

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

      For additional control over security, you can encrypt your data using a customer-managed key for Step Functions state machines. You can configure a symmetric KMS key and data key reuse period when creating or updating a State Machine. The execution history and state machine definition will be encrypted with the key applied to the State Machine.

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

      CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name, definition, type, LoggingConfiguration, TracingConfiguration, and EncryptionConfiguration The check is also based on the publish and versionDescription parameters. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.

      Parameters:
      createStateMachineRequest -
      Returns:
      A Java Future containing the result of the CreateStateMachine operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • InvalidDefinitionException The provided Amazon States Language definition is not valid.
      • InvalidNameException The provided name is not valid.
      • InvalidLoggingConfigurationException Configuration is not valid.
      • InvalidTracingConfigurationException Your tracingConfiguration key does not match, or enabled has not been set to true or false.
      • StateMachineAlreadyExistsException A state machine with the same name but a different definition or role ARN already exists.
      • StateMachineDeletingException The specified state machine is being deleted.
      • StateMachineLimitExceededException The maximum number of state machines has been reached. Existing state machines must be deleted before a new state machine can be created.
      • StateMachineTypeNotSupportedException State machine type is not supported.
      • TooManyTagsException You've exceeded the number of tags allowed for a resource. See the Limits Topic in the Step Functions Developer Guide.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

        HTTP Status Code: 409

      • InvalidEncryptionConfigurationException Received when encryptionConfiguration is specified but various conditions exist which make the configuration invalid. For example, if type is set to CUSTOMER_MANAGED_KMS_KEY, but kmsKeyId is null, or kmsDataKeyReusePeriodSeconds is not between 60 and 900, or the KMS key is not symmetric or inactive.
      • KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
      • KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createStateMachine

      default CompletableFuture<CreateStateMachineResponse> createStateMachine(Consumer<CreateStateMachineRequest.Builder> createStateMachineRequest)

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

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

      For additional control over security, you can encrypt your data using a customer-managed key for Step Functions state machines. You can configure a symmetric KMS key and data key reuse period when creating or updating a State Machine. The execution history and state machine definition will be encrypted with the key applied to the State Machine.

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

      CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name, definition, type, LoggingConfiguration, TracingConfiguration, and EncryptionConfiguration The check is also based on the publish and versionDescription parameters. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.


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

      Parameters:
      createStateMachineRequest - A Consumer that will call methods on CreateStateMachineRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateStateMachine operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • InvalidDefinitionException The provided Amazon States Language definition is not valid.
      • InvalidNameException The provided name is not valid.
      • InvalidLoggingConfigurationException Configuration is not valid.
      • InvalidTracingConfigurationException Your tracingConfiguration key does not match, or enabled has not been set to true or false.
      • StateMachineAlreadyExistsException A state machine with the same name but a different definition or role ARN already exists.
      • StateMachineDeletingException The specified state machine is being deleted.
      • StateMachineLimitExceededException The maximum number of state machines has been reached. Existing state machines must be deleted before a new state machine can be created.
      • StateMachineTypeNotSupportedException State machine type is not supported.
      • TooManyTagsException You've exceeded the number of tags allowed for a resource. See the Limits Topic in the Step Functions Developer Guide.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

        HTTP Status Code: 409

      • InvalidEncryptionConfigurationException Received when encryptionConfiguration is specified but various conditions exist which make the configuration invalid. For example, if type is set to CUSTOMER_MANAGED_KMS_KEY, but kmsKeyId is null, or kmsDataKeyReusePeriodSeconds is not between 60 and 900, or the KMS key is not symmetric or inactive.
      • KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
      • KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createStateMachineAlias

      default CompletableFuture<CreateStateMachineAliasResponse> createStateMachineAlias(CreateStateMachineAliasRequest createStateMachineAliasRequest)

      Creates an alias for a state machine that points to one or two versions of the same state machine. You can set your application to call StartExecution with an alias and update the version the alias uses without changing the client's code.

      You can also map an alias to split StartExecution requests between two versions of a state machine. To do this, add a second RoutingConfig object in 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:
      A Java Future containing the result of the CreateStateMachineAlias operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • InvalidNameException The provided name is not valid.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • StateMachineDeletingException The specified state machine is being deleted.
      • ResourceNotFoundException Could not find the referenced resource.
      • ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

        HTTP Status Code: 409

      • ServiceQuotaExceededException The request would cause a service quota to be exceeded.

        HTTP Status Code: 402

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createStateMachineAlias

      default CompletableFuture<CreateStateMachineAliasResponse> createStateMachineAlias(Consumer<CreateStateMachineAliasRequest.Builder> createStateMachineAliasRequest)

      Creates an alias for a state machine that points to one or two versions of the same state machine. You can set your application to call StartExecution with an alias and update the version the alias uses without changing the client's code.

      You can also map an alias to split StartExecution requests between two versions of a state machine. To do this, add a second RoutingConfig object in 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:
      A Java Future containing the result of the CreateStateMachineAlias operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • InvalidNameException The provided name is not valid.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • StateMachineDeletingException The specified state machine is being deleted.
      • ResourceNotFoundException Could not find the referenced resource.
      • ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

        HTTP Status Code: 409

      • ServiceQuotaExceededException The request would cause a service quota to be exceeded.

        HTTP Status Code: 402

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteActivity

      default CompletableFuture<DeleteActivityResponse> deleteActivity(DeleteActivityRequest deleteActivityRequest)

      Deletes an activity.

      Parameters:
      deleteActivityRequest -
      Returns:
      A Java Future containing the result of the DeleteActivity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteActivity

      default CompletableFuture<DeleteActivityResponse> deleteActivity(Consumer<DeleteActivityRequest.Builder> deleteActivityRequest)

      Deletes an activity.


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

      Parameters:
      deleteActivityRequest - A Consumer that will call methods on DeleteActivityRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteActivity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteStateMachine

      default CompletableFuture<DeleteStateMachineResponse> deleteStateMachine(DeleteStateMachineRequest deleteStateMachineRequest)

      Deletes a state machine. This is an asynchronous operation. It sets the state machine's status to DELETING and begins the deletion process. A state machine is deleted only when all its executions are completed. On the next state transition, the state machine's executions are terminated.

      A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

      The following are some examples of qualified and unqualified state machine ARNs:

      • The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine 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:
      A Java Future containing the result of the DeleteStateMachine operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteStateMachine

      default CompletableFuture<DeleteStateMachineResponse> deleteStateMachine(Consumer<DeleteStateMachineRequest.Builder> deleteStateMachineRequest)

      Deletes a state machine. This is an asynchronous operation. It sets the state machine's status to DELETING and begins the deletion process. A state machine is deleted only when all its executions are completed. On the next state transition, the state machine's executions are terminated.

      A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

      The following are some examples of qualified and unqualified state machine ARNs:

      • The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine 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:
      A Java Future containing the result of the DeleteStateMachine operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteStateMachineAlias

      default CompletableFuture<DeleteStateMachineAliasResponse> deleteStateMachineAlias(DeleteStateMachineAliasRequest deleteStateMachineAliasRequest)

      Deletes a state machine alias.

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

      Related operations:

      Parameters:
      deleteStateMachineAliasRequest -
      Returns:
      A Java Future containing the result of the DeleteStateMachineAlias operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • ResourceNotFoundException Could not find the referenced resource.
      • ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

        HTTP Status Code: 409

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteStateMachineAlias

      default CompletableFuture<DeleteStateMachineAliasResponse> deleteStateMachineAlias(Consumer<DeleteStateMachineAliasRequest.Builder> deleteStateMachineAliasRequest)

      Deletes a state machine alias.

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

      Related operations:


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

      Parameters:
      deleteStateMachineAliasRequest - A Consumer that will call methods on DeleteStateMachineAliasRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteStateMachineAlias operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • ResourceNotFoundException Could not find the referenced resource.
      • ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

        HTTP Status Code: 409

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteStateMachineVersion

      default CompletableFuture<DeleteStateMachineVersionResponse> deleteStateMachineVersion(DeleteStateMachineVersionRequest deleteStateMachineVersionRequest)

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

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

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

      Related operations:

      Parameters:
      deleteStateMachineVersionRequest -
      Returns:
      A Java Future containing the result of the DeleteStateMachineVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

        HTTP Status Code: 409

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteStateMachineVersion

      default CompletableFuture<DeleteStateMachineVersionResponse> deleteStateMachineVersion(Consumer<DeleteStateMachineVersionRequest.Builder> deleteStateMachineVersionRequest)

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

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

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

      Related operations:


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

      Parameters:
      deleteStateMachineVersionRequest - A Consumer that will call methods on DeleteStateMachineVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteStateMachineVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

        HTTP Status Code: 409

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeActivity

      default CompletableFuture<DescribeActivityResponse> describeActivity(DescribeActivityRequest describeActivityRequest)

      Describes an activity.

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

      Parameters:
      describeActivityRequest -
      Returns:
      A Java Future containing the result of the DescribeActivity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ActivityDoesNotExistException The specified activity does not exist.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeActivity

      default CompletableFuture<DescribeActivityResponse> describeActivity(Consumer<DescribeActivityRequest.Builder> describeActivityRequest)

      Describes an activity.

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


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

      Parameters:
      describeActivityRequest - A Consumer that will call methods on DescribeActivityRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeActivity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ActivityDoesNotExistException The specified activity does not exist.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeExecution

      default CompletableFuture<DescribeExecutionResponse> describeExecution(DescribeExecutionRequest describeExecutionRequest)

      Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. If you've redriven an execution, you can use this API action to return information about the redrives of that execution. In addition, you can use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was dispatched by a Map Run.

      If you specify a version or alias ARN when you call the StartExecution API action, DescribeExecution returns that ARN.

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

      Executions of an EXPRESS state machine aren't supported by DescribeExecution unless a Map Run dispatched them.

      Parameters:
      describeExecutionRequest -
      Returns:
      A Java Future containing the result of the DescribeExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ExecutionDoesNotExistException The specified execution does not exist.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
      • KmsInvalidStateException The KMS key is not in valid state, for example: Disabled or Deleted.
      • KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeExecution

      default CompletableFuture<DescribeExecutionResponse> describeExecution(Consumer<DescribeExecutionRequest.Builder> describeExecutionRequest)

      Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. If you've redriven an execution, you can use this API action to return information about the redrives of that execution. In addition, you can use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was dispatched by a Map Run.

      If you specify a version or alias ARN when you call the StartExecution API action, DescribeExecution returns that ARN.

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

      Executions of an EXPRESS state machine aren't supported 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:
      A Java Future containing the result of the DescribeExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ExecutionDoesNotExistException The specified execution does not exist.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
      • KmsInvalidStateException The KMS key is not in valid state, for example: Disabled or Deleted.
      • KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMapRun

      default CompletableFuture<DescribeMapRunResponse> describeMapRun(DescribeMapRunRequest describeMapRunRequest)

      Provides information about a Map Run's configuration, progress, and results. If you've redriven a Map Run, this API action also returns information about the redrives of that Map Run. For more information, see Examining Map Run in the Step Functions Developer Guide.

      Parameters:
      describeMapRunRequest -
      Returns:
      A Java Future containing the result of the DescribeMapRun operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException Could not find the referenced resource.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeMapRun

      default CompletableFuture<DescribeMapRunResponse> describeMapRun(Consumer<DescribeMapRunRequest.Builder> describeMapRunRequest)

      Provides information about a Map Run's configuration, progress, and results. If you've redriven a Map Run, this API action also returns information about the redrives of that Map Run. For more information, see Examining Map Run in the Step Functions Developer Guide.


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

      Parameters:
      describeMapRunRequest - A Consumer that will call methods on DescribeMapRunRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeMapRun operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException Could not find the referenced resource.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeStateMachine

      default CompletableFuture<DescribeStateMachineResponse> describeStateMachine(DescribeStateMachineRequest describeStateMachineRequest)

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

      A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

      The following are some examples of qualified and unqualified state machine ARNs:

      • The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine 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:
      A Java Future containing the result of the DescribeStateMachine operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • StateMachineDoesNotExistException The specified state machine does not exist.
      • KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
      • KmsInvalidStateException The KMS key is not in valid state, for example: Disabled or Deleted.
      • KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeStateMachine

      default CompletableFuture<DescribeStateMachineResponse> describeStateMachine(Consumer<DescribeStateMachineRequest.Builder> describeStateMachineRequest)

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

      A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

      The following are some examples of qualified and unqualified state machine ARNs:

      • The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine 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:
      A Java Future containing the result of the DescribeStateMachine operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • StateMachineDoesNotExistException The specified state machine does not exist.
      • KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
      • KmsInvalidStateException The KMS key is not in valid state, for example: Disabled or Deleted.
      • KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeStateMachineAlias

      default CompletableFuture<DescribeStateMachineAliasResponse> describeStateMachineAlias(DescribeStateMachineAliasRequest describeStateMachineAliasRequest)

      Returns details about a state machine alias.

      Related operations:

      Parameters:
      describeStateMachineAliasRequest -
      Returns:
      A Java Future containing the result of the DescribeStateMachineAlias operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • ResourceNotFoundException Could not find the referenced resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeStateMachineAlias

      default CompletableFuture<DescribeStateMachineAliasResponse> describeStateMachineAlias(Consumer<DescribeStateMachineAliasRequest.Builder> describeStateMachineAliasRequest)

      Returns details about a state machine alias.

      Related operations:


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

      Parameters:
      describeStateMachineAliasRequest - A Consumer that will call methods on DescribeStateMachineAliasRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeStateMachineAlias operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • ResourceNotFoundException Could not find the referenced resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeStateMachineForExecution

      default CompletableFuture<DescribeStateMachineForExecutionResponse> describeStateMachineForExecution(DescribeStateMachineForExecutionRequest describeStateMachineForExecutionRequest)

      Provides information about a state machine's definition, its execution role ARN, and configuration. If a Map Run dispatched the execution, this action returns the Map Run Amazon Resource Name (ARN) in the response. The state machine returned is the state machine associated with the Map Run.

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

      This API action is not supported by EXPRESS state machines.

      Parameters:
      describeStateMachineForExecutionRequest -
      Returns:
      A Java Future containing the result of the DescribeStateMachineForExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ExecutionDoesNotExistException The specified execution does not exist.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
      • KmsInvalidStateException The KMS key is not in valid state, for example: Disabled or Deleted.
      • KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeStateMachineForExecution

      default CompletableFuture<DescribeStateMachineForExecutionResponse> describeStateMachineForExecution(Consumer<DescribeStateMachineForExecutionRequest.Builder> describeStateMachineForExecutionRequest)

      Provides information about a state machine's definition, its execution role ARN, and configuration. If a Map Run dispatched the execution, this action returns the Map Run Amazon Resource Name (ARN) in the response. The state machine returned is the state machine associated with the Map Run.

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

      This API action is not supported by EXPRESS state machines.


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

      Parameters:
      describeStateMachineForExecutionRequest - A Consumer that will call methods on DescribeStateMachineForExecutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeStateMachineForExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ExecutionDoesNotExistException The specified execution does not exist.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
      • KmsInvalidStateException The KMS key is not in valid state, for example: Disabled or Deleted.
      • KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getActivityTask

      default CompletableFuture<GetActivityTaskResponse> getActivityTask(GetActivityTaskRequest getActivityTaskRequest)

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

      This API action isn't logged in CloudTrail.

      Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request).

      Polling with GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling for Activity Tasks in the Step Functions Developer Guide.

      Parameters:
      getActivityTaskRequest -
      Returns:
      A Java Future containing the result of the GetActivityTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ActivityDoesNotExistException The specified activity does not exist.
      • ActivityWorkerLimitExceededException The maximum number of workers concurrently polling for activity tasks has been reached.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
      • KmsInvalidStateException The KMS key is not in valid state, for example: Disabled or Deleted.
      • KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getActivityTask

      default CompletableFuture<GetActivityTaskResponse> getActivityTask(Consumer<GetActivityTaskRequest.Builder> getActivityTaskRequest)

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

      This API action isn't logged in CloudTrail.

      Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request).

      Polling with GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling for Activity Tasks in the Step Functions Developer Guide.


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

      Parameters:
      getActivityTaskRequest - A Consumer that will call methods on GetActivityTaskRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetActivityTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ActivityDoesNotExistException The specified activity does not exist.
      • ActivityWorkerLimitExceededException The maximum number of workers concurrently polling for activity tasks has been reached.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
      • KmsInvalidStateException The KMS key is not in valid state, for example: Disabled or Deleted.
      • KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getExecutionHistory

      default CompletableFuture<GetExecutionHistoryResponse> getExecutionHistory(GetExecutionHistoryRequest getExecutionHistoryRequest)

      Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use 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:
      A Java Future containing the result of the GetExecutionHistory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ExecutionDoesNotExistException The specified execution does not exist.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • InvalidTokenException The provided token is not valid.
      • KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
      • KmsInvalidStateException The KMS key is not in valid state, for example: Disabled or Deleted.
      • KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getExecutionHistory

      default CompletableFuture<GetExecutionHistoryResponse> getExecutionHistory(Consumer<GetExecutionHistoryRequest.Builder> getExecutionHistoryRequest)

      Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use 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:
      A Java Future containing the result of the GetExecutionHistory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ExecutionDoesNotExistException The specified execution does not exist.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • InvalidTokenException The provided token is not valid.
      • KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
      • KmsInvalidStateException The KMS key is not in valid state, for example: Disabled or Deleted.
      • KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getExecutionHistoryPaginator

      default GetExecutionHistoryPublisher getExecutionHistoryPaginator(GetExecutionHistoryRequest getExecutionHistoryRequest)

      This is a variant of getExecutionHistory(software.amazon.awssdk.services.sfn.model.GetExecutionHistoryRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sfn.paginators.GetExecutionHistoryPublisher publisher = client.getExecutionHistoryPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sfn.paginators.GetExecutionHistoryPublisher publisher = client.getExecutionHistoryPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sfn.model.GetExecutionHistoryResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sfn.model.GetExecutionHistoryResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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

      Parameters:
      getExecutionHistoryRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ExecutionDoesNotExistException The specified execution does not exist.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • InvalidTokenException The provided token is not valid.
      • KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
      • KmsInvalidStateException The KMS key is not in valid state, for example: Disabled or Deleted.
      • KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getExecutionHistoryPaginator

      default GetExecutionHistoryPublisher getExecutionHistoryPaginator(Consumer<GetExecutionHistoryRequest.Builder> getExecutionHistoryRequest)

      This is a variant of getExecutionHistory(software.amazon.awssdk.services.sfn.model.GetExecutionHistoryRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sfn.paginators.GetExecutionHistoryPublisher publisher = client.getExecutionHistoryPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sfn.paginators.GetExecutionHistoryPublisher publisher = client.getExecutionHistoryPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sfn.model.GetExecutionHistoryResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sfn.model.GetExecutionHistoryResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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


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

      Parameters:
      getExecutionHistoryRequest - A Consumer that will call methods on GetExecutionHistoryRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ExecutionDoesNotExistException The specified execution does not exist.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • InvalidTokenException The provided token is not valid.
      • KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
      • KmsInvalidStateException The KMS key is not in valid state, for example: Disabled or Deleted.
      • KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listActivities

      default CompletableFuture<ListActivitiesResponse> listActivities(ListActivitiesRequest listActivitiesRequest)

      Lists the existing activities.

      If nextToken is returned, there are more results available. The value 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:
      A Java Future containing the result of the ListActivities operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidTokenException The provided token is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listActivities

      default CompletableFuture<ListActivitiesResponse> listActivities(Consumer<ListActivitiesRequest.Builder> listActivitiesRequest)

      Lists the existing activities.

      If nextToken is returned, there are more results available. The value 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:
      A Java Future containing the result of the ListActivities operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidTokenException The provided token is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listActivities

      default CompletableFuture<ListActivitiesResponse> listActivities()

      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:
      A Java Future containing the result of the ListActivities operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidTokenException The provided token is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listActivitiesPaginator

      default ListActivitiesPublisher listActivitiesPaginator()

      This is a variant of listActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sfn.paginators.ListActivitiesPublisher publisher = client.listActivitiesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sfn.paginators.ListActivitiesPublisher publisher = client.listActivitiesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sfn.model.ListActivitiesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sfn.model.ListActivitiesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidTokenException The provided token is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listActivitiesPaginator

      default ListActivitiesPublisher listActivitiesPaginator(ListActivitiesRequest listActivitiesRequest)

      This is a variant of listActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sfn.paginators.ListActivitiesPublisher publisher = client.listActivitiesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sfn.paginators.ListActivitiesPublisher publisher = client.listActivitiesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sfn.model.ListActivitiesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sfn.model.ListActivitiesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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

      Parameters:
      listActivitiesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidTokenException The provided token is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listActivitiesPaginator

      default ListActivitiesPublisher listActivitiesPaginator(Consumer<ListActivitiesRequest.Builder> listActivitiesRequest)

      This is a variant of listActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sfn.paginators.ListActivitiesPublisher publisher = client.listActivitiesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sfn.paginators.ListActivitiesPublisher publisher = client.listActivitiesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sfn.model.ListActivitiesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sfn.model.ListActivitiesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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


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

      Parameters:
      listActivitiesRequest - A Consumer that will call methods on ListActivitiesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidTokenException The provided token is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExecutions

      default CompletableFuture<ListExecutionsResponse> listExecutions(ListExecutionsRequest listExecutionsRequest)

      Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN. Using this API action, you can also list all redriven executions.

      You can also provide a state machine alias ARN or version ARN to list the executions associated with a specific alias or version.

      Results are sorted by time, with the most recent execution first.

      If nextToken is returned, there are more results available. The value 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:
      A Java Future containing the result of the ListExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • InvalidTokenException The provided token is not valid.
      • StateMachineDoesNotExistException The specified state machine does not exist.
      • StateMachineTypeNotSupportedException State machine type is not supported.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException Could not find the referenced resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExecutions

      default CompletableFuture<ListExecutionsResponse> listExecutions(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)

      Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN. Using this API action, you can also list all redriven executions.

      You can also provide a state machine alias ARN or version ARN to list the executions associated with a specific alias or version.

      Results are sorted by time, with the most recent execution first.

      If nextToken is returned, there are more results available. The value 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:
      A Java Future containing the result of the ListExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • InvalidTokenException The provided token is not valid.
      • StateMachineDoesNotExistException The specified state machine does not exist.
      • StateMachineTypeNotSupportedException State machine type is not supported.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException Could not find the referenced resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExecutionsPaginator

      default ListExecutionsPublisher listExecutionsPaginator(ListExecutionsRequest listExecutionsRequest)

      This is a variant of listExecutions(software.amazon.awssdk.services.sfn.model.ListExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sfn.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sfn.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sfn.model.ListExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sfn.model.ListExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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

      Parameters:
      listExecutionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • InvalidTokenException The provided token is not valid.
      • StateMachineDoesNotExistException The specified state machine does not exist.
      • StateMachineTypeNotSupportedException State machine type is not supported.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException Could not find the referenced resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExecutionsPaginator

      default ListExecutionsPublisher listExecutionsPaginator(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)

      This is a variant of listExecutions(software.amazon.awssdk.services.sfn.model.ListExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sfn.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sfn.paginators.ListExecutionsPublisher publisher = client.listExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sfn.model.ListExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sfn.model.ListExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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


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

      Parameters:
      listExecutionsRequest - A Consumer that will call methods on ListExecutionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • InvalidTokenException The provided token is not valid.
      • StateMachineDoesNotExistException The specified state machine does not exist.
      • StateMachineTypeNotSupportedException State machine type is not supported.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • ResourceNotFoundException Could not find the referenced resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMapRuns

      default CompletableFuture<ListMapRunsResponse> listMapRuns(ListMapRunsRequest listMapRunsRequest)

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

      Parameters:
      listMapRunsRequest -
      Returns:
      A Java Future containing the result of the ListMapRuns operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ExecutionDoesNotExistException The specified execution does not exist.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • InvalidTokenException The provided token is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMapRuns

      default CompletableFuture<ListMapRunsResponse> listMapRuns(Consumer<ListMapRunsRequest.Builder> listMapRunsRequest)

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


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

      Parameters:
      listMapRunsRequest - A Consumer that will call methods on ListMapRunsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListMapRuns operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ExecutionDoesNotExistException The specified execution does not exist.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • InvalidTokenException The provided token is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMapRunsPaginator

      default ListMapRunsPublisher listMapRunsPaginator(ListMapRunsRequest listMapRunsRequest)

      This is a variant of listMapRuns(software.amazon.awssdk.services.sfn.model.ListMapRunsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sfn.paginators.ListMapRunsPublisher publisher = client.listMapRunsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sfn.paginators.ListMapRunsPublisher publisher = client.listMapRunsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sfn.model.ListMapRunsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sfn.model.ListMapRunsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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

      Parameters:
      listMapRunsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ExecutionDoesNotExistException The specified execution does not exist.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • InvalidTokenException The provided token is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMapRunsPaginator

      default ListMapRunsPublisher listMapRunsPaginator(Consumer<ListMapRunsRequest.Builder> listMapRunsRequest)

      This is a variant of listMapRuns(software.amazon.awssdk.services.sfn.model.ListMapRunsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sfn.paginators.ListMapRunsPublisher publisher = client.listMapRunsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sfn.paginators.ListMapRunsPublisher publisher = client.listMapRunsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sfn.model.ListMapRunsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sfn.model.ListMapRunsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

      Note: If you prefer to have control on service calls, use the 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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ExecutionDoesNotExistException The specified execution does not exist.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • InvalidTokenException The provided token is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStateMachineAliases

      default CompletableFuture<ListStateMachineAliasesResponse> listStateMachineAliases(ListStateMachineAliasesRequest listStateMachineAliasesRequest)

      Lists aliases for a specified state machine ARN. Results are sorted by time, with the most recently created aliases listed first.

      To list aliases that reference a state machine version, you can specify the version ARN in the stateMachineArn parameter.

      If nextToken is returned, there are more results available. The value 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:
      A Java Future containing the result of the ListStateMachineAliases operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • InvalidTokenException The provided token is not valid.
      • ResourceNotFoundException Could not find the referenced resource.
      • StateMachineDoesNotExistException The specified state machine does not exist.
      • StateMachineDeletingException The specified state machine is being deleted.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStateMachineAliases

      default CompletableFuture<ListStateMachineAliasesResponse> listStateMachineAliases(Consumer<ListStateMachineAliasesRequest.Builder> listStateMachineAliasesRequest)

      Lists aliases for a specified state machine ARN. Results are sorted by time, with the most recently created aliases listed first.

      To list aliases that reference a state machine version, you can specify the version ARN in the stateMachineArn parameter.

      If nextToken is returned, there are more results available. The value 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:
      A Java Future containing the result of the ListStateMachineAliases operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • InvalidTokenException The provided token is not valid.
      • ResourceNotFoundException Could not find the referenced resource.
      • StateMachineDoesNotExistException The specified state machine does not exist.
      • StateMachineDeletingException The specified state machine is being deleted.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStateMachineVersions

      default CompletableFuture<ListStateMachineVersionsResponse> listStateMachineVersions(ListStateMachineVersionsRequest listStateMachineVersionsRequest)

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

      The results are sorted in descending order of the version creation time.

      If nextToken is returned, there are more results available. The value 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:
      A Java Future containing the result of the ListStateMachineVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • InvalidTokenException The provided token is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStateMachineVersions

      default CompletableFuture<ListStateMachineVersionsResponse> listStateMachineVersions(Consumer<ListStateMachineVersionsRequest.Builder> listStateMachineVersionsRequest)

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

      The results are sorted in descending order of the version creation time.

      If nextToken is returned, there are more results available. The value 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:
      A Java Future containing the result of the ListStateMachineVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • InvalidTokenException The provided token is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStateMachines

      default CompletableFuture<ListStateMachinesResponse> listStateMachines(ListStateMachinesRequest listStateMachinesRequest)

      Lists the existing state machines.

      If nextToken is returned, there are more results available. The value 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:
      A Java Future containing the result of the ListStateMachines operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidTokenException The provided token is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStateMachines

      default CompletableFuture<ListStateMachinesResponse> listStateMachines(Consumer<ListStateMachinesRequest.Builder> listStateMachinesRequest)

      Lists the existing state machines.

      If nextToken is returned, there are more results available. The value 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:
      A Java Future containing the result of the ListStateMachines operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidTokenException The provided token is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStateMachines

      default CompletableFuture<ListStateMachinesResponse> listStateMachines()

      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:
      A Java Future containing the result of the ListStateMachines operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidTokenException The provided token is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStateMachinesPaginator

      default ListStateMachinesPublisher listStateMachinesPaginator()

      This is a variant of listStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sfn.paginators.ListStateMachinesPublisher publisher = client.listStateMachinesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sfn.paginators.ListStateMachinesPublisher publisher = client.listStateMachinesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sfn.model.ListStateMachinesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sfn.model.ListStateMachinesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidTokenException The provided token is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStateMachinesPaginator

      default ListStateMachinesPublisher listStateMachinesPaginator(ListStateMachinesRequest listStateMachinesRequest)

      This is a variant of listStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sfn.paginators.ListStateMachinesPublisher publisher = client.listStateMachinesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sfn.paginators.ListStateMachinesPublisher publisher = client.listStateMachinesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sfn.model.ListStateMachinesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sfn.model.ListStateMachinesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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

      Parameters:
      listStateMachinesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidTokenException The provided token is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStateMachinesPaginator

      default ListStateMachinesPublisher listStateMachinesPaginator(Consumer<ListStateMachinesRequest.Builder> listStateMachinesRequest)

      This is a variant of listStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sfn.paginators.ListStateMachinesPublisher publisher = client.listStateMachinesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sfn.paginators.ListStateMachinesPublisher publisher = client.listStateMachinesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sfn.model.ListStateMachinesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sfn.model.ListStateMachinesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

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

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


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

      Parameters:
      listStateMachinesRequest - A Consumer that will call methods on ListStateMachinesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidTokenException The provided token is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      List tags for a given resource.

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

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • ResourceNotFoundException Could not find the referenced resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      List tags for a given resource.

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


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

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • ResourceNotFoundException Could not find the referenced resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • publishStateMachineVersion

      default CompletableFuture<PublishStateMachineVersionResponse> publishStateMachineVersion(PublishStateMachineVersionRequest publishStateMachineVersionRequest)

      Creates a version from the current revision of a state machine. Use versions to create immutable snapshots of your state machine. You can start executions from versions either directly or with an alias. To create an alias, use CreateStateMachineAlias.

      You can publish up to 1000 versions for each state machine. You must manually delete unused versions using the DeleteStateMachineVersion API action.

      PublishStateMachineVersion is an idempotent API. It doesn't create a duplicate state machine version if it already exists for the current revision. Step Functions 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:
      A Java Future containing the result of the PublishStateMachineVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • StateMachineDeletingException The specified state machine is being deleted.
      • StateMachineDoesNotExistException The specified state machine does not exist.
      • ServiceQuotaExceededException The request would cause a service quota to be exceeded.

        HTTP Status Code: 402

      • ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

        HTTP Status Code: 409

      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • publishStateMachineVersion

      default CompletableFuture<PublishStateMachineVersionResponse> publishStateMachineVersion(Consumer<PublishStateMachineVersionRequest.Builder> publishStateMachineVersionRequest)

      Creates a version from the current revision of a state machine. Use versions to create immutable snapshots of your state machine. You can start executions from versions either directly or with an alias. To create an alias, use CreateStateMachineAlias.

      You can publish up to 1000 versions for each state machine. You must manually delete unused versions using the DeleteStateMachineVersion API action.

      PublishStateMachineVersion is an idempotent API. It doesn't create a duplicate state machine version if it already exists for the current revision. Step Functions 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:
      A Java Future containing the result of the PublishStateMachineVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • StateMachineDeletingException The specified state machine is being deleted.
      • StateMachineDoesNotExistException The specified state machine does not exist.
      • ServiceQuotaExceededException The request would cause a service quota to be exceeded.

        HTTP Status Code: 402

      • ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

        HTTP Status Code: 409

      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • redriveExecution

      default CompletableFuture<RedriveExecutionResponse> redriveExecution(RedriveExecutionRequest redriveExecutionRequest)

      Restarts unsuccessful executions of Standard workflows that didn't complete successfully in the last 14 days. These include failed, aborted, or timed out executions. When you redrive an execution, it continues the failed execution from the unsuccessful step and uses the same input. Step Functions preserves the results and execution history of the successful steps, and doesn't rerun these steps when you redrive an execution. Redriven executions use the same state machine definition and execution ARN as the original execution attempt.

      For workflows that include an Inline Map or Parallel state, RedriveExecution API action reschedules and redrives only the iterations and branches that failed or aborted.

      To redrive a workflow that includes a Distributed Map state whose Map Run failed, you must redrive the parent workflow. The parent workflow redrives all the unsuccessful states, including a failed Map Run. If a Map Run was not started in the original execution attempt, the redriven parent workflow starts the Map Run.

      This API action is not supported by EXPRESS state machines.

      However, you can restart the unsuccessful executions of Express child workflows in a Distributed Map by redriving its Map Run. When you redrive a Map Run, the Express child workflows are rerun using the StartExecution API action. For more information, see Redriving Map Runs.

      You can redrive executions if your original execution meets the following conditions:

      • The execution status isn't SUCCEEDED.

      • Your workflow execution has not exceeded the redrivable period of 14 days. Redrivable period refers to the time during which you can redrive a given execution. This period starts from the day a state machine completes its execution.

      • The workflow execution has not exceeded the maximum open time of one year. For more information about state machine quotas, see Quotas related to state machine executions.

      • The execution event history count is less than 24,999. Redriven executions append their event history to the existing event history. Make sure your workflow execution contains less than 24,999 events to accommodate the ExecutionRedriven history event and at least one other history event.

      Parameters:
      redriveExecutionRequest -
      Returns:
      A Java Future containing the result of the RedriveExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ExecutionDoesNotExistException The specified execution does not exist.
      • ExecutionNotRedrivableException The execution Amazon Resource Name (ARN) that you specified for executionArn cannot be redriven.
      • ExecutionLimitExceededException The maximum number of running executions has been reached. Running executions must end or be stopped before a new execution can be started.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • redriveExecution

      default CompletableFuture<RedriveExecutionResponse> redriveExecution(Consumer<RedriveExecutionRequest.Builder> redriveExecutionRequest)

      Restarts unsuccessful executions of Standard workflows that didn't complete successfully in the last 14 days. These include failed, aborted, or timed out executions. When you redrive an execution, it continues the failed execution from the unsuccessful step and uses the same input. Step Functions preserves the results and execution history of the successful steps, and doesn't rerun these steps when you redrive an execution. Redriven executions use the same state machine definition and execution ARN as the original execution attempt.

      For workflows that include an Inline Map or Parallel state, RedriveExecution API action reschedules and redrives only the iterations and branches that failed or aborted.

      To redrive a workflow that includes a Distributed Map state whose Map Run failed, you must redrive the parent workflow. The parent workflow redrives all the unsuccessful states, including a failed Map Run. If a Map Run was not started in the original execution attempt, the redriven parent workflow starts the Map Run.

      This API action is not supported by EXPRESS state machines.

      However, you can restart the unsuccessful executions of Express child workflows in a Distributed Map by redriving its Map Run. When you redrive a Map Run, the Express child workflows are rerun using the StartExecution API action. For more information, see Redriving Map Runs.

      You can redrive executions if your original execution meets the following conditions:

      • The execution status isn't SUCCEEDED.

      • Your workflow execution has not exceeded the redrivable period of 14 days. Redrivable period refers to the time during which you can redrive a given execution. This period starts from the day a state machine completes its execution.

      • The workflow execution has not exceeded the maximum open time of one year. For more information about state machine quotas, see Quotas related to state machine executions.

      • The execution event history count is less than 24,999. Redriven executions append their event history to the existing event history. Make sure your workflow execution contains less than 24,999 events to accommodate the ExecutionRedriven history event and at least one other history event.


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

      Parameters:
      redriveExecutionRequest - A Consumer that will call methods on RedriveExecutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RedriveExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ExecutionDoesNotExistException The specified execution does not exist.
      • ExecutionNotRedrivableException The execution Amazon Resource Name (ARN) that you specified for executionArn cannot be redriven.
      • ExecutionLimitExceededException The maximum number of running executions has been reached. Running executions must end or be stopped before a new execution can be started.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendTaskFailure

      default CompletableFuture<SendTaskFailureResponse> sendTaskFailure(SendTaskFailureRequest sendTaskFailureRequest)

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

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

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

      Parameters:
      sendTaskFailureRequest -
      Returns:
      A Java Future containing the result of the SendTaskFailure operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TaskDoesNotExistException The activity does not exist.
      • InvalidTokenException The provided token is not valid.
      • TaskTimedOutException The task token has either expired or the task associated with the token has already been closed.
      • KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
      • KmsInvalidStateException The KMS key is not in valid state, for example: Disabled or Deleted.
      • KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendTaskFailure

      default CompletableFuture<SendTaskFailureResponse> sendTaskFailure(Consumer<SendTaskFailureRequest.Builder> sendTaskFailureRequest)

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

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

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


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

      Parameters:
      sendTaskFailureRequest - A Consumer that will call methods on SendTaskFailureRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SendTaskFailure operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TaskDoesNotExistException The activity does not exist.
      • InvalidTokenException The provided token is not valid.
      • TaskTimedOutException The task token has either expired or the task associated with the token has already been closed.
      • KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
      • KmsInvalidStateException The KMS key is not in valid state, for example: Disabled or Deleted.
      • KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendTaskHeartbeat

      default CompletableFuture<SendTaskHeartbeatResponse> sendTaskHeartbeat(SendTaskHeartbeatRequest sendTaskHeartbeatRequest)

      Used by activity workers and Task states using the callback pattern, and optionally Task states using the job run pattern to report to Step Functions that the task represented by the specified taskToken is still making progress. This action resets 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:
      A Java Future containing the result of the SendTaskHeartbeat operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TaskDoesNotExistException The activity does not exist.
      • InvalidTokenException The provided token is not valid.
      • TaskTimedOutException The task token has either expired or the task associated with the token has already been closed.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendTaskHeartbeat

      default CompletableFuture<SendTaskHeartbeatResponse> sendTaskHeartbeat(Consumer<SendTaskHeartbeatRequest.Builder> sendTaskHeartbeatRequest)

      Used by activity workers and Task states using the callback pattern, and optionally Task states using the job run pattern to report to Step Functions that the task represented by the specified taskToken is still making progress. This action resets 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:
      A Java Future containing the result of the SendTaskHeartbeat operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TaskDoesNotExistException The activity does not exist.
      • InvalidTokenException The provided token is not valid.
      • TaskTimedOutException The task token has either expired or the task associated with the token has already been closed.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendTaskSuccess

      default CompletableFuture<SendTaskSuccessResponse> sendTaskSuccess(SendTaskSuccessRequest sendTaskSuccessRequest)

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

      Parameters:
      sendTaskSuccessRequest -
      Returns:
      A Java Future containing the result of the SendTaskSuccess operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TaskDoesNotExistException The activity does not exist.
      • InvalidOutputException The provided JSON output data is not valid.
      • InvalidTokenException The provided token is not valid.
      • TaskTimedOutException The task token has either expired or the task associated with the token has already been closed.
      • KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
      • KmsInvalidStateException The KMS key is not in valid state, for example: Disabled or Deleted.
      • KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendTaskSuccess

      default CompletableFuture<SendTaskSuccessResponse> sendTaskSuccess(Consumer<SendTaskSuccessRequest.Builder> sendTaskSuccessRequest)

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


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

      Parameters:
      sendTaskSuccessRequest - A Consumer that will call methods on SendTaskSuccessRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SendTaskSuccess operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TaskDoesNotExistException The activity does not exist.
      • InvalidOutputException The provided JSON output data is not valid.
      • InvalidTokenException The provided token is not valid.
      • TaskTimedOutException The task token has either expired or the task associated with the token has already been closed.
      • KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
      • KmsInvalidStateException The KMS key is not in valid state, for example: Disabled or Deleted.
      • KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startExecution

      default CompletableFuture<StartExecutionResponse> startExecution(StartExecutionRequest startExecutionRequest)

      Starts a state machine execution.

      A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

      The following are some examples of qualified and unqualified state machine ARNs:

      • The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine 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:
      A Java Future containing the result of the StartExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ExecutionLimitExceededException The maximum number of running executions has been reached. Running executions must end or be stopped before a new execution can be started.
      • ExecutionAlreadyExistsException The execution has the same name as another execution (but a different input).

        Executions with the same name and input are considered idempotent.

      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • InvalidExecutionInputException The provided JSON input data is not valid.
      • InvalidNameException The provided name is not valid.
      • StateMachineDoesNotExistException The specified state machine does not exist.
      • StateMachineDeletingException The specified state machine is being deleted.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
      • KmsInvalidStateException The KMS key is not in valid state, for example: Disabled or Deleted.
      • KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startExecution

      default CompletableFuture<StartExecutionResponse> startExecution(Consumer<StartExecutionRequest.Builder> startExecutionRequest)

      Starts a state machine execution.

      A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

      The following are some examples of qualified and unqualified state machine ARNs:

      • The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine 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:
      A Java Future containing the result of the StartExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ExecutionLimitExceededException The maximum number of running executions has been reached. Running executions must end or be stopped before a new execution can be started.
      • ExecutionAlreadyExistsException The execution has the same name as another execution (but a different input).

        Executions with the same name and input are considered idempotent.

      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • InvalidExecutionInputException The provided JSON input data is not valid.
      • InvalidNameException The provided name is not valid.
      • StateMachineDoesNotExistException The specified state machine does not exist.
      • StateMachineDeletingException The specified state machine is being deleted.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
      • KmsInvalidStateException The KMS key is not in valid state, for example: Disabled or Deleted.
      • KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startSyncExecution

      default CompletableFuture<StartSyncExecutionResponse> startSyncExecution(StartSyncExecutionRequest startSyncExecutionRequest)

      Starts a Synchronous Express state machine execution. StartSyncExecution is not available 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:
      A Java Future containing the result of the StartSyncExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • InvalidExecutionInputException The provided JSON input data is not valid.
      • InvalidNameException The provided name is not valid.
      • StateMachineDoesNotExistException The specified state machine does not exist.
      • StateMachineDeletingException The specified state machine is being deleted.
      • StateMachineTypeNotSupportedException State machine type is not supported.
      • KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
      • KmsInvalidStateException The KMS key is not in valid state, for example: Disabled or Deleted.
      • KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startSyncExecution

      default CompletableFuture<StartSyncExecutionResponse> startSyncExecution(Consumer<StartSyncExecutionRequest.Builder> startSyncExecutionRequest)

      Starts a Synchronous Express state machine execution. StartSyncExecution is not available 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:
      A Java Future containing the result of the StartSyncExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • InvalidExecutionInputException The provided JSON input data is not valid.
      • InvalidNameException The provided name is not valid.
      • StateMachineDoesNotExistException The specified state machine does not exist.
      • StateMachineDeletingException The specified state machine is being deleted.
      • StateMachineTypeNotSupportedException State machine type is not supported.
      • KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
      • KmsInvalidStateException The KMS key is not in valid state, for example: Disabled or Deleted.
      • KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopExecution

      default CompletableFuture<StopExecutionResponse> stopExecution(StopExecutionRequest stopExecutionRequest)

      Stops an execution.

      This API action is not supported by EXPRESS state machines.

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

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

      Parameters:
      stopExecutionRequest -
      Returns:
      A Java Future containing the result of the StopExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ExecutionDoesNotExistException The specified execution does not exist.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
      • KmsInvalidStateException The KMS key is not in valid state, for example: Disabled or Deleted.
      • KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopExecution

      default CompletableFuture<StopExecutionResponse> stopExecution(Consumer<StopExecutionRequest.Builder> stopExecutionRequest)

      Stops an execution.

      This API action is not supported by EXPRESS state machines.

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

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


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

      Parameters:
      stopExecutionRequest - A Consumer that will call methods on StopExecutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ExecutionDoesNotExistException The specified execution does not exist.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
      • KmsInvalidStateException The KMS key is not in valid state, for example: Disabled or Deleted.
      • KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Add a tag to a Step Functions resource.

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

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

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • ResourceNotFoundException Could not find the referenced resource.
      • TooManyTagsException You've exceeded the number of tags allowed for a resource. See the Limits Topic in the Step Functions Developer Guide.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      Add a tag to a Step Functions resource.

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

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


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

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • ResourceNotFoundException Could not find the referenced resource.
      • TooManyTagsException You've exceeded the number of tags allowed for a resource. See the Limits Topic in the Step Functions Developer Guide.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • testState

      default CompletableFuture<TestStateResponse> testState(TestStateRequest testStateRequest)

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

      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:
      A Java Future containing the result of the TestState operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • InvalidDefinitionException The provided Amazon States Language definition is not valid.
      • InvalidExecutionInputException The provided JSON input data is not valid.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • testState

      default CompletableFuture<TestStateResponse> testState(Consumer<TestStateRequest.Builder> testStateRequest)

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

      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:
      A Java Future containing the result of the TestState operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • InvalidDefinitionException The provided Amazon States Language definition is not valid.
      • InvalidExecutionInputException The provided JSON input data is not valid.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Remove a tag from a Step Functions resource

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • ResourceNotFoundException Could not find the referenced resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Remove a tag from a Step Functions resource


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

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • ResourceNotFoundException Could not find the referenced resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateMapRun

      default CompletableFuture<UpdateMapRunResponse> updateMapRun(UpdateMapRunRequest updateMapRunRequest)

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

      Parameters:
      updateMapRunRequest -
      Returns:
      A Java Future containing the result of the UpdateMapRun operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException Could not find the referenced resource.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateMapRun

      default CompletableFuture<UpdateMapRunResponse> updateMapRun(Consumer<UpdateMapRunRequest.Builder> updateMapRunRequest)

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


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

      Parameters:
      updateMapRunRequest - A Consumer that will call methods on UpdateMapRunRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateMapRun operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException Could not find the referenced resource.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateStateMachine

      default CompletableFuture<UpdateStateMachineResponse> updateStateMachine(UpdateStateMachineRequest updateStateMachineRequest)

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

      A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.

      A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

      The following are some examples of qualified and unqualified state machine ARNs:

      • The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine.

        arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel

        If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException.

      • The following qualified state machine ARN refers to an alias named PROD.

        arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>

        If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.

      • The following unqualified state machine ARN refers to a state machine named myStateMachine.

        arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>

      After you update your state machine, you can set the publish parameter to true in the same action to publish a new version. This way, you can opt-in to strict versioning of your state machine.

      Step Functions assigns monotonically increasing integers for state machine versions, starting at version number 1.

      All StartExecution calls within a few seconds use the updated definition and roleArn. Executions started immediately after you call UpdateStateMachine may use the previous state machine definition and roleArn.

      Parameters:
      updateStateMachineRequest -
      Returns:
      A Java Future containing the result of the UpdateStateMachine operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • InvalidDefinitionException The provided Amazon States Language definition is not valid.
      • InvalidLoggingConfigurationException Configuration is not valid.
      • InvalidTracingConfigurationException Your tracingConfiguration key does not match, or enabled has not been set to true or false.
      • MissingRequiredParameterException Request is missing a required parameter. This error occurs if both definition and roleArn are not specified.
      • StateMachineDeletingException The specified state machine is being deleted.
      • StateMachineDoesNotExistException The specified state machine does not exist.
      • ServiceQuotaExceededException The request would cause a service quota to be exceeded.

        HTTP Status Code: 402

      • ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

        HTTP Status Code: 409

      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InvalidEncryptionConfigurationException Received when encryptionConfiguration is specified but various conditions exist which make the configuration invalid. For example, if type is set to CUSTOMER_MANAGED_KMS_KEY, but kmsKeyId is null, or kmsDataKeyReusePeriodSeconds is not between 60 and 900, or the KMS key is not symmetric or inactive.
      • KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
      • KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateStateMachine

      default CompletableFuture<UpdateStateMachineResponse> updateStateMachine(Consumer<UpdateStateMachineRequest.Builder> updateStateMachineRequest)

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

      A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.

      A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

      The following are some examples of qualified and unqualified state machine ARNs:

      • The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine.

        arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel

        If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException.

      • The following qualified state machine ARN refers to an alias named PROD.

        arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>

        If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.

      • The following unqualified state machine ARN refers to a state machine named myStateMachine.

        arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>

      After you update your state machine, you can set the publish parameter to true in the same action to publish a new version. This way, you can opt-in to strict versioning of your state machine.

      Step Functions assigns monotonically increasing integers for state machine versions, starting at version number 1.

      All StartExecution calls within a few seconds use the updated definition and roleArn. Executions started immediately after you call UpdateStateMachine may use the previous state machine definition and roleArn.


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

      Parameters:
      updateStateMachineRequest - A Consumer that will call methods on UpdateStateMachineRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateStateMachine operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • InvalidDefinitionException The provided Amazon States Language definition is not valid.
      • InvalidLoggingConfigurationException Configuration is not valid.
      • InvalidTracingConfigurationException Your tracingConfiguration key does not match, or enabled has not been set to true or false.
      • MissingRequiredParameterException Request is missing a required parameter. This error occurs if both definition and roleArn are not specified.
      • StateMachineDeletingException The specified state machine is being deleted.
      • StateMachineDoesNotExistException The specified state machine does not exist.
      • ServiceQuotaExceededException The request would cause a service quota to be exceeded.

        HTTP Status Code: 402

      • ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

        HTTP Status Code: 409

      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InvalidEncryptionConfigurationException Received when encryptionConfiguration is specified but various conditions exist which make the configuration invalid. For example, if type is set to CUSTOMER_MANAGED_KMS_KEY, but kmsKeyId is null, or kmsDataKeyReusePeriodSeconds is not between 60 and 900, or the KMS key is not symmetric or inactive.
      • KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
      • KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateStateMachineAlias

      default CompletableFuture<UpdateStateMachineAliasResponse> updateStateMachineAlias(UpdateStateMachineAliasRequest updateStateMachineAliasRequest)

      Updates the configuration of an existing state machine alias by modifying its description 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:
      A Java Future containing the result of the UpdateStateMachineAlias operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • ResourceNotFoundException Could not find the referenced resource.
      • ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

        HTTP Status Code: 409

      • StateMachineDeletingException The specified state machine is being deleted.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateStateMachineAlias

      default CompletableFuture<UpdateStateMachineAliasResponse> updateStateMachineAlias(Consumer<UpdateStateMachineAliasRequest.Builder> updateStateMachineAliasRequest)

      Updates the configuration of an existing state machine alias by modifying its description 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:
      A Java Future containing the result of the UpdateStateMachineAlias operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
      • ResourceNotFoundException Could not find the referenced resource.
      • ConflictException Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.

        HTTP Status Code: 409

      • StateMachineDeletingException The specified state machine is being deleted.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • validateStateMachineDefinition

      default CompletableFuture<ValidateStateMachineDefinitionResponse> validateStateMachineDefinition(ValidateStateMachineDefinitionRequest validateStateMachineDefinitionRequest)

      Validates the syntax of a state machine definition specified in Amazon States Language (ASL), a JSON-based, structured language.

      You can validate that a state machine definition is correct without creating a state machine resource.

      Suggested uses for ValidateStateMachineDefinition:

      • Integrate automated checks into your code review or Continuous Integration (CI) process to check state machine definitions before starting deployments.

      • Run validation from a Git pre-commit hook to verify the definition before committing to your source repository.

      Validation will look for problems in your state machine definition and return a result and a list of diagnostic elements.

      The result value will be OK when your workflow definition can be successfully created or updated. Note the result can be OK even when diagnostic warnings are present in the response. The result value will be FAIL when the workflow definition contains errors that would prevent you from creating or updating your state machine.

      The list of ValidateStateMachineDefinitionDiagnostic data elements can contain zero or more WARNING and/or ERROR elements.

      The ValidateStateMachineDefinition API might add new diagnostics in the future, adjust diagnostic codes, or change the message wording. Your automated processes should only rely on the value of the result field value (OK, FAIL). Do not rely on the exact order, count, or wording of diagnostic messages.

      Parameters:
      validateStateMachineDefinitionRequest -
      Returns:
      A Java Future containing the result of the ValidateStateMachineDefinition operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • validateStateMachineDefinition

      default CompletableFuture<ValidateStateMachineDefinitionResponse> validateStateMachineDefinition(Consumer<ValidateStateMachineDefinitionRequest.Builder> validateStateMachineDefinitionRequest)

      Validates the syntax of a state machine definition specified in Amazon States Language (ASL), a JSON-based, structured language.

      You can validate that a state machine definition is correct without creating a state machine resource.

      Suggested uses for ValidateStateMachineDefinition:

      • Integrate automated checks into your code review or Continuous Integration (CI) process to check state machine definitions before starting deployments.

      • Run validation from a Git pre-commit hook to verify the definition before committing to your source repository.

      Validation will look for problems in your state machine definition and return a result and a list of diagnostic elements.

      The result value will be OK when your workflow definition can be successfully created or updated. Note the result can be OK even when diagnostic warnings are present in the response. The result value will be FAIL when the workflow definition contains errors that would prevent you from creating or updating your state machine.

      The list of ValidateStateMachineDefinitionDiagnostic data elements can contain zero or more WARNING and/or ERROR elements.

      The ValidateStateMachineDefinition API might add new diagnostics in the future, adjust diagnostic codes, or change the message wording. Your automated processes should only rely on the value of the result field value (OK, FAIL). Do not rely on the exact order, count, or wording of diagnostic messages.


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

      Parameters:
      validateStateMachineDefinitionRequest - A Consumer that will call methods on ValidateStateMachineDefinitionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ValidateStateMachineDefinition operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • SfnException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default SfnServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static SfnAsyncClient create()
      Create a SfnAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static SfnAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a SfnAsyncClient.