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.

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
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) Provides all 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 describeMapRunRequest) Provides information about a Map Run's configuration, progress, and results.
DescribeStateMachineResult	describeStateMachine(DescribeStateMachineRequest describeStateMachineRequest) Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration.
DescribeStateMachineForExecutionResult	describeStateMachineForExecution(DescribeStateMachineForExecutionRequest describeStateMachineForExecutionRequest) Provides information about a state machine's definition, its execution role ARN, and configuration.
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 all executions of a state machine or a Map Run.
ListMapRunsResult	listMapRuns(ListMapRunsRequest listMapRunsRequest) Lists all Map Runs that were started by a given state machine execution.
ListStateMachinesResult	listStateMachines(ListStateMachinesRequest listStateMachinesRequest) Lists the existing state machines.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) List tags for a given resource.
SendTaskFailureResult	sendTaskFailure(SendTaskFailureRequest sendTaskFailureRequest) Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed.
SendTaskHeartbeatResult	sendTaskHeartbeat(SendTaskHeartbeatRequest sendTaskHeartbeatRequest) 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 sendTaskSuccessRequest) Used by activity workers and task states using the callback pattern 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.
StartSyncExecutionResult	startSyncExecution(StartSyncExecutionRequest startSyncExecutionRequest) Starts a Synchronous Express state machine execution.
StopExecutionResult	stopExecution(StopExecutionRequest stopExecutionRequest) Stops an execution.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Add a tag to a Step Functions resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Remove a tag from a Step Functions resource
UpdateMapRunResult	updateMapRun(UpdateMapRunRequest updateMapRunRequest) Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure.
UpdateStateMachineResult	updateStateMachine(UpdateStateMachineRequest updateStateMachineRequest) Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration.

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 that you write in any programming language and host on any machine that has access to Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity.

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

CreateActivity is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateActivity's idempotency check is based on the activity name. If a following request has different tags values, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.

Parameters:

createActivityRequest -

Returns:

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

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. For more information, see Amazon States Language in the 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.

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.

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 not valid.

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.

If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.

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.

For EXPRESS state machines, the deletion will happen eventually (usually less than a minute). Running executions may emit logs after DeleteStateMachine API is called.

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

describeActivity

DescribeActivityResult describeActivity(DescribeActivityRequest describeActivityRequest)

Describes an activity.

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

Parameters:

describeActivityRequest -

Returns:

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

DescribeExecutionResult describeExecution(DescribeExecutionRequest describeExecutionRequest)

Provides all 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 ARN if the execution was dispatched by a 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 machine executions unless they were dispatched by a Map Run.

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

DescribeMapRunResult describeMapRun(DescribeMapRunRequest describeMapRunRequest)

Provides information about a Map Run's configuration, progress, and results. For more information, see Examining Map Run in the Step Functions Developer Guide.

Parameters:

describeMapRunRequest -

Returns:

Result of the DescribeMapRun operation returned by the service.

Throws:

ResourceNotFoundException - Could not find the referenced resource. Only state machine and activity ARNs are supported.

InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.

See Also:

AWS API Documentation

describeStateMachine

DescribeStateMachineResult describeStateMachine(DescribeStateMachineRequest describeStateMachineRequest)

Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration. If the state machine ARN is a qualified state machine ARN, the response returned includes the Map state's label.

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.

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

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

describeStateMachineForExecution

DescribeStateMachineForExecutionResult describeStateMachineForExecution(DescribeStateMachineForExecutionRequest describeStateMachineForExecutionRequest)

Provides information about a state machine's definition, its execution role ARN, and configuration. If an execution was dispatched by a Map Run, the Map Run is returned in the response. Additionally, the state machine returned will be the state machine associated with the Map Run.

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

This API action is not supported by EXPRESS state machines.

Parameters:

describeStateMachineForExecutionRequest -

Returns:

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

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.

This API action isn't logged in CloudTrail.

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

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

Parameters:

getActivityTaskRequest -

Returns:

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

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 nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

This API action is not supported by EXPRESS state machines.

Parameters:

getExecutionHistoryRequest -

Returns:

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

ListActivitiesResult listActivities(ListActivitiesRequest listActivitiesRequest)

Lists the existing activities.

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

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

Parameters:

listActivitiesRequest -

Returns:

Result of the ListActivities operation returned by the service.

Throws:

InvalidTokenException - The provided token is not valid.

See Also:

AWS API Documentation

listExecutions

ListExecutionsResult listExecutions(ListExecutionsRequest listExecutionsRequest)

Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN.

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

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

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

This API action is not supported by EXPRESS state machines.

Parameters:

listExecutionsRequest -

Returns:

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. Only state machine and activity ARNs are supported.

See Also:

AWS API Documentation

listMapRuns

ListMapRunsResult listMapRuns(ListMapRunsRequest listMapRunsRequest)

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

Parameters:

listMapRunsRequest -

Returns:

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

listStateMachines

ListStateMachinesResult listStateMachines(ListStateMachinesRequest listStateMachinesRequest)

Lists the existing state machines.

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

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

Parameters:

listStateMachinesRequest -

Returns:

Result of the ListStateMachines operation returned by the service.

Throws:

InvalidTokenException - The provided token is not valid.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

List tags for a given resource.

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

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. Only state machine and activity ARNs are supported.

See Also:

AWS API Documentation

sendTaskFailure

SendTaskFailureResult sendTaskFailure(SendTaskFailureRequest sendTaskFailureRequest)

Used by activity workers and task states using the callback pattern 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 not valid.

TaskTimedOutException

See Also:

AWS API Documentation

sendTaskHeartbeat

SendTaskHeartbeatResult sendTaskHeartbeat(SendTaskHeartbeatRequest sendTaskHeartbeatRequest)

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.

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

SendTaskSuccessResult sendTaskSuccess(SendTaskSuccessRequest sendTaskSuccessRequest)

Used by activity workers and task states using the callback pattern 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 not valid.

InvalidTokenException - The provided token is not valid.

TaskTimedOutException

See Also:

AWS API Documentation

startExecution

StartExecutionResult startExecution(StartExecutionRequest startExecutionRequest)

Starts a state machine execution. If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.

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.

StartExecution is idempotent for STANDARD workflows. For a STANDARD workflow, 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.

StartExecution is not idempotent for EXPRESS workflows.

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

StartSyncExecutionResult startSyncExecution(StartSyncExecutionRequest startSyncExecutionRequest)

Starts a Synchronous Express state machine execution. StartSyncExecution is not available for STANDARD workflows.

StartSyncExecution will return a 200 OK response, even if your execution fails, because the status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your execution from running, such as permissions errors, limit errors, or issues with your state machine code and configuration.

This API action isn't logged in CloudTrail.

Parameters:

startSyncExecutionRequest -

Returns:

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

StopExecutionResult stopExecution(StopExecutionRequest stopExecutionRequest)

Stops an execution.

This API action is not supported by EXPRESS state machines.

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

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Add a tag to a Step Functions resource.

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

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

Parameters:

tagResourceRequest -

Returns:

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. 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 Step Functions Developer Guide.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Remove a tag from a Step Functions resource

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. Only state machine and activity ARNs are supported.

See Also:

AWS API Documentation

updateMapRun

UpdateMapRunResult updateMapRun(UpdateMapRunRequest updateMapRunRequest)

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

Parameters:

updateMapRunRequest -

Returns:

Result of the UpdateMapRun operation returned by the service.

Throws:

ResourceNotFoundException - Could not find the referenced resource. Only state machine and activity ARNs are supported.

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

UpdateStateMachineResult updateStateMachine(UpdateStateMachineRequest updateStateMachineRequest)

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.

If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.

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.

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.

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.

ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.

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.