* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.stepfunctions.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 . *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSStepFunctions { /** * 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 RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "states"; /** * 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 {@link 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. * * @param 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 use {@link AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)} for * example: * {@code builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));} */ @Deprecated void setEndpoint(String endpoint); /** * An alternative to {@link AWSStepFunctions#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 * {@link 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. * * @param region * The region this client will communicate with. See {@link 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 Region#getRegion(com.amazonaws.regions.Regions) * @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration) * @see Region#isServiceSupported(String) * @deprecated use {@link AwsClientBuilder#setRegion(String)} */ @Deprecated void setRegion(Region region); /** *
* 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.
*
* 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.
*
tracingConfiguration key does not match, or enabled has not been set to
* true or false.
* @throws StateMachineAlreadyExistsException
* A state machine with the same name but a different definition or role ARN already exists.
* @throws StateMachineDeletingException
* The specified state machine is being deleted.
* @throws StateMachineLimitExceededException
* The maximum number of state machines has been reached. Existing state machines must be deleted before a
* new state machine can be created.
* @throws StateMachineTypeNotSupportedException
* @throws TooManyTagsException
* You've exceeded the number of tags allowed for a resource. See the Limits Topic in the Step
* Functions Developer Guide.
* @throws ValidationException
* The input does not satisfy the constraints specified by an Amazon Web Services service.
* @throws 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 * @sample AWSStepFunctions.CreateStateMachine * @see AWS API * Documentation */ CreateStateMachineResult createStateMachine(CreateStateMachineRequest createStateMachineRequest); /** *
* 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: *
*publish parameter set to true.
* * HTTP Status Code: 409 * @throws ServiceQuotaExceededException * The request would cause a service quota to be exceeded. *
** HTTP Status Code: 402 * @sample AWSStepFunctions.CreateStateMachineAlias * @see AWS * API Documentation */ CreateStateMachineAliasResult createStateMachineAlias(CreateStateMachineAliasRequest createStateMachineAliasRequest); /** *
* Deletes an activity. *
* * @param deleteActivityRequest * @return Result of the DeleteActivity operation returned by the service. * @throws InvalidArnException * The provided Amazon Resource Name (ARN) is not valid. * @sample AWSStepFunctions.DeleteActivity * @see AWS API * Documentation */ DeleteActivityResult deleteActivity(DeleteActivityRequest deleteActivityRequest); /** *
* Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to
* DELETING and begins the deletion process.
*
* 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.
*
* 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: *
*publish parameter set to true.
* * HTTP Status Code: 409 * @sample AWSStepFunctions.DeleteStateMachineAlias * @see AWS * API Documentation */ DeleteStateMachineAliasResult deleteStateMachineAlias(DeleteStateMachineAliasRequest deleteStateMachineAliasRequest); /** *
* 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: *
*publish parameter set to true.
* * HTTP Status Code: 409 * @sample AWSStepFunctions.DeleteStateMachineVersion * @see AWS API Documentation */ DeleteStateMachineVersionResult deleteStateMachineVersion(DeleteStateMachineVersionRequest deleteStateMachineVersionRequest); /** *
* Describes an activity. *
** This operation is eventually consistent. The results are best effort and may not reflect very recent updates and * changes. *
** 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. 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 machinearen't supported by DescribeExecution unless a
* Map Run dispatched them.
*
* Provides information about a Map Run's configuration, progress, and results. For more information, see Examining Map Run * in the Step Functions Developer Guide. *
* * @param describeMapRunRequest * @return Result of the DescribeMapRun operation returned by the service. * @throws ResourceNotFoundException * Could not find the referenced resource. * @throws InvalidArnException * The provided Amazon Resource Name (ARN) is not valid. * @sample AWSStepFunctions.DescribeMapRun * @see AWS API * Documentation */ DescribeMapRunResult describeMapRun(DescribeMapRunRequest describeMapRunRequest); /** ** 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. *
** Returns details about a state machine alias. *
** Related operations: *
** 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.
*
* 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.
*
* 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.
*
* 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. *
** 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. *
** 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.
*
* 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.
*
* 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: *
** 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: *
** 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. *
** List tags for a given resource. *
*
* Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
*
* 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: *
*
* HTTP Status Code: 402
* @throws 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 * @throws InvalidArnException * The provided Amazon Resource Name (ARN) is not valid. * @sample AWSStepFunctions.PublishStateMachineVersion * @see AWS API Documentation */ PublishStateMachineVersionResult publishStateMachineVersion(PublishStateMachineVersionRequest publishStateMachineVersionRequest); /** *
* Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed.
*
* 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.
*
* Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken completed successfully.
*
* 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.
*
name as another execution (but a different input
* ).
* Executions with the same name and input are considered idempotent.
*
* 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. *
** Stops an execution. *
*
* This API action is not supported by EXPRESS state machines.
*
* 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: _ . : / = + - @.
*
* Remove a tag from a Step Functions resource *
* * @param untagResourceRequest * @return Result of the UntagResource operation returned by the service. * @throws InvalidArnException * The provided Amazon Resource Name (ARN) is not valid. * @throws ResourceNotFoundException * Could not find the referenced resource. * @sample AWSStepFunctions.UntagResource * @see AWS API * Documentation */ UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest); /** ** Updates an in-progress Map Run's configuration to include changes to the settings that control maximum * concurrency and Map Run failure. *
* * @param updateMapRunRequest * @return Result of the UpdateMapRun operation returned by the service. * @throws ResourceNotFoundException * Could not find the referenced resource. * @throws InvalidArnException * The provided Amazon Resource Name (ARN) is not valid. * @throws ValidationException * The input does not satisfy the constraints specified by an Amazon Web Services service. * @sample AWSStepFunctions.UpdateMapRun * @see AWS API * Documentation */ UpdateMapRunResult updateMapRun(UpdateMapRunRequest updateMapRunRequest); /** *
* 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.
*
tracingConfiguration key does not match, or enabled has not been set to
* true or false.
* @throws MissingRequiredParameterException
* Request is missing a required parameter. This error occurs if both definition and
* roleArn are not specified.
* @throws StateMachineDeletingException
* The specified state machine is being deleted.
* @throws StateMachineDoesNotExistException
* The specified state machine does not exist.
* @throws ServiceQuotaExceededException
* The request would cause a service quota to be exceeded.
*
* HTTP Status Code: 402
* @throws 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 * @throws ValidationException * The input does not satisfy the constraints specified by an Amazon Web Services service. * @sample AWSStepFunctions.UpdateStateMachine * @see AWS API * Documentation */ UpdateStateMachineResult updateStateMachine(UpdateStateMachineRequest updateStateMachineRequest); /** *
* 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: *
*publish parameter set to true.
* * HTTP Status Code: 409 * @sample AWSStepFunctions.UpdateStateMachineAlias * @see AWS * API Documentation */ UpdateStateMachineAliasResult updateStateMachineAlias(UpdateStateMachineAliasRequest updateStateMachineAliasRequest); /** * 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. */ void shutdown(); /** * 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. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }