AWSStepFunctionsClient (AWS SDK for Java

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.
AWS Step Functions
AWS 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 AWS, your own servers, or any system that has access to AWS. You can access and use Step Functions using the console, the AWS SDKs, or an HTTP API. For more information about Step Functions, see the AWS Step Functions Developer Guide .

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- 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.
`DeleteActivityResult`	`deleteActivity(DeleteActivityRequest request)` Deletes an activity.
`DeleteStateMachineResult`	`deleteStateMachine(DeleteStateMachineRequest request)` Deletes a state machine.
`DescribeActivityResult`	`describeActivity(DescribeActivityRequest request)` Describes an activity.
`DescribeExecutionResult`	`describeExecution(DescribeExecutionRequest request)` Describes an execution.
`DescribeStateMachineResult`	`describeStateMachine(DescribeStateMachineRequest request)` Describes a state machine.
`DescribeStateMachineForExecutionResult`	`describeStateMachineForExecution(DescribeStateMachineForExecutionRequest request)` Describes the state machine associated with a specific execution.
`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 the executions of a state machine that meet the filtering criteria.
`ListStateMachinesResult`	`listStateMachines(ListStateMachinesRequest request)` Lists the existing state machines.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` List tags for a given resource.
`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
`UpdateStateMachineResult`	`updateStateMachine(UpdateStateMachineRequest request)` Updates an existing state machine by modifying its `definition`, `roleArn`, or `loggingConfiguration`.

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

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

- 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 AWS 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 invalid.
    
    TooManyTagsException - You've exceeded the number of tags allowed for a resource. See the Limits Topic in the AWS 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 AWS Step Functions User Guide.
    
    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. 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 invalid.
    
    InvalidDefinitionException - The provided Amazon States Language definition is invalid.
    
    InvalidNameException - The provided name is invalid.
    
    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 AWS Step Functions Developer Guide.
    
    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 invalid.
    
    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.
    
    For EXPRESSstate machines, the deletion will happen eventually (usually 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 invalid.
    
    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 invalid.
    
    See Also:
    
    AWS API Documentation
  - describeExecution
```
public DescribeExecutionResult describeExecution(DescribeExecutionRequest request)
```
    Describes an execution.
    
    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:
    
    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 invalid.
    
    See Also:
    
    AWS API Documentation
  - describeStateMachine
```
public DescribeStateMachineResult describeStateMachine(DescribeStateMachineRequest request)
```
    Describes a state machine.
    
    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 invalid.
    
    StateMachineDoesNotExistException - The specified state machine does not exist.
    
    See Also:
    
    AWS API Documentation
  - describeStateMachineForExecution
```
public DescribeStateMachineForExecutionResult describeStateMachineForExecution(DescribeStateMachineForExecutionRequest request)
```
    Describes the state machine associated with a specific execution.
    
    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 invalid.
    
    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.
    
    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 invalid.
    
    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 invalid.
    
    InvalidTokenException - The provided token is invalid.
    
    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 invalid.
    
    See Also:
    
    AWS API Documentation
  - listExecutions
```
public ListExecutionsResult listExecutions(ListExecutionsRequest request)
```
    Lists the executions of a state machine that meet the filtering criteria. 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 invalid.
    
    InvalidTokenException - The provided token is invalid.
    
    StateMachineDoesNotExistException - The specified state machine does not exist.
    
    StateMachineTypeNotSupportedException
    
    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 invalid.
    
    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 invalid.
    
    ResourceNotFoundException - Could not find the referenced resource. Only state machine and activity ARNs are supported.
    
    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 invalid.
    
    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 invalid.
    
    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 invalid.
    
    InvalidTokenException - The provided token is invalid.
    
    TaskTimedOutException
    
    See Also:
    
    AWS API Documentation
  - startExecution
```
public StartExecutionResult startExecution(StartExecutionRequest request)
```
    Starts a state machine execution.
    
    StartExecution is idempotent. If StartExecution is called with the same name and input as a running execution, the call will succeed and return the same response as the original request. If the execution is closed or if the input is different, it will return a 400 ExecutionAlreadyExists error. Names can be reused after 90 days.
    
    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 invalid.
    
    InvalidExecutionInputException - The provided JSON input data is invalid.
    
    InvalidNameException - The provided name is invalid.
    
    StateMachineDoesNotExistException - The specified state machine does not exist.
    
    StateMachineDeletingException - The specified state machine is being deleted.
    
    See Also:
    
    AWS API Documentation
  - startSyncExecution
```
public StartSyncExecutionResult startSyncExecution(StartSyncExecutionRequest request)
```
    Starts a Synchronous Express state machine execution.
    
    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 invalid.
    
    InvalidExecutionInputException - The provided JSON input data is invalid.
    
    InvalidNameException - The provided name is invalid.
    
    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 invalid.
    
    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 AWS 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 invalid.
    
    ResourceNotFoundException - Could not find the referenced resource. Only state machine and activity ARNs are supported.
    
    TooManyTagsException - You've exceeded the number of tags allowed for a resource. See the Limits Topic in the AWS 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 invalid.
    
    ResourceNotFoundException - Could not find the referenced resource. Only state machine and activity ARNs are supported.
    
    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.
    
    All StartExecution calls within a few seconds will use the updated definition and roleArn. Executions started immediately after calling 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 invalid.
    
    InvalidDefinitionException - The provided Amazon States Language definition is invalid.
    
    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.
    
    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 class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. 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

Did this page help you?

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

Constructor Detail

AWSStepFunctionsClient

AWSStepFunctionsClient

AWSStepFunctionsClient

AWSStepFunctionsClient

AWSStepFunctionsClient

AWSStepFunctionsClient

AWSStepFunctionsClient

Method Detail

builder

createActivity

createStateMachine

deleteActivity

deleteStateMachine

describeActivity

describeExecution

describeStateMachine

describeStateMachineForExecution

getActivityTask

getExecutionHistory

listActivities

listExecutions

listStateMachines

listTagsForResource

sendTaskFailure

sendTaskHeartbeat

sendTaskSuccess

startExecution

startSyncExecution

stopExecution

tagResource

untagResource

updateStateMachine

getCachedResponseMetadata

shutdown