com.amazonaws.services.stepfunctions

Class AWSStepFunctionsClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.stepfunctions.AWSStepFunctionsClient

All Implemented Interfaces:

AWSStepFunctions

Direct Known Subclasses:

AWSStepFunctionsAsyncClient

@ThreadSafe
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 web service that enables you to coordinate the components of distributed applications and microservices using visual workflows. You build applications from individual components that each perform a discrete function, or task, allowing you to scale and change applications quickly. Step Functions provides a graphical console to visualize the components of your application as a series of steps. It automatically triggers and tracks each step, and retries when there are errors, so your application executes in order and as expected, every time. Step Functions logs the state of each step, so when things do go wrong, you can diagnose and debug problems quickly.

Step Functions manages the operations and underlying infrastructure for you to ensure your application is available at any scale. You can run tasks on the AWS cloud, on your own servers, or an any system that has access to AWS. Step Functions can be accessed and used with the Step Functions console, the AWS SDKs (included with your Beta release invitation email), or an HTTP API (the subject of this document).

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() Constructs a new client to invoke service methods on AWS SFN.
AWSStepFunctionsClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AWS SFN using the specified AWS account credentials.
AWSStepFunctionsClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWS SFN using the specified AWS account credentials and client configuration options.
AWSStepFunctionsClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AWS SFN using the specified AWS account credentials provider.
AWSStepFunctionsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWS SFN using the specified AWS account credentials provider and client configuration options.
AWSStepFunctionsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector 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.
AWSStepFunctionsClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWS SFN.

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.
GetActivityTaskResult	getActivityTask(GetActivityTaskRequest getActivityTaskRequest) Used by workers to retrieve a task (with the specified activity ARN) 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.
StartExecutionResult	startExecution(StartExecutionRequest startExecutionRequest) Starts a state machine execution.
StopExecutionResult	stopExecution(StopExecutionRequest stopExecutionRequest) Stops an execution.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

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, shutdown

Constructor Detail

AWSStepFunctionsClient

public AWSStepFunctionsClient()

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

public AWSStepFunctionsClient(ClientConfiguration 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

public AWSStepFunctionsClient(AWSCredentials awsCredentials)

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

public AWSStepFunctionsClient(AWSCredentials awsCredentials,
                              ClientConfiguration 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

public AWSStepFunctionsClient(AWSCredentialsProvider 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

public AWSStepFunctionsClient(AWSCredentialsProvider awsCredentialsProvider,
                              ClientConfiguration 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

public AWSStepFunctionsClient(AWSCredentialsProvider awsCredentialsProvider,
                              ClientConfiguration clientConfiguration,
                              RequestMetricCollector 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

createActivity

public CreateActivityResult createActivity(CreateActivityRequest createActivityRequest)

Creates an activity.

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.

See Also:

AWS API Documentation

createStateMachine

public CreateStateMachineResult createStateMachine(CreateStateMachineRequest createStateMachineRequest)

Creates a state machine.

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.

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

public DeleteActivityResult deleteActivity(DeleteActivityRequest deleteActivityRequest)

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

Deletes a state machine. This is an asynchronous operation-- it sets the state machine's status to "DELETING" and begins the delete process.

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

Describes an activity.

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

Describes an execution.

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

Describes a state machine.

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

getActivityTask

public GetActivityTaskResult getActivityTask(GetActivityTaskRequest getActivityTaskRequest)

Used by workers to retrieve a task (with the specified activity ARN) 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 will return an empty result, that is, the taskToken returned is an empty 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).

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 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. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken returned by the previous call.

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

Lists the existing activities. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken returned by the previous call.

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

Lists the executions of a state machine that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken returned by the previous call.

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.

See Also:

AWS API Documentation

listStateMachines

public ListStateMachinesResult listStateMachines(ListStateMachinesRequest listStateMachinesRequest)

Lists the existing state machines. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken returned by the previous call.

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

sendTaskFailure

public SendTaskFailureResult sendTaskFailure(SendTaskFailureRequest sendTaskFailureRequest)

Used by workers 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 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 will contain 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.

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

Used by workers 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 startExecutionRequest)

Starts a state machine execution.

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 - An execution with the same name already exists.

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

public StopExecutionResult stopExecution(StopExecutionRequest stopExecutionRequest)

Stops an execution.

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

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.