@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSStepFunctions
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSStepFunctions instead.
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 .
If you use the Step Functions API actions using Amazon Web Services SDK integrations, make sure the API actions are
in camel case and parameter names are in Pascal case. For example, you could use Step Functions API action
startSyncExecution and specify its parameter as StateMachineArn.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
CreateActivityResult |
createActivity(CreateActivityRequest createActivityRequest)
Creates an activity.
|
CreateStateMachineResult |
createStateMachine(CreateStateMachineRequest createStateMachineRequest)
Creates a state machine.
|
CreateStateMachineAliasResult |
createStateMachineAlias(CreateStateMachineAliasRequest createStateMachineAliasRequest)
|
DeleteActivityResult |
deleteActivity(DeleteActivityRequest deleteActivityRequest)
Deletes an activity.
|
DeleteStateMachineResult |
deleteStateMachine(DeleteStateMachineRequest deleteStateMachineRequest)
Deletes a state machine.
|
DeleteStateMachineAliasResult |
deleteStateMachineAlias(DeleteStateMachineAliasRequest deleteStateMachineAliasRequest)
Deletes a state machine alias.
|
DeleteStateMachineVersionResult |
deleteStateMachineVersion(DeleteStateMachineVersionRequest deleteStateMachineVersionRequest)
Deletes a state machine version.
|
DescribeActivityResult |
describeActivity(DescribeActivityRequest describeActivityRequest)
Describes an activity.
|
DescribeExecutionResult |
describeExecution(DescribeExecutionRequest describeExecutionRequest)
Provides information about a state machine execution, such as the state machine associated with the execution,
the execution input and output, and relevant execution metadata.
|
DescribeMapRunResult |
describeMapRun(DescribeMapRunRequest 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.
|
DescribeStateMachineAliasResult |
describeStateMachineAlias(DescribeStateMachineAliasRequest describeStateMachineAliasRequest)
Returns details about a state machine alias.
|
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.
|
ListStateMachineAliasesResult |
listStateMachineAliases(ListStateMachineAliasesRequest listStateMachineAliasesRequest)
Lists aliases for a
specified state machine ARN.
|
ListStateMachinesResult |
listStateMachines(ListStateMachinesRequest listStateMachinesRequest)
Lists the existing state machines.
|
ListStateMachineVersionsResult |
listStateMachineVersions(ListStateMachineVersionsRequest listStateMachineVersionsRequest)
Lists versions for
the specified state machine Amazon Resource Name (ARN).
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List tags for a given resource.
|
PublishStateMachineVersionResult |
publishStateMachineVersion(PublishStateMachineVersionRequest publishStateMachineVersionRequest)
Creates a version from
the current revision of a state machine.
|
RedriveExecutionResult |
redriveExecution(RedriveExecutionRequest redriveExecutionRequest)
Restarts unsuccessful executions of Standard workflows that didn't complete successfully in the last 14 days.
|
SendTaskFailureResult |
sendTaskFailure(SendTaskFailureRequest sendTaskFailureRequest)
|
SendTaskHeartbeatResult |
sendTaskHeartbeat(SendTaskHeartbeatRequest sendTaskHeartbeatRequest)
|
SendTaskSuccessResult |
sendTaskSuccess(SendTaskSuccessRequest sendTaskSuccessRequest)
|
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.
|
TestStateResult |
testState(TestStateRequest testStateRequest)
Accepts the definition of a single state and executes it.
|
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. |
UpdateStateMachineAliasResult |
updateStateMachineAlias(UpdateStateMachineAliasRequest updateStateMachineAliasRequest)
Updates the configuration of an existing state machine alias by
modifying its
description or routingConfiguration. |
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
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.
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.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)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.
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.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)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.
createActivityRequest - 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.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.
If you set the publish parameter of this API action to true, it publishes version
1 as the first revision of the state machine.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it
was already created. CreateStateMachine's idempotency check is based on the state machine
name, definition, type, LoggingConfiguration, and
TracingConfiguration. The check is also based on the publish and
versionDescription parameters. If a following request has a different roleArn or
tags, Step Functions will ignore these differences and treat it as an idempotent request of the
previous. In this case, roleArn and tags will not be updated, even if they are
different.
createStateMachineRequest - 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.InvalidLoggingConfigurationExceptionInvalidTracingConfigurationException - 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.StateMachineTypeNotSupportedExceptionTooManyTagsException - You've exceeded the number of tags allowed for a resource. See the Limits Topic in the Step
Functions Developer Guide.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.ConflictException - Updating or deleting a resource can cause an inconsistent state. This error occurs when there're
concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or
UpdateStateMachine with the publish parameter set to true.
HTTP Status Code: 409
CreateStateMachineAliasResult createStateMachineAlias(CreateStateMachineAliasRequest createStateMachineAliasRequest)
Creates an alias for a state machine that points to one or two versions of the same state machine. You can set your application to call StartExecution with an alias and update the version the alias uses without changing the client's code.
You can also map an alias to split StartExecution requests between two versions of a state machine. To do
this, add a second RoutingConfig object in the routingConfiguration parameter. You must
also specify the percentage of execution run requests each version should receive in both
RoutingConfig objects. Step Functions randomly chooses which version runs a given execution based on
the percentage you specify.
To create an alias that points to a single version, specify a single RoutingConfig object with a
weight set to 100.
You can create up to 100 aliases for each state machine. You must delete unused aliases using the DeleteStateMachineAlias API action.
CreateStateMachineAlias is an idempotent API. Step Functions bases the idempotency check on the
stateMachineArn, description, name, and routingConfiguration
parameters. Requests that contain the same values for these parameters return a successful idempotent response
without creating a duplicate resource.
Related operations:
createStateMachineAliasRequest - InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.InvalidNameException - The provided name is not valid.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.StateMachineDeletingException - The specified state machine is being deleted.ResourceNotFoundException - Could not find the referenced resource.ConflictException - Updating or deleting a resource can cause an inconsistent state. This error occurs when there're
concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or
UpdateStateMachine with the publish parameter set to true.
HTTP Status Code: 409
ServiceQuotaExceededException - The request would cause a service quota to be exceeded.
HTTP Status Code: 402
DeleteActivityResult deleteActivity(DeleteActivityRequest deleteActivityRequest)
Deletes an activity.
deleteActivityRequest - InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.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. A state machine is deleted only when all its executions
are completed. On the next state transition, the state machine's executions are terminated.
A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.
The following are some examples of qualified and unqualified state machine ARNs:
The following qualified state machine ARN refers to a Distributed Map state with a label
mapStateLabel in a state machine named myStateMachine.
arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails
with ValidationException.
The following unqualified state machine ARN refers to a state machine named myStateMachine.
arn:partition:states:region:account-id:stateMachine:myStateMachine
This API action also deletes all versions and aliases associated with a state machine.
For EXPRESS state machines, the deletion happens eventually (usually in less than a minute). Running
executions may emit logs after DeleteStateMachine API is called.
deleteStateMachineRequest - 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.DeleteStateMachineAliasResult deleteStateMachineAlias(DeleteStateMachineAliasRequest deleteStateMachineAliasRequest)
Deletes a state machine alias.
After you delete a state machine alias, you can't use it to start executions. When you delete a state machine alias, Step Functions doesn't delete the state machine versions that alias references.
Related operations:
deleteStateMachineAliasRequest - ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.ResourceNotFoundException - Could not find the referenced resource.ConflictException - Updating or deleting a resource can cause an inconsistent state. This error occurs when there're
concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or
UpdateStateMachine with the publish parameter set to true.
HTTP Status Code: 409
DeleteStateMachineVersionResult deleteStateMachineVersion(DeleteStateMachineVersionRequest deleteStateMachineVersionRequest)
Deletes a state machine version. After you delete a version, you can't call StartExecution using that version's ARN or use the version with a state machine alias.
Deleting a state machine version won't terminate its in-progress executions.
You can't delete a state machine version currently referenced by one or more aliases. Before you delete a version, you must either delete the aliases or update them to point to another state machine version.
Related operations:
deleteStateMachineVersionRequest - ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.ConflictException - Updating or deleting a resource can cause an inconsistent state. This error occurs when there're
concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or
UpdateStateMachine with the publish parameter set to true.
HTTP Status Code: 409
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.
describeActivityRequest - ActivityDoesNotExistException - The specified activity does not exist.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.DescribeExecutionResult describeExecution(DescribeExecutionRequest describeExecutionRequest)
Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. If you've redriven an execution, you can use this API action to return information about the redrives of that execution. In addition, you can use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was dispatched by a Map Run.
If you specify a version or alias ARN when you call the StartExecution API action,
DescribeExecution returns that ARN.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Executions of an EXPRESS state machine aren't supported by DescribeExecution unless a
Map Run dispatched them.
describeExecutionRequest - ExecutionDoesNotExistException - The specified execution does not exist.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.DescribeMapRunResult describeMapRun(DescribeMapRunRequest describeMapRunRequest)
Provides information about a Map Run's configuration, progress, and results. If you've redriven a Map Run, this API action also returns information about the redrives of that Map Run. For more information, see Examining Map Run in the Step Functions Developer Guide.
describeMapRunRequest - ResourceNotFoundException - Could not find the referenced resource.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.DescribeStateMachineResult describeStateMachine(DescribeStateMachineRequest describeStateMachineRequest)
Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration.
A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.
The following are some examples of qualified and unqualified state machine ARNs:
The following qualified state machine ARN refers to a Distributed Map state with a label
mapStateLabel in a state machine named myStateMachine.
arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails
with ValidationException.
The following qualified state machine ARN refers to an alias named PROD.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>
If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.
The following unqualified state machine ARN refers to a state machine named myStateMachine.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>
This API action returns the details for a state machine version if the stateMachineArn you specify
is a state machine version ARN.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
describeStateMachineRequest - InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.StateMachineDoesNotExistException - The specified state machine does not exist.DescribeStateMachineAliasResult describeStateMachineAlias(DescribeStateMachineAliasRequest describeStateMachineAliasRequest)
Returns details about a state machine alias.
Related operations:
describeStateMachineAliasRequest - ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.ResourceNotFoundException - Could not find the referenced resource.DescribeStateMachineForExecutionResult describeStateMachineForExecution(DescribeStateMachineForExecutionRequest describeStateMachineForExecutionRequest)
Provides information about a state machine's definition, its execution role ARN, and configuration. If a Map Run dispatched the execution, this action returns the Map Run Amazon Resource Name (ARN) in the response. The state machine returned is the state machine associated with the Map Run.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machines.
describeStateMachineForExecutionRequest - ExecutionDoesNotExistException - The specified execution does not exist.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.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.
getActivityTaskRequest - 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.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.
getExecutionHistoryRequest - ExecutionDoesNotExistException - The specified execution does not exist.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.InvalidTokenException - The provided token is not valid.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.
listActivitiesRequest - InvalidTokenException - The provided token is not valid.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. Using this API action, you can also list all redriven executions.
You can also provide a state machine alias ARN or version ARN to list the executions associated with a specific alias or version.
Results are sorted by time, with the most recent execution first.
If nextToken is returned, there are more results available. The value of nextToken is a
unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination
token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machines.
listExecutionsRequest - 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.StateMachineTypeNotSupportedExceptionValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException - Could not find the referenced resource.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.
listMapRunsRequest - ExecutionDoesNotExistException - The specified execution does not exist.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.InvalidTokenException - The provided token is not valid.ListStateMachineAliasesResult listStateMachineAliases(ListStateMachineAliasesRequest listStateMachineAliasesRequest)
Lists aliases for a specified state machine ARN. Results are sorted by time, with the most recently created aliases listed first.
To list aliases that reference a state machine version, you
can specify the version ARN in the stateMachineArn parameter.
If nextToken is returned, there are more results available. The value of nextToken is a
unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination
token will return an HTTP 400 InvalidToken error.
Related operations:
listStateMachineAliasesRequest - InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.InvalidTokenException - The provided token is not valid.ResourceNotFoundException - Could not find the referenced resource.StateMachineDoesNotExistException - The specified state machine does not exist.StateMachineDeletingException - The specified state machine is being deleted.ListStateMachineVersionsResult listStateMachineVersions(ListStateMachineVersionsRequest listStateMachineVersionsRequest)
Lists versions for the specified state machine Amazon Resource Name (ARN).
The results are sorted in descending order of the version creation time.
If nextToken is returned, there are more results available. The value of nextToken is a
unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination
token will return an HTTP 400 InvalidToken error.
Related operations:
listStateMachineVersionsRequest - ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.InvalidTokenException - The provided token is not valid.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.
listStateMachinesRequest - InvalidTokenException - The provided token is not valid.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List tags for a given resource.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
listTagsForResourceRequest - InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.ResourceNotFoundException - Could not find the referenced resource.PublishStateMachineVersionResult publishStateMachineVersion(PublishStateMachineVersionRequest publishStateMachineVersionRequest)
Creates a version from the current revision of a state machine. Use versions to create immutable snapshots of your state machine. You can start executions from versions either directly or with an alias. To create an alias, use CreateStateMachineAlias.
You can publish up to 1000 versions for each state machine. You must manually delete unused versions using the DeleteStateMachineVersion API action.
PublishStateMachineVersion is an idempotent API. It doesn't create a duplicate state machine version
if it already exists for the current revision. Step Functions bases PublishStateMachineVersion's
idempotency check on the stateMachineArn, name, and revisionId parameters.
Requests with the same parameters return a successful idempotent response. If you don't specify a
revisionId, Step Functions checks for a previously published version of the state machine's current
revision.
Related operations:
publishStateMachineVersionRequest - ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.StateMachineDeletingException - The specified state machine is being deleted.StateMachineDoesNotExistException - The specified state machine does not exist.ServiceQuotaExceededException - The request would cause a service quota to be exceeded.
HTTP Status Code: 402
ConflictException - Updating or deleting a resource can cause an inconsistent state. This error occurs when there're
concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or
UpdateStateMachine with the publish parameter set to true.
HTTP Status Code: 409
InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.RedriveExecutionResult redriveExecution(RedriveExecutionRequest redriveExecutionRequest)
Restarts unsuccessful executions of Standard workflows that didn't complete successfully in the last 14 days. These include failed, aborted, or timed out executions. When you redrive an execution, it continues the failed execution from the unsuccessful step and uses the same input. Step Functions preserves the results and execution history of the successful steps, and doesn't rerun these steps when you redrive an execution. Redriven executions use the same state machine definition and execution ARN as the original execution attempt.
For workflows that include an Inline Map
or Parallel
state, RedriveExecution API action reschedules and redrives only the iterations and branches
that failed or aborted.
To redrive a workflow that includes a Distributed Map state whose Map Run failed, you must redrive the parent workflow. The parent workflow redrives all the unsuccessful states, including a failed Map Run. If a Map Run was not started in the original execution attempt, the redriven parent workflow starts the Map Run.
This API action is not supported by EXPRESS state machines.
However, you can restart the unsuccessful executions of Express child workflows in a Distributed Map by redriving its Map Run. When you redrive a Map Run, the Express child workflows are rerun using the StartExecution API action. For more information, see Redriving Map Runs.
You can redrive executions if your original execution meets the following conditions:
The execution status isn't SUCCEEDED.
Your workflow execution has not exceeded the redrivable period of 14 days. Redrivable period refers to the time during which you can redrive a given execution. This period starts from the day a state machine completes its execution.
The workflow execution has not exceeded the maximum open time of one year. For more information about state machine quotas, see Quotas related to state machine executions.
The execution event history count is less than 24,999. Redriven executions append their event history to the
existing event history. Make sure your workflow execution contains less than 24,999 events to accommodate the
ExecutionRedriven history event and at least one other history event.
redriveExecutionRequest - ExecutionDoesNotExistException - The specified execution does not exist.ExecutionNotRedrivableException - The execution Amazon Resource Name (ARN) that you specified for executionArn cannot be
redriven.ExecutionLimitExceededException - The maximum number of running executions has been reached. Running executions must end or be stopped
before a new execution can be started.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.SendTaskFailureResult sendTaskFailure(SendTaskFailureRequest sendTaskFailureRequest)
Used by activity workers, Task states using the callback pattern, and optionally Task states using the job run
pattern to report that the task identified by the taskToken failed.
sendTaskFailureRequest - TaskDoesNotExistException - The activity does not exist.InvalidTokenException - The provided token is not valid.TaskTimedOutException - The task token has either expired or the task associated with the token has already been closed.SendTaskHeartbeatResult sendTaskHeartbeat(SendTaskHeartbeatRequest sendTaskHeartbeatRequest)
Used by activity workers and Task states using the callback pattern, and optionally Task states using the job run
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
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.
sendTaskHeartbeatRequest - TaskDoesNotExistException - The activity does not exist.InvalidTokenException - The provided token is not valid.TaskTimedOutException - The task token has either expired or the task associated with the token has already been closed.SendTaskSuccessResult sendTaskSuccess(SendTaskSuccessRequest sendTaskSuccessRequest)
Used by activity workers, Task states using the callback pattern, and optionally Task states using the job run
pattern to report that the task identified by the taskToken completed successfully.
sendTaskSuccessRequest - TaskDoesNotExistException - The activity does not exist.InvalidOutputException - The provided JSON output data is not valid.InvalidTokenException - The provided token is not valid.TaskTimedOutException - The task token has either expired or the task associated with the token has already been closed.StartExecutionResult startExecution(StartExecutionRequest startExecutionRequest)
Starts a state machine execution.
A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.
The following are some examples of qualified and unqualified state machine ARNs:
The following qualified state machine ARN refers to a Distributed Map state with a label
mapStateLabel in a state machine named myStateMachine.
arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails
with ValidationException.
The following qualified state machine ARN refers to an alias named PROD.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>
If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.
The following unqualified state machine ARN refers to a state machine named myStateMachine.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>
If you start an execution with an unqualified state machine ARN, Step Functions uses the latest revision of the state machine for the execution.
To start executions of a state machine version, call
StartExecution and provide the version ARN or the ARN of an alias that
points to the version.
StartExecution is idempotent for STANDARD workflows. For a STANDARD
workflow, if you call StartExecution with the same name and input as a running execution, the call
succeeds and return the same response as the original request. If the execution is closed or if the input is
different, it returns a 400 ExecutionAlreadyExists error. You can reuse names after 90 days.
StartExecution isn't idempotent for EXPRESS workflows.
startExecutionRequest - 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.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.
startSyncExecutionRequest - 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.StateMachineTypeNotSupportedExceptionStopExecutionResult stopExecution(StopExecutionRequest stopExecutionRequest)
Stops an execution.
This API action is not supported by EXPRESS state machines.
stopExecutionRequest - 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.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: _ . : / = + - @.
tagResourceRequest - InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.ResourceNotFoundException - Could not find the referenced resource.TooManyTagsException - You've exceeded the number of tags allowed for a resource. See the Limits Topic in the Step
Functions Developer Guide.TestStateResult testState(TestStateRequest testStateRequest)
Accepts the definition of a single state and executes it. You can test a state without creating a state machine or updating an existing state machine. Using this API, you can test the following:
A state's input and output processing data flow
An Amazon Web Services service integration request and response
An HTTP Task request and response
You can call this API on only one state at a time. The states that you can test include the following:
The TestState API assumes an IAM role which must contain the required IAM permissions for the
resources your state is accessing. For information about the permissions a state might need, see IAM
permissions to test a state.
The TestState API can run for up to five minutes. If the execution of a state exceeds this duration,
it fails with the States.Timeout error.
TestState doesn't support Activity tasks,
.sync or .waitForTaskToken service integration
patterns, Parallel, or Map states.
testStateRequest - InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.InvalidDefinitionException - The provided Amazon States Language definition is not valid.InvalidExecutionInputException - The provided JSON input data is not valid.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Remove a tag from a Step Functions resource
untagResourceRequest - InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.ResourceNotFoundException - Could not find the referenced 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.
updateMapRunRequest - ResourceNotFoundException - Could not find the referenced resource.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.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.
A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For
example, the qualified state machine ARN
arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a
Distributed Map state with a label mapStateLabel in the state machine named
stateMachineName.
A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.
The following are some examples of qualified and unqualified state machine ARNs:
The following qualified state machine ARN refers to a Distributed Map state with a label
mapStateLabel in a state machine named myStateMachine.
arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails
with ValidationException.
The following qualified state machine ARN refers to an alias named PROD.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>
If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.
The following unqualified state machine ARN refers to a state machine named myStateMachine.
arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>
After you update your state machine, you can set the publish parameter to true in the
same action to publish a new version. This
way, you can opt-in to strict versioning of your state machine.
Step Functions assigns monotonically increasing integers for state machine versions, starting at version number 1.
All StartExecution calls within a few seconds use the updated definition and
roleArn. Executions started immediately after you call UpdateStateMachine may use the
previous state machine definition and roleArn.
updateStateMachineRequest - InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.InvalidDefinitionException - The provided Amazon States Language definition is not valid.InvalidLoggingConfigurationExceptionInvalidTracingConfigurationException - Your tracingConfiguration key does not match, or enabled has not been set to
true or false.MissingRequiredParameterException - Request is missing a required parameter. This error occurs if both definition and
roleArn are not specified.StateMachineDeletingException - The specified state machine is being deleted.StateMachineDoesNotExistException - The specified state machine does not exist.ServiceQuotaExceededException - The request would cause a service quota to be exceeded.
HTTP Status Code: 402
ConflictException - Updating or deleting a resource can cause an inconsistent state. This error occurs when there're
concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or
UpdateStateMachine with the publish parameter set to true.
HTTP Status Code: 409
ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.UpdateStateMachineAliasResult updateStateMachineAlias(UpdateStateMachineAliasRequest updateStateMachineAliasRequest)
Updates the configuration of an existing state machine alias by
modifying its description or routingConfiguration.
You must specify at least one of the description or routingConfiguration parameters to
update a state machine alias.
UpdateStateMachineAlias is an idempotent API. Step Functions bases the idempotency check on the
stateMachineAliasArn, description, and routingConfiguration parameters.
Requests with the same parameters return an idempotent response.
This operation is eventually consistent. All StartExecution requests made within a few seconds use the
latest alias configuration. Executions started immediately after calling UpdateStateMachineAlias may
use the previous routing configuration.
Related operations:
updateStateMachineAliasRequest - ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.ResourceNotFoundException - Could not find the referenced resource.ConflictException - Updating or deleting a resource can cause an inconsistent state. This error occurs when there're
concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or
UpdateStateMachine with the publish parameter set to true.
HTTP Status Code: 409
StateMachineDeletingException - The specified state machine is being deleted.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request - The originally executed request.