AWSStepFunctionsClient (AWS Java SDK for AWS Step Functions 1.12.506 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.stepfunctions.AWSStepFunctionsClient

All Implemented Interfaces:

AWSStepFunctions

Direct Known Subclasses:

AWSStepFunctionsAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSStepFunctionsClient
extends AmazonWebServiceClient
implements AWSStepFunctions
```
Client for accessing AWS SFN. All service calls made using this client are blocking, and will not return until the service call completes.
Step Functions
Step Functions is a service that lets you coordinate the components of distributed applications and microservices using visual workflows.

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

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected static AWSStepFunctionsClientConfigurationFactory`	`configFactory` Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient
client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.stepfunctions.AWSStepFunctions
ENDPOINT_PREFIX

Constructor Summary

Constructors
Constructor and Description
`AWSStepFunctionsClient()` Deprecated. use `AWSStepFunctionsClientBuilder.defaultClient()`
`AWSStepFunctionsClient(AWSCredentials awsCredentials)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` for example: `AWSStepFunctionsClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();`
`AWSStepFunctionsClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`
`AWSStepFunctionsClient(AWSCredentialsProvider awsCredentialsProvider)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)`
`AWSStepFunctionsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`
`AWSStepFunctionsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)` and `AwsClientBuilder.withMetricsCollector(RequestMetricCollector)`
`AWSStepFunctionsClient(ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AWSStepFunctionsClientBuilder`	`builder()`
`CreateActivityResult`	`createActivity(CreateActivityRequest request)` Creates an activity.
`CreateStateMachineResult`	`createStateMachine(CreateStateMachineRequest request)` Creates a state machine.
`CreateStateMachineAliasResult`	`createStateMachineAlias(CreateStateMachineAliasRequest request)` Creates an alias for a state machine that points to one or two versions of the same state machine.
`DeleteActivityResult`	`deleteActivity(DeleteActivityRequest request)` Deletes an activity.
`DeleteStateMachineResult`	`deleteStateMachine(DeleteStateMachineRequest request)` Deletes a state machine.
`DeleteStateMachineAliasResult`	`deleteStateMachineAlias(DeleteStateMachineAliasRequest request)` Deletes a state machine alias.
`DeleteStateMachineVersionResult`	`deleteStateMachineVersion(DeleteStateMachineVersionRequest request)` Deletes a state machine version.
`DescribeActivityResult`	`describeActivity(DescribeActivityRequest request)` Describes an activity.
`DescribeExecutionResult`	`describeExecution(DescribeExecutionRequest request)` 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.
`DescribeMapRunResult`	`describeMapRun(DescribeMapRunRequest request)` Provides information about a Map Run's configuration, progress, and results.
`DescribeStateMachineResult`	`describeStateMachine(DescribeStateMachineRequest request)` Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration.
`DescribeStateMachineAliasResult`	`describeStateMachineAlias(DescribeStateMachineAliasRequest request)` Returns details about a state machine alias.
`DescribeStateMachineForExecutionResult`	`describeStateMachineForExecution(DescribeStateMachineForExecutionRequest request)` Provides information about a state machine's definition, its execution role ARN, and configuration.
`GetActivityTaskResult`	`getActivityTask(GetActivityTaskRequest request)` Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`GetExecutionHistoryResult`	`getExecutionHistory(GetExecutionHistoryRequest request)` Returns the history of the specified execution as a list of events.
`ListActivitiesResult`	`listActivities(ListActivitiesRequest request)` Lists the existing activities.
`ListExecutionsResult`	`listExecutions(ListExecutionsRequest request)` Lists all executions of a state machine or a Map Run.
`ListMapRunsResult`	`listMapRuns(ListMapRunsRequest request)` Lists all Map Runs that were started by a given state machine execution.
`ListStateMachineAliasesResult`	`listStateMachineAliases(ListStateMachineAliasesRequest request)` Lists aliases for a specified state machine ARN.
`ListStateMachinesResult`	`listStateMachines(ListStateMachinesRequest request)` Lists the existing state machines.
`ListStateMachineVersionsResult`	`listStateMachineVersions(ListStateMachineVersionsRequest request)` Lists versions for the specified state machine Amazon Resource Name (ARN).
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` List tags for a given resource.
`PublishStateMachineVersionResult`	`publishStateMachineVersion(PublishStateMachineVersionRequest request)` Creates a version from the current revision of a state machine.
`SendTaskFailureResult`	`sendTaskFailure(SendTaskFailureRequest request)` Used by activity workers and task states using the callback pattern to report that the task identified by the `taskToken` failed.
`SendTaskHeartbeatResult`	`sendTaskHeartbeat(SendTaskHeartbeatRequest request)` Used by activity workers and task states using the callback pattern to report to Step Functions that the task represented by the specified `taskToken` is still making progress.
`SendTaskSuccessResult`	`sendTaskSuccess(SendTaskSuccessRequest request)` Used by activity workers and task states using the callback pattern to report that the task identified by the `taskToken` completed successfully.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartExecutionResult`	`startExecution(StartExecutionRequest request)` Starts a state machine execution.
`StartSyncExecutionResult`	`startSyncExecution(StartSyncExecutionRequest request)` Starts a Synchronous Express state machine execution.
`StopExecutionResult`	`stopExecution(StopExecutionRequest request)` Stops an execution.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Add a tag to a Step Functions resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Remove a tag from a Step Functions resource
`UpdateMapRunResult`	`updateMapRun(UpdateMapRunRequest request)` Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure.
`UpdateStateMachineResult`	`updateStateMachine(UpdateStateMachineRequest request)` Updates an existing state machine by modifying its `definition`, `roleArn`, or `loggingConfiguration`.
`UpdateStateMachineAliasResult`	`updateStateMachineAlias(UpdateStateMachineAliasRequest request)` Updates the configuration of an existing state machine alias by modifying its `description` or `routingConfiguration`.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.stepfunctions.AWSStepFunctions
setEndpoint, setRegion

- Field Detail
  - configFactory
```
protected static final AWSStepFunctionsClientConfigurationFactory configFactory
```
    Client configuration factory providing ClientConfigurations tailored to this client
- Constructor Detail
  - AWSStepFunctionsClient
```
@Deprecated
public AWSStepFunctionsClient()
```
    Deprecated. use AWSStepFunctionsClientBuilder.defaultClient()
    Constructs a new client to invoke service methods on AWS SFN. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    See Also:
    
    DefaultAWSCredentialsProviderChain
  - AWSStepFunctionsClient
```
@Deprecated
public AWSStepFunctionsClient(ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    Constructs a new client to invoke service methods on AWS SFN. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    Parameters:
    
    clientConfiguration - The client configuration options controlling how this client connects to AWS SFN (ex: proxy settings, retry counts, etc.).
    
    See Also:
    
    DefaultAWSCredentialsProviderChain
  - AWSStepFunctionsClient
```
@Deprecated
public AWSStepFunctionsClient(AWSCredentials awsCredentials)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSStepFunctionsClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
    
    Constructs a new client to invoke service methods on AWS SFN using the specified AWS account credentials.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
  - AWSStepFunctionsClient
```
@Deprecated
public AWSStepFunctionsClient(AWSCredentials awsCredentials,
                                          ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    
    Constructs a new client to invoke service methods on AWS SFN using the specified AWS account credentials and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to AWS SFN (ex: proxy settings, retry counts, etc.).
  - AWSStepFunctionsClient
```
@Deprecated
public AWSStepFunctionsClient(AWSCredentialsProvider awsCredentialsProvider)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
    
    Constructs a new client to invoke service methods on AWS SFN using the specified AWS account credentials provider.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
  - AWSStepFunctionsClient
```
@Deprecated
public AWSStepFunctionsClient(AWSCredentialsProvider awsCredentialsProvider,
                                          ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    
    Constructs a new client to invoke service methods on AWS SFN using the specified AWS account credentials provider and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to AWS SFN (ex: proxy settings, retry counts, etc.).
  - AWSStepFunctionsClient
```
@Deprecated
public AWSStepFunctionsClient(AWSCredentialsProvider awsCredentialsProvider,
                                          ClientConfiguration clientConfiguration,
                                          RequestMetricCollector requestMetricCollector)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
    
    Constructs a new client to invoke service methods on AWS SFN using the specified AWS account credentials provider, client configuration options, and request metric collector.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to AWS SFN (ex: proxy settings, retry counts, etc.).
    
    requestMetricCollector - optional request metric collector
- Method Detail
  - builder
```
public static AWSStepFunctionsClientBuilder builder()
```
  - createActivity
```
public CreateActivityResult createActivity(CreateActivityRequest request)
```
    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.
    
    Specified by:
    
    createActivity in interface AWSStepFunctions
    
    Parameters:
    
    createActivityRequest -
    
    Returns:
    
    Result of the CreateActivity operation returned by the service.
    
    Throws:
    
    ActivityLimitExceededException - The maximum number of activities has been reached. Existing activities must be deleted before a new activity can be created.
    
    InvalidNameException - The provided name is not valid.
    
    TooManyTagsException - You've exceeded the number of tags allowed for a resource. See the Limits Topic in the Step Functions Developer Guide.
    
    See Also:
    
    AWS API Documentation
  - createStateMachine
```
public CreateStateMachineResult createStateMachine(CreateStateMachineRequest request)
```
    Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. For more information, see Amazon States Language in the Step Functions User Guide.
    
    If you set the publish parameter of this API action to true, it publishes version 1 as the first revision of the state machine.
    
    This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
    
    CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name, definition, type, LoggingConfiguration, and TracingConfiguration. The check is also based on the publish and versionDescription parameters. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.
    
    Specified by:
    
    createStateMachine in interface AWSStepFunctions
    
    Parameters:
    
    createStateMachineRequest -
    
    Returns:
    
    Result of the CreateStateMachine operation returned by the service.
    
    Throws:
    
    InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.
    
    InvalidDefinitionException - The provided Amazon States Language definition is not valid.
    
    InvalidNameException - The provided name is not valid.
    
    InvalidLoggingConfigurationException
    
    InvalidTracingConfigurationException - Your tracingConfiguration key does not match, 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
    
    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
    
    See Also:
    
    AWS API Documentation
  - createStateMachineAlias
```
public CreateStateMachineAliasResult createStateMachineAlias(CreateStateMachineAliasRequest request)
```
    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:
    Specified by:
    
    createStateMachineAlias in interface AWSStepFunctions
    
    Parameters:
    
    createStateMachineAliasRequest -
    
    Returns:
    
    Result of the CreateStateMachineAlias operation returned by the service.
    
    Throws:
    
    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
    
    See Also:
    
    AWS API Documentation
  - deleteActivity
```
public DeleteActivityResult deleteActivity(DeleteActivityRequest request)
```
    Deletes an activity.
    
    Specified by:
    
    deleteActivity in interface AWSStepFunctions
    
    Parameters:
    
    deleteActivityRequest -
    
    Returns:
    
    Result of the DeleteActivity operation returned by the service.
    
    Throws:
    
    InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.
    
    See Also:
    
    AWS API Documentation
  - deleteStateMachine
```
public DeleteStateMachineResult deleteStateMachine(DeleteStateMachineRequest request)
```
    Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process.
    
    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.
    Specified by:
    
    deleteStateMachine in interface AWSStepFunctions
    
    Parameters:
    
    deleteStateMachineRequest -
    
    Returns:
    
    Result of the DeleteStateMachine operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteStateMachineAlias
```
public DeleteStateMachineAliasResult deleteStateMachineAlias(DeleteStateMachineAliasRequest request)
```
    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:
    Specified by:
    
    deleteStateMachineAlias in interface AWSStepFunctions
    
    Parameters:
    
    deleteStateMachineAliasRequest -
    
    Returns:
    
    Result of the DeleteStateMachineAlias operation returned by the service.
    
    Throws:
    
    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
    
    See Also:
    
    AWS API Documentation
  - deleteStateMachineVersion
```
public DeleteStateMachineVersionResult deleteStateMachineVersion(DeleteStateMachineVersionRequest request)
```
    Deletes a state machine version. After you delete a version, you can't call StartExecution using that version's ARN or use the version with a state machine alias.
    
    Deleting a state machine version won't terminate its in-progress executions.
    
    You can't delete a state machine version currently referenced by one or more aliases. Before you delete a version, you must either delete the aliases or update them to point to another state machine version.
    
    Related operations:
    - PublishStateMachineVersion
    - ListStateMachineVersions
    Specified by:
    
    deleteStateMachineVersion in interface AWSStepFunctions
    
    Parameters:
    
    deleteStateMachineVersionRequest -
    
    Returns:
    
    Result of the DeleteStateMachineVersion operation returned by the service.
    
    Throws:
    
    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
    
    See Also:
    
    AWS API Documentation
  - describeActivity
```
public DescribeActivityResult describeActivity(DescribeActivityRequest request)
```
    Describes an activity.
    
    This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
    
    Specified by:
    
    describeActivity in interface AWSStepFunctions
    
    Parameters:
    
    describeActivityRequest -
    
    Returns:
    
    Result of the DescribeActivity operation returned by the service.
    
    Throws:
    
    ActivityDoesNotExistException - The specified activity does not exist.
    
    InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.
    
    See Also:
    
    AWS API Documentation
  - describeExecution
```
public DescribeExecutionResult describeExecution(DescribeExecutionRequest request)
```
    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. 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 machinearen't supported by DescribeExecution unless a Map Run dispatched them.
    
    Specified by:
    
    describeExecution in interface AWSStepFunctions
    
    Parameters:
    
    describeExecutionRequest -
    
    Returns:
    
    Result of the DescribeExecution operation returned by the service.
    
    Throws:
    
    ExecutionDoesNotExistException - The specified execution does not exist.
    
    InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.
    
    See Also:
    
    AWS API Documentation
  - describeMapRun
```
public DescribeMapRunResult describeMapRun(DescribeMapRunRequest request)
```
    Provides information about a Map Run's configuration, progress, and results. For more information, see Examining Map Run in the Step Functions Developer Guide.
    
    Specified by:
    
    describeMapRun in interface AWSStepFunctions
    
    Parameters:
    
    describeMapRunRequest -
    
    Returns:
    
    Result of the DescribeMapRun operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - Could not find the referenced resource.
    
    InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.
    
    See Also:
    
    AWS API Documentation
  - describeStateMachine
```
public DescribeStateMachineResult describeStateMachine(DescribeStateMachineRequest request)
```
    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.
    Specified by:
    
    describeStateMachine in interface AWSStepFunctions
    
    Parameters:
    
    describeStateMachineRequest -
    
    Returns:
    
    Result of the DescribeStateMachine operation returned by the service.
    
    Throws:
    
    InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.
    
    StateMachineDoesNotExistException - The specified state machine does not exist.
    
    See Also:
    
    AWS API Documentation
  - describeStateMachineAlias
```
public DescribeStateMachineAliasResult describeStateMachineAlias(DescribeStateMachineAliasRequest request)
```
    Returns details about a state machine alias.
    
    Related operations:
    Specified by:
    
    describeStateMachineAlias in interface AWSStepFunctions
    
    Parameters:
    
    describeStateMachineAliasRequest -
    
    Returns:
    
    Result of the DescribeStateMachineAlias operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - describeStateMachineForExecution
```
public DescribeStateMachineForExecutionResult describeStateMachineForExecution(DescribeStateMachineForExecutionRequest request)
```
    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.
    
    Specified by:
    
    describeStateMachineForExecution in interface AWSStepFunctions
    
    Parameters:
    
    describeStateMachineForExecutionRequest -
    
    Returns:
    
    Result of the DescribeStateMachineForExecution operation returned by the service.
    
    Throws:
    
    ExecutionDoesNotExistException - The specified execution does not exist.
    
    InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.
    
    See Also:
    
    AWS API Documentation
  - getActivityTask
```
public GetActivityTaskResult getActivityTask(GetActivityTaskRequest request)
```
    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.
    
    Specified by:
    
    getActivityTask in interface AWSStepFunctions
    
    Parameters:
    
    getActivityTaskRequest -
    
    Returns:
    
    Result of the GetActivityTask operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getExecutionHistory
```
public GetExecutionHistoryResult getExecutionHistory(GetExecutionHistoryRequest request)
```
    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.
    
    Specified by:
    
    getExecutionHistory in interface AWSStepFunctions
    
    Parameters:
    
    getExecutionHistoryRequest -
    
    Returns:
    
    Result of the GetExecutionHistory operation returned by the service.
    
    Throws:
    
    ExecutionDoesNotExistException - The specified execution does not exist.
    
    InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.
    
    InvalidTokenException - The provided token is not valid.
    
    See Also:
    
    AWS API Documentation
  - listActivities
```
public ListActivitiesResult listActivities(ListActivitiesRequest request)
```
    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.
    
    Specified by:
    
    listActivities in interface AWSStepFunctions
    
    Parameters:
    
    listActivitiesRequest -
    
    Returns:
    
    Result of the ListActivities operation returned by the service.
    
    Throws:
    
    InvalidTokenException - The provided token is not valid.
    
    See Also:
    
    AWS API Documentation
  - listExecutions
```
public ListExecutionsResult listExecutions(ListExecutionsRequest request)
```
    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.
    
    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.
    
    Specified by:
    
    listExecutions in interface AWSStepFunctions
    
    Parameters:
    
    listExecutionsRequest -
    
    Returns:
    
    Result of the ListExecutions operation returned by the service.
    
    Throws:
    
    InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.
    
    InvalidTokenException - The provided token is not valid.
    
    StateMachineDoesNotExistException - The specified state machine does not exist.
    
    StateMachineTypeNotSupportedException
    
    ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.
    
    ResourceNotFoundException - Could not find the referenced resource.
    
    See Also:
    
    AWS API Documentation
  - listMapRuns
```
public ListMapRunsResult listMapRuns(ListMapRunsRequest request)
```
    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.
    
    Specified by:
    
    listMapRuns in interface AWSStepFunctions
    
    Parameters:
    
    listMapRunsRequest -
    
    Returns:
    
    Result of the ListMapRuns operation returned by the service.
    
    Throws:
    
    ExecutionDoesNotExistException - The specified execution does not exist.
    
    InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.
    
    InvalidTokenException - The provided token is not valid.
    
    See Also:
    
    AWS API Documentation
  - listStateMachineAliases
```
public ListStateMachineAliasesResult listStateMachineAliases(ListStateMachineAliasesRequest request)
```
    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:
    Specified by:
    
    listStateMachineAliases in interface AWSStepFunctions
    
    Parameters:
    
    listStateMachineAliasesRequest -
    
    Returns:
    
    Result of the ListStateMachineAliases operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listStateMachineVersions
```
public ListStateMachineVersionsResult listStateMachineVersions(ListStateMachineVersionsRequest request)
```
    Lists versions for the specified state machine Amazon Resource Name (ARN).
    
    The results are sorted in descending order of the version creation time.
    
    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
    
    Related operations:
    - PublishStateMachineVersion
    - DeleteStateMachineVersion
    Specified by:
    
    listStateMachineVersions in interface AWSStepFunctions
    
    Parameters:
    
    listStateMachineVersionsRequest -
    
    Returns:
    
    Result of the ListStateMachineVersions operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listStateMachines
```
public ListStateMachinesResult listStateMachines(ListStateMachinesRequest request)
```
    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.
    
    Specified by:
    
    listStateMachines in interface AWSStepFunctions
    
    Parameters:
    
    listStateMachinesRequest -
    
    Returns:
    
    Result of the ListStateMachines operation returned by the service.
    
    Throws:
    
    InvalidTokenException - The provided token is not valid.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    List tags for a given resource.
    
    Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
    
    Specified by:
    
    listTagsForResource in interface AWSStepFunctions
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.
    
    ResourceNotFoundException - Could not find the referenced resource.
    
    See Also:
    
    AWS API Documentation
  - publishStateMachineVersion
```
public PublishStateMachineVersionResult publishStateMachineVersion(PublishStateMachineVersionRequest request)
```
    Creates a version from the current revision of a state machine. Use versions to create immutable snapshots of your state machine. You can start executions from versions either directly or with an alias. To create an alias, use CreateStateMachineAlias.
    
    You can publish up to 1000 versions for each state machine. You must manually delete unused versions using the DeleteStateMachineVersion API action.
    
    PublishStateMachineVersion is an idempotent API. It doesn't create a duplicate state machine version if it already exists for the current revision. Step Functions bases PublishStateMachineVersion's idempotency check on the stateMachineArn, name, and revisionId parameters. Requests with the same parameters return a successful idempotent response. If you don't specify a revisionId, Step Functions checks for a previously published version of the state machine's current revision.
    
    Related operations:
    - DeleteStateMachineVersion
    - ListStateMachineVersions
    Specified by:
    
    publishStateMachineVersion in interface AWSStepFunctions
    
    Parameters:
    
    publishStateMachineVersionRequest -
    
    Returns:
    
    Result of the PublishStateMachineVersion operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - sendTaskFailure
```
public SendTaskFailureResult sendTaskFailure(SendTaskFailureRequest request)
```
    Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed.
    
    Specified by:
    
    sendTaskFailure in interface AWSStepFunctions
    
    Parameters:
    
    sendTaskFailureRequest -
    
    Returns:
    
    Result of the SendTaskFailure operation returned by the service.
    
    Throws:
    
    TaskDoesNotExistException
    
    InvalidTokenException - The provided token is not valid.
    
    TaskTimedOutException
    
    See Also:
    
    AWS API Documentation
  - sendTaskHeartbeat
```
public SendTaskHeartbeatResult sendTaskHeartbeat(SendTaskHeartbeatRequest request)
```
    Used by activity workers and task states using the callback 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 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.
    
    Specified by:
    
    sendTaskHeartbeat in interface AWSStepFunctions
    
    Parameters:
    
    sendTaskHeartbeatRequest -
    
    Returns:
    
    Result of the SendTaskHeartbeat operation returned by the service.
    
    Throws:
    
    TaskDoesNotExistException
    
    InvalidTokenException - The provided token is not valid.
    
    TaskTimedOutException
    
    See Also:
    
    AWS API Documentation
  - sendTaskSuccess
```
public SendTaskSuccessResult sendTaskSuccess(SendTaskSuccessRequest request)
```
    Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken completed successfully.
    
    Specified by:
    
    sendTaskSuccess in interface AWSStepFunctions
    
    Parameters:
    
    sendTaskSuccessRequest -
    
    Returns:
    
    Result of the SendTaskSuccess operation returned by the service.
    
    Throws:
    
    TaskDoesNotExistException
    
    InvalidOutputException - The provided JSON output data is not valid.
    
    InvalidTokenException - The provided token is not valid.
    
    TaskTimedOutException
    
    See Also:
    
    AWS API Documentation
  - startExecution
```
public StartExecutionResult startExecution(StartExecutionRequest request)
```
    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.
    Specified by:
    
    startExecution in interface AWSStepFunctions
    
    Parameters:
    
    startExecutionRequest -
    
    Returns:
    
    Result of the StartExecution operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - startSyncExecution
```
public StartSyncExecutionResult startSyncExecution(StartSyncExecutionRequest request)
```
    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.
    
    Specified by:
    
    startSyncExecution in interface AWSStepFunctions
    
    Parameters:
    
    startSyncExecutionRequest -
    
    Returns:
    
    Result of the StartSyncExecution operation returned by the service.
    
    Throws:
    
    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
    
    See Also:
    
    AWS API Documentation
  - stopExecution
```
public StopExecutionResult stopExecution(StopExecutionRequest request)
```
    Stops an execution.
    
    This API action is not supported by EXPRESS state machines.
    
    Specified by:
    
    stopExecution in interface AWSStepFunctions
    
    Parameters:
    
    stopExecutionRequest -
    
    Returns:
    
    Result of the StopExecution operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    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: _ . : / = + - @.
    
    Specified by:
    
    tagResource in interface AWSStepFunctions
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Remove a tag from a Step Functions resource
    
    Specified by:
    
    untagResource in interface AWSStepFunctions
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.
    
    ResourceNotFoundException - Could not find the referenced resource.
    
    See Also:
    
    AWS API Documentation
  - updateMapRun
```
public UpdateMapRunResult updateMapRun(UpdateMapRunRequest request)
```
    Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure.
    
    Specified by:
    
    updateMapRun in interface AWSStepFunctions
    
    Parameters:
    
    updateMapRunRequest -
    
    Returns:
    
    Result of the UpdateMapRun operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateStateMachine
```
public UpdateStateMachineResult updateStateMachine(UpdateStateMachineRequest request)
```
    Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error.
    
    A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.
    
    A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.
    
    The following are some examples of qualified and unqualified state machine ARNs:
    - The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine.
      
      arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
      
      If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException.
    - The following qualified state machine ARN refers to an alias named PROD.
      
      arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>
      
      If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.
    - The following unqualified state machine ARN refers to a state machine named myStateMachine.
      
      arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>
    After you update your state machine, you can set the publish parameter to true in the same action to publish a new version. This way, you can opt-in to strict versioning of your state machine.
    
    Step Functions assigns monotonically increasing integers for state machine versions, starting at version number 1.
    
    All StartExecution calls within a few seconds use the updated definition and roleArn. Executions started immediately after you call UpdateStateMachine may use the previous state machine definition and roleArn.
    Specified by:
    
    updateStateMachine in interface AWSStepFunctions
    
    Parameters:
    
    updateStateMachineRequest -
    
    Returns:
    
    Result of the UpdateStateMachine operation returned by the service.
    
    Throws:
    
    InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.
    
    InvalidDefinitionException - The provided Amazon States Language definition is not valid.
    
    InvalidLoggingConfigurationException
    
    InvalidTracingConfigurationException - Your tracingConfiguration key does not match, 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.
    
    See Also:
    
    AWS API Documentation
  - updateStateMachineAlias
```
public UpdateStateMachineAliasResult updateStateMachineAlias(UpdateStateMachineAliasRequest request)
```
    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:
    Specified by:
    
    updateStateMachineAlias in interface AWSStepFunctions
    
    Parameters:
    
    updateStateMachineAliasRequest -
    
    Returns:
    
    Result of the UpdateStateMachineAlias operation returned by the service.
    
    Throws:
    
    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
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSStepFunctions
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSStepFunctions
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSStepFunctions
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Class AWSStepFunctionsClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.stepfunctions.AWSStepFunctions

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.services.stepfunctions.AWSStepFunctions

Field Detail

configFactory

Constructor Detail

AWSStepFunctionsClient

AWSStepFunctionsClient

AWSStepFunctionsClient

AWSStepFunctionsClient

AWSStepFunctionsClient

AWSStepFunctionsClient

AWSStepFunctionsClient

Method Detail

builder

createActivity

createStateMachine

createStateMachineAlias

deleteActivity

deleteStateMachine

deleteStateMachineAlias

deleteStateMachineVersion

describeActivity

describeExecution

describeMapRun

describeStateMachine

describeStateMachineAlias

describeStateMachineForExecution

getActivityTask

getExecutionHistory

listActivities

listExecutions

listMapRuns

listStateMachineAliases

listStateMachineVersions

listStateMachines

listTagsForResource

publishStateMachineVersion

sendTaskFailure

sendTaskHeartbeat

sendTaskSuccess

startExecution

startSyncExecution

stopExecution

tagResource

untagResource

updateMapRun

updateStateMachine

updateStateMachineAlias

getCachedResponseMetadata

shutdown