@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSStepFunctionsClient extends AmazonWebServiceClient implements AWSStepFunctions
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 .
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AWSStepFunctionsClient()
Deprecated.
|
AWSStepFunctionsClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSStepFunctionsClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AWSStepFunctionsClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AWSStepFunctionsClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSStepFunctionsClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSStepFunctionsClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AWSStepFunctionsClient(ClientConfiguration clientConfiguration)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static AWSStepFunctionsClientBuilder |
builder() |
CreateActivityResult |
createActivity(CreateActivityRequest request)
Creates an activity.
|
CreateStateMachineResult |
createStateMachine(CreateStateMachineRequest request)
Creates a state machine.
|
DeleteActivityResult |
deleteActivity(DeleteActivityRequest request)
Deletes an activity.
|
DeleteStateMachineResult |
deleteStateMachine(DeleteStateMachineRequest request)
Deletes a state machine.
|
DescribeActivityResult |
describeActivity(DescribeActivityRequest request)
Describes an activity.
|
DescribeExecutionResult |
describeExecution(DescribeExecutionRequest request)
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 request)
Provides information about a Map Run's configuration, progress, and results.
|
DescribeStateMachineResult |
describeStateMachine(DescribeStateMachineRequest request)
Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and
configuration.
|
DescribeStateMachineForExecutionResult |
describeStateMachineForExecution(DescribeStateMachineForExecutionRequest request)
Provides information about a state machine's definition, its execution role ARN, and configuration.
|
GetActivityTaskResult |
getActivityTask(GetActivityTaskRequest request)
Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a
running state machine.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetExecutionHistoryResult |
getExecutionHistory(GetExecutionHistoryRequest request)
Returns the history of the specified execution as a list of events.
|
ListActivitiesResult |
listActivities(ListActivitiesRequest request)
Lists the existing activities.
|
ListExecutionsResult |
listExecutions(ListExecutionsRequest request)
Lists all executions of a state machine or a Map Run.
|
ListMapRunsResult |
listMapRuns(ListMapRunsRequest request)
Lists all Map Runs that were started by a given state machine execution.
|
ListStateMachinesResult |
listStateMachines(ListStateMachinesRequest request)
Lists the existing state machines.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
List tags for a given resource.
|
SendTaskFailureResult |
sendTaskFailure(SendTaskFailureRequest request)
Used by activity workers and task states using the callback pattern to report that the task identified by the
taskToken failed. |
SendTaskHeartbeatResult |
sendTaskHeartbeat(SendTaskHeartbeatRequest request)
Used by activity workers and task states using the callback pattern to report to Step Functions that the task represented by the specified
taskToken is still making progress. |
SendTaskSuccessResult |
sendTaskSuccess(SendTaskSuccessRequest request)
Used by activity workers and task states using the callback pattern to report that the task identified by the
taskToken completed successfully. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartExecutionResult |
startExecution(StartExecutionRequest request)
Starts a state machine execution.
|
StartSyncExecutionResult |
startSyncExecution(StartSyncExecutionRequest request)
Starts a Synchronous Express state machine execution.
|
StopExecutionResult |
stopExecution(StopExecutionRequest request)
Stops an execution.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Add a tag to a Step Functions resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Remove a tag from a Step Functions resource
|
UpdateMapRunResult |
updateMapRun(UpdateMapRunRequest request)
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 request)
Updates an existing state machine by modifying its
definition, roleArn, or
loggingConfiguration. |
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion@Deprecated public AWSStepFunctionsClient()
AWSStepFunctionsClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AWSStepFunctionsClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client connects to AWS SFN (ex: proxy settings,
retry counts, etc.).DefaultAWSCredentialsProviderChain@Deprecated public AWSStepFunctionsClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSStepFunctionsClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AWSStepFunctionsClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).@Deprecated public AWSStepFunctionsClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AWSStepFunctionsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).@Deprecated public AWSStepFunctionsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)All service calls made using this new client object are blocking, and will not return until the service call completes.
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 collectorpublic static AWSStepFunctionsClientBuilder builder()
public CreateActivityResult createActivity(CreateActivityRequest request)
Creates an activity. An activity is a task that you write in any programming language and host on any machine
that has access to 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.
createActivity in interface AWSStepFunctionscreateActivityRequest - 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.public CreateStateMachineResult createStateMachine(CreateStateMachineRequest request)
Creates a state machine. A state machine consists of a collection of states that can do work (Task
states), determine to which states to transition next (Choice states), stop an execution with an
error (Fail states), and so on. State machines are specified using a JSON-based, structured
language. For more information, see Amazon States
Language in the 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.
createStateMachine in interface AWSStepFunctionscreateStateMachineRequest - 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.public DeleteActivityResult deleteActivity(DeleteActivityRequest request)
Deletes an activity.
deleteActivity in interface AWSStepFunctionsdeleteActivityRequest - InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.public DeleteStateMachineResult deleteStateMachine(DeleteStateMachineRequest request)
Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to
DELETING and begins the deletion process.
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.
deleteStateMachine in interface AWSStepFunctionsdeleteStateMachineRequest - 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.public DescribeActivityResult describeActivity(DescribeActivityRequest request)
Describes an activity.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
describeActivity in interface AWSStepFunctionsdescribeActivityRequest - ActivityDoesNotExistException - The specified activity does not exist.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.public DescribeExecutionResult describeExecution(DescribeExecutionRequest request)
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.
describeExecution in interface AWSStepFunctionsdescribeExecutionRequest - ExecutionDoesNotExistException - The specified execution does not exist.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.public DescribeMapRunResult describeMapRun(DescribeMapRunRequest request)
Provides information about a Map Run's configuration, progress, and results. For more information, see Examining Map Run in the Step Functions Developer Guide.
describeMapRun in interface AWSStepFunctionsdescribeMapRunRequest - 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.public DescribeStateMachineResult describeStateMachine(DescribeStateMachineRequest request)
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.
describeStateMachine in interface AWSStepFunctionsdescribeStateMachineRequest - InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.StateMachineDoesNotExistException - The specified state machine does not exist.public DescribeStateMachineForExecutionResult describeStateMachineForExecution(DescribeStateMachineForExecutionRequest request)
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.
describeStateMachineForExecution in interface AWSStepFunctionsdescribeStateMachineForExecutionRequest - ExecutionDoesNotExistException - The specified execution does not exist.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.public GetActivityTaskResult getActivityTask(GetActivityTaskRequest request)
Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a
running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds
as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the
service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the
poll returns a taskToken with a null string.
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.
getActivityTask in interface AWSStepFunctionsgetActivityTaskRequest - 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.public GetExecutionHistoryResult getExecutionHistory(GetExecutionHistoryRequest request)
Returns the history of the specified execution as a list of events. By default, the results are returned in
ascending order of the timeStamp of the events. Use the reverseOrder parameter to get
the latest events first.
If nextToken is returned, there are more results available. The value of nextToken is a
unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination
token will return an HTTP 400 InvalidToken error.
This API action is not supported by EXPRESS state machines.
getExecutionHistory in interface AWSStepFunctionsgetExecutionHistoryRequest - ExecutionDoesNotExistException - The specified execution does not exist.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.InvalidTokenException - The provided token is not valid.public ListActivitiesResult listActivities(ListActivitiesRequest request)
Lists the existing activities.
If nextToken is returned, there are more results available. The value of nextToken is a
unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination
token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
listActivities in interface AWSStepFunctionslistActivitiesRequest - InvalidTokenException - The provided token is not valid.public ListExecutionsResult listExecutions(ListExecutionsRequest request)
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.
listExecutions in interface AWSStepFunctionslistExecutionsRequest - 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. Only state machine and activity ARNs are supported.public ListMapRunsResult listMapRuns(ListMapRunsRequest request)
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.
listMapRuns in interface AWSStepFunctionslistMapRunsRequest - ExecutionDoesNotExistException - The specified execution does not exist.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.InvalidTokenException - The provided token is not valid.public ListStateMachinesResult listStateMachines(ListStateMachinesRequest request)
Lists the existing state machines.
If nextToken is returned, there are more results available. The value of nextToken is a
unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination
token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
listStateMachines in interface AWSStepFunctionslistStateMachinesRequest - InvalidTokenException - The provided token is not valid.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
List tags for a given resource.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
listTagsForResource in interface AWSStepFunctionslistTagsForResourceRequest - 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.public SendTaskFailureResult sendTaskFailure(SendTaskFailureRequest request)
Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed.
sendTaskFailure in interface AWSStepFunctionssendTaskFailureRequest - TaskDoesNotExistExceptionInvalidTokenException - The provided token is not valid.TaskTimedOutExceptionpublic SendTaskHeartbeatResult sendTaskHeartbeat(SendTaskHeartbeatRequest request)
Used by activity workers and task states using the callback pattern to report to Step Functions that the task represented by the specified
taskToken is still making progress. This action resets the Heartbeat clock. The
Heartbeat threshold is specified in the state machine's Amazon States Language definition (
HeartbeatSeconds). This action does not in itself create an event in the execution history. However,
if the task times out, the execution history contains an ActivityTimedOut entry for activities, or a
TaskTimedOut entry for for tasks using the job run or
callback pattern.
The Timeout of a task, defined in the state machine's Amazon States Language definition, is its
maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received. Use
HeartbeatSeconds to configure the timeout interval for heartbeats.
sendTaskHeartbeat in interface AWSStepFunctionssendTaskHeartbeatRequest - TaskDoesNotExistExceptionInvalidTokenException - The provided token is not valid.TaskTimedOutExceptionpublic SendTaskSuccessResult sendTaskSuccess(SendTaskSuccessRequest request)
Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken completed successfully.
sendTaskSuccess in interface AWSStepFunctionssendTaskSuccessRequest - TaskDoesNotExistExceptionInvalidOutputException - The provided JSON output data is not valid.InvalidTokenException - The provided token is not valid.TaskTimedOutExceptionpublic StartExecutionResult startExecution(StartExecutionRequest request)
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.
startExecution in interface AWSStepFunctionsstartExecutionRequest - 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.public StartSyncExecutionResult startSyncExecution(StartSyncExecutionRequest request)
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.
startSyncExecution in interface AWSStepFunctionsstartSyncExecutionRequest - 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.StateMachineTypeNotSupportedExceptionpublic StopExecutionResult stopExecution(StopExecutionRequest request)
Stops an execution.
This API action is not supported by EXPRESS state machines.
stopExecution in interface AWSStepFunctionsstopExecutionRequest - 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.public TagResourceResult tagResource(TagResourceRequest request)
Add a tag to a Step Functions resource.
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the 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: _ . : / = + - @.
tagResource in interface AWSStepFunctionstagResourceRequest - 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.public UntagResourceResult untagResource(UntagResourceRequest request)
Remove a tag from a Step Functions resource
untagResource in interface AWSStepFunctionsuntagResourceRequest - 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.public UpdateMapRunResult updateMapRun(UpdateMapRunRequest request)
Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure.
updateMapRun in interface AWSStepFunctionsupdateMapRunRequest - 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.public UpdateStateMachineResult updateStateMachine(UpdateStateMachineRequest request)
Updates an existing state machine by modifying its definition, roleArn, or
loggingConfiguration. Running executions will continue to use the previous definition
and roleArn. You must include at least one of definition or roleArn or you
will receive a MissingRequiredParameter error.
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.
updateStateMachine in interface AWSStepFunctionsupdateStateMachineRequest - 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.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.public 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 the request.
getCachedResponseMetadata in interface AWSStepFunctionsrequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AWSStepFunctionsshutdown in class AmazonWebServiceClient