com.amazonaws.services.stepfunctions

Interface AWSStepFunctions

All Known Subinterfaces:

AWSStepFunctionsAsync

All Known Implementing Classes:

AbstractAWSStepFunctions, AbstractAWSStepFunctionsAsync, AWSStepFunctionsAsyncClient, AWSStepFunctionsClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSStepFunctions

Interface for accessing AWS SFN.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSStepFunctions instead.

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

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateActivityResult	createActivity(CreateActivityRequest createActivityRequest) Creates an activity.
CreateStateMachineResult	createStateMachine(CreateStateMachineRequest createStateMachineRequest) Creates a state machine.
DeleteActivityResult	deleteActivity(DeleteActivityRequest deleteActivityRequest) Deletes an activity.
DeleteStateMachineResult	deleteStateMachine(DeleteStateMachineRequest deleteStateMachineRequest) Deletes a state machine.
DescribeActivityResult	describeActivity(DescribeActivityRequest describeActivityRequest) Describes an activity.
DescribeExecutionResult	describeExecution(DescribeExecutionRequest describeExecutionRequest) Describes an execution.
DescribeStateMachineResult	describeStateMachine(DescribeStateMachineRequest describeStateMachineRequest) Describes a state machine.
DescribeStateMachineForExecutionResult	describeStateMachineForExecution(DescribeStateMachineForExecutionRequest describeStateMachineForExecutionRequest) Describes the state machine associated with a specific execution.
GetActivityTaskResult	getActivityTask(GetActivityTaskRequest getActivityTaskRequest) Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine.
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 getExecutionHistoryRequest) Returns the history of the specified execution as a list of events.
ListActivitiesResult	listActivities(ListActivitiesRequest listActivitiesRequest) Lists the existing activities.
ListExecutionsResult	listExecutions(ListExecutionsRequest listExecutionsRequest) Lists the executions of a state machine that meet the filtering criteria.
ListStateMachinesResult	listStateMachines(ListStateMachinesRequest listStateMachinesRequest) Lists the existing state machines.
SendTaskFailureResult	sendTaskFailure(SendTaskFailureRequest sendTaskFailureRequest) Used by workers to report that the task identified by the taskToken failed.
SendTaskHeartbeatResult	sendTaskHeartbeat(SendTaskHeartbeatRequest sendTaskHeartbeatRequest) Used by workers to report to the service that the task represented by the specified taskToken is still making progress.
SendTaskSuccessResult	sendTaskSuccess(SendTaskSuccessRequest sendTaskSuccessRequest) Used by workers to report that the task identified by the taskToken completed successfully.
void	setEndpoint(String endpoint) Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
void	setRegion(Region region) Deprecated. use AwsClientBuilder#setRegion(String)
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartExecutionResult	startExecution(StartExecutionRequest startExecutionRequest) Starts a state machine execution.
StopExecutionResult	stopExecution(StopExecutionRequest stopExecutionRequest) Stops an execution.
UpdateStateMachineResult	updateStateMachine(UpdateStateMachineRequest updateStateMachineRequest) Updates an existing state machine by modifying its definition and/or roleArn.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

setEndpoint

@Deprecated
void setEndpoint(String endpoint)

Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));

Overrides the default endpoint for this client ("states.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "states.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "states.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "states.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "states.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setRegion

@Deprecated
void setRegion(Region region)

Deprecated. use AwsClientBuilder#setRegion(String)

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

createActivity

CreateActivityResult createActivity(CreateActivityRequest createActivityRequest)

Creates an activity. An activity is a task which you write in any programming language and host on any machine which 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.

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.

See Also:

AWS API Documentation

createStateMachine

CreateStateMachineResult createStateMachine(CreateStateMachineRequest createStateMachineRequest)

Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language.

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.

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.

See Also:

AWS API Documentation

deleteActivity

DeleteActivityResult deleteActivity(DeleteActivityRequest deleteActivityRequest)

Deletes an activity.

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

DeleteStateMachineResult deleteStateMachine(DeleteStateMachineRequest deleteStateMachineRequest)

Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process. Each state machine execution is deleted the next time it makes a state transition.

The state machine itself is deleted after all executions are completed or deleted.

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

DescribeActivityResult describeActivity(DescribeActivityRequest describeActivityRequest)

Describes an activity.

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

DescribeExecutionResult describeExecution(DescribeExecutionRequest describeExecutionRequest)

Describes an execution.

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

DescribeStateMachineResult describeStateMachine(DescribeStateMachineRequest describeStateMachineRequest)

Describes a state machine.

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

DescribeStateMachineForExecutionResult describeStateMachineForExecution(DescribeStateMachineForExecutionRequest describeStateMachineForExecutionRequest)

Describes the state machine associated with a specific execution.

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

GetActivityTaskResult getActivityTask(GetActivityTaskRequest getActivityTaskRequest)

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

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

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

GetExecutionHistoryResult getExecutionHistory(GetExecutionHistoryRequest getExecutionHistoryRequest)

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

If a nextToken is returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.

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

ListActivitiesResult listActivities(ListActivitiesRequest listActivitiesRequest)

Lists the existing activities.

If a nextToken is returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.

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

ListExecutionsResult listExecutions(ListExecutionsRequest listExecutionsRequest)

Lists the executions of a state machine that meet the filtering criteria.

If a nextToken is returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.

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.

See Also:

AWS API Documentation

listStateMachines

ListStateMachinesResult listStateMachines(ListStateMachinesRequest listStateMachinesRequest)

Lists the existing state machines.

If a nextToken is returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.

Parameters:

listStateMachinesRequest -

Returns:

Result of the ListStateMachines operation returned by the service.

Throws:

InvalidTokenException - The provided token is invalid.

See Also:

AWS API Documentation

sendTaskFailure

SendTaskFailureResult sendTaskFailure(SendTaskFailureRequest sendTaskFailureRequest)

Used by workers to report that the task identified by the taskToken failed.

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

SendTaskHeartbeatResult sendTaskHeartbeat(SendTaskHeartbeatRequest sendTaskHeartbeatRequest)

Used by workers to report to the service 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. 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 event.

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.

This operation is only useful for long-lived tasks to report the liveliness of the task.

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

SendTaskSuccessResult sendTaskSuccess(SendTaskSuccessRequest sendTaskSuccessRequest)

Used by workers to report that the task identified by the taskToken completed successfully.

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

StartExecutionResult startExecution(StartExecutionRequest startExecutionRequest)

Starts a state machine execution.

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

stopExecution

StopExecutionResult stopExecution(StopExecutionRequest stopExecutionRequest)

Stops an execution.

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

updateStateMachine

UpdateStateMachineResult updateStateMachine(UpdateStateMachineRequest updateStateMachineRequest)

Updates an existing state machine by modifying its definition and/or roleArn. Running executions will continue to use the previous definition and roleArn.

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. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error.

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.

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

shutdown

void shutdown()

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.

getCachedResponseMetadata

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

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.