AbstractAWSStepFunctions (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.stepfunctions.AbstractAWSStepFunctions

All Implemented Interfaces:

AWSStepFunctions

Direct Known Subclasses:

AbstractAWSStepFunctionsAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSStepFunctions
extends Object
implements AWSStepFunctions
```
Abstract implementation of AWSStepFunctions. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.stepfunctions.AWSStepFunctions
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateActivityResult`	`createActivity(CreateActivityRequest request)` Creates an activity.
`CreateStateMachineResult`	`createStateMachine(CreateStateMachineRequest request)` Creates a state machine.
`CreateStateMachineAliasResult`	`createStateMachineAlias(CreateStateMachineAliasRequest request)` Creates an alias for a state machine that points to one or two versions of the same state machine.
`DeleteActivityResult`	`deleteActivity(DeleteActivityRequest request)` Deletes an activity.
`DeleteStateMachineResult`	`deleteStateMachine(DeleteStateMachineRequest request)` Deletes a state machine.
`DeleteStateMachineAliasResult`	`deleteStateMachineAlias(DeleteStateMachineAliasRequest request)` Deletes a state machine alias.
`DeleteStateMachineVersionResult`	`deleteStateMachineVersion(DeleteStateMachineVersionRequest request)` Deletes a state machine version.
`DescribeActivityResult`	`describeActivity(DescribeActivityRequest request)` Describes an activity.
`DescribeExecutionResult`	`describeExecution(DescribeExecutionRequest request)` 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 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.
`DescribeStateMachineAliasResult`	`describeStateMachineAlias(DescribeStateMachineAliasRequest request)` Returns details about a state machine alias.
`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.
`ListStateMachineAliasesResult`	`listStateMachineAliases(ListStateMachineAliasesRequest request)` Lists aliases for a specified state machine ARN.
`ListStateMachinesResult`	`listStateMachines(ListStateMachinesRequest request)` Lists the existing state machines.
`ListStateMachineVersionsResult`	`listStateMachineVersions(ListStateMachineVersionsRequest request)` Lists versions for the specified state machine Amazon Resource Name (ARN).
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` List tags for a given resource.
`PublishStateMachineVersionResult`	`publishStateMachineVersion(PublishStateMachineVersionRequest request)` Creates a version from the current revision of a state machine.
`RedriveExecutionResult`	`redriveExecution(RedriveExecutionRequest request)` Restarts unsuccessful executions of Standard workflows that didn't complete successfully in the last 14 days.
`SendTaskFailureResult`	`sendTaskFailure(SendTaskFailureRequest request)` 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.
`SendTaskHeartbeatResult`	`sendTaskHeartbeat(SendTaskHeartbeatRequest request)` 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.
`SendTaskSuccessResult`	`sendTaskSuccess(SendTaskSuccessRequest request)` 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.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("states.us-east-1.amazonaws.com").
`void`	`setRegion(Region region)` An alternative to `AWSStepFunctions.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`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.
`TestStateResult`	`testState(TestStateRequest request)` Accepts the definition of a single state and executes it.
`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`, `loggingConfiguration`, or `EncryptionConfiguration`.
`UpdateStateMachineAliasResult`	`updateStateMachineAlias(UpdateStateMachineAliasRequest request)` Updates the configuration of an existing state machine alias by modifying its `description` or `routingConfiguration`.
`ValidateStateMachineDefinitionResult`	`validateStateMachineDefinition(ValidateStateMachineDefinitionRequest request)` Validates the syntax of a state machine definition.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AWSStepFunctions
    
    Overrides the default endpoint for this client ("states.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "states.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "states.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
    This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setEndpoint in interface AWSStepFunctions
    
    Parameters:
    
    endpoint - The endpoint (ex: "states.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "states.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AWSStepFunctions
    
    An alternative to 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 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.
    
    Specified by:
    
    setRegion in interface AWSStepFunctions
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - createActivity
```
public CreateActivityResult createActivity(CreateActivityRequest request)
```
    Description copied from interface: AWSStepFunctions
    
    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.
    
    Specified by:
    
    createActivity in interface AWSStepFunctions
    
    Returns:
    
    Result of the CreateActivity operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createStateMachine
```
public CreateStateMachineResult createStateMachine(CreateStateMachineRequest request)
```
    Description copied from interface: AWSStepFunctions
    
    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.
    
    For additional control over security, you can encrypt your data using a customer-managed key for Step Functions state machines. You can configure a symmetric KMS key and data key reuse period when creating or updating a State Machine. The execution history and state machine definition will be encrypted with the key applied to 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, TracingConfiguration, and EncryptionConfiguration 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.
    
    Specified by:
    
    createStateMachine in interface AWSStepFunctions
    
    Returns:
    
    Result of the CreateStateMachine operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createStateMachineAlias
```
public CreateStateMachineAliasResult createStateMachineAlias(CreateStateMachineAliasRequest request)
```
    Description copied from interface: AWSStepFunctions
    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:
    Specified by:
    
    createStateMachineAlias in interface AWSStepFunctions
    
    Returns:
    
    Result of the CreateStateMachineAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteActivity
```
public DeleteActivityResult deleteActivity(DeleteActivityRequest request)
```
    Description copied from interface: AWSStepFunctions
    
    Deletes an activity.
    
    Specified by:
    
    deleteActivity in interface AWSStepFunctions
    
    Returns:
    
    Result of the DeleteActivity operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteStateMachine
```
public DeleteStateMachineResult deleteStateMachine(DeleteStateMachineRequest request)
```
    Description copied from interface: AWSStepFunctions
    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.
    Specified by:
    
    deleteStateMachine in interface AWSStepFunctions
    
    Returns:
    
    Result of the DeleteStateMachine operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteStateMachineAlias
```
public DeleteStateMachineAliasResult deleteStateMachineAlias(DeleteStateMachineAliasRequest request)
```
    Description copied from interface: AWSStepFunctions
    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:
    Specified by:
    
    deleteStateMachineAlias in interface AWSStepFunctions
    
    Returns:
    
    Result of the DeleteStateMachineAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteStateMachineVersion
```
public DeleteStateMachineVersionResult deleteStateMachineVersion(DeleteStateMachineVersionRequest request)
```
    Description copied from interface: AWSStepFunctions
    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:
    - PublishStateMachineVersion
    - ListStateMachineVersions
    Specified by:
    
    deleteStateMachineVersion in interface AWSStepFunctions
    
    Returns:
    
    Result of the DeleteStateMachineVersion operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeActivity
```
public DescribeActivityResult describeActivity(DescribeActivityRequest request)
```
    Description copied from interface: AWSStepFunctions
    
    Describes an activity.
    
    This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
    
    Specified by:
    
    describeActivity in interface AWSStepFunctions
    
    Returns:
    
    Result of the DescribeActivity operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeExecution
```
public DescribeExecutionResult describeExecution(DescribeExecutionRequest request)
```
    Description copied from interface: AWSStepFunctions
    
    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.
    
    Specified by:
    
    describeExecution in interface AWSStepFunctions
    
    Returns:
    
    Result of the DescribeExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeMapRun
```
public DescribeMapRunResult describeMapRun(DescribeMapRunRequest request)
```
    Description copied from interface: AWSStepFunctions
    
    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.
    
    Specified by:
    
    describeMapRun in interface AWSStepFunctions
    
    Returns:
    
    Result of the DescribeMapRun operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeStateMachine
```
public DescribeStateMachineResult describeStateMachine(DescribeStateMachineRequest request)
```
    Description copied from interface: AWSStepFunctions
    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.
    Specified by:
    
    describeStateMachine in interface AWSStepFunctions
    
    Returns:
    
    Result of the DescribeStateMachine operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeStateMachineAlias
```
public DescribeStateMachineAliasResult describeStateMachineAlias(DescribeStateMachineAliasRequest request)
```
    Description copied from interface: AWSStepFunctions
    Returns details about a state machine alias.
    
    Related operations:
    Specified by:
    
    describeStateMachineAlias in interface AWSStepFunctions
    
    Returns:
    
    Result of the DescribeStateMachineAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeStateMachineForExecution
```
public DescribeStateMachineForExecutionResult describeStateMachineForExecution(DescribeStateMachineForExecutionRequest request)
```
    Description copied from interface: AWSStepFunctions
    
    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.
    
    Specified by:
    
    describeStateMachineForExecution in interface AWSStepFunctions
    
    Returns:
    
    Result of the DescribeStateMachineForExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getActivityTask
```
public GetActivityTaskResult getActivityTask(GetActivityTaskRequest request)
```
    Description copied from interface: AWSStepFunctions
    
    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.
    
    Specified by:
    
    getActivityTask in interface AWSStepFunctions
    
    Returns:
    
    Result of the GetActivityTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getExecutionHistory
```
public GetExecutionHistoryResult getExecutionHistory(GetExecutionHistoryRequest request)
```
    Description copied from interface: AWSStepFunctions
    
    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.
    
    Specified by:
    
    getExecutionHistory in interface AWSStepFunctions
    
    Returns:
    
    Result of the GetExecutionHistory operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listActivities
```
public ListActivitiesResult listActivities(ListActivitiesRequest request)
```
    Description copied from interface: AWSStepFunctions
    
    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.
    
    Specified by:
    
    listActivities in interface AWSStepFunctions
    
    Returns:
    
    Result of the ListActivities operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listExecutions
```
public ListExecutionsResult listExecutions(ListExecutionsRequest request)
```
    Description copied from interface: AWSStepFunctions
    
    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.
    
    Specified by:
    
    listExecutions in interface AWSStepFunctions
    
    Returns:
    
    Result of the ListExecutions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listMapRuns
```
public ListMapRunsResult listMapRuns(ListMapRunsRequest request)
```
    Description copied from interface: AWSStepFunctions
    
    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.
    
    Specified by:
    
    listMapRuns in interface AWSStepFunctions
    
    Returns:
    
    Result of the ListMapRuns operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listStateMachineAliases
```
public ListStateMachineAliasesResult listStateMachineAliases(ListStateMachineAliasesRequest request)
```
    Description copied from interface: AWSStepFunctions
    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:
    Specified by:
    
    listStateMachineAliases in interface AWSStepFunctions
    
    Returns:
    
    Result of the ListStateMachineAliases operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listStateMachineVersions
```
public ListStateMachineVersionsResult listStateMachineVersions(ListStateMachineVersionsRequest request)
```
    Description copied from interface: AWSStepFunctions
    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:
    - PublishStateMachineVersion
    - DeleteStateMachineVersion
    Specified by:
    
    listStateMachineVersions in interface AWSStepFunctions
    
    Returns:
    
    Result of the ListStateMachineVersions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listStateMachines
```
public ListStateMachinesResult listStateMachines(ListStateMachinesRequest request)
```
    Description copied from interface: AWSStepFunctions
    
    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.
    
    Specified by:
    
    listStateMachines in interface AWSStepFunctions
    
    Returns:
    
    Result of the ListStateMachines operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AWSStepFunctions
    
    List tags for a given resource.
    
    Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
    
    Specified by:
    
    listTagsForResource in interface AWSStepFunctions
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - publishStateMachineVersion
```
public PublishStateMachineVersionResult publishStateMachineVersion(PublishStateMachineVersionRequest request)
```
    Description copied from interface: AWSStepFunctions
    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:
    - DeleteStateMachineVersion
    - ListStateMachineVersions
    Specified by:
    
    publishStateMachineVersion in interface AWSStepFunctions
    
    Returns:
    
    Result of the PublishStateMachineVersion operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - redriveExecution
```
public RedriveExecutionResult redriveExecution(RedriveExecutionRequest request)
```
    Description copied from interface: AWSStepFunctions
    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.
    Specified by:
    
    redriveExecution in interface AWSStepFunctions
    
    Returns:
    
    Result of the RedriveExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - sendTaskFailure
```
public SendTaskFailureResult sendTaskFailure(SendTaskFailureRequest request)
```
    Description copied from interface: AWSStepFunctions
    
    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.
    
    For an execution with encryption enabled, Step Functions will encrypt the error and cause fields using the KMS key for the execution role.
    
    A caller can mark a task as fail without using any KMS permissions in the execution role if the caller provides a null value for both error and cause fields because no data needs to be encrypted.
    
    Specified by:
    
    sendTaskFailure in interface AWSStepFunctions
    
    Returns:
    
    Result of the SendTaskFailure operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - sendTaskHeartbeat
```
public SendTaskHeartbeatResult sendTaskHeartbeat(SendTaskHeartbeatRequest request)
```
    Description copied from interface: AWSStepFunctions
    
    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.
    
    Specified by:
    
    sendTaskHeartbeat in interface AWSStepFunctions
    
    Returns:
    
    Result of the SendTaskHeartbeat operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - sendTaskSuccess
```
public SendTaskSuccessResult sendTaskSuccess(SendTaskSuccessRequest request)
```
    Description copied from interface: AWSStepFunctions
    
    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.
    
    Specified by:
    
    sendTaskSuccess in interface AWSStepFunctions
    
    Returns:
    
    Result of the SendTaskSuccess operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startExecution
```
public StartExecutionResult startExecution(StartExecutionRequest request)
```
    Description copied from interface: AWSStepFunctions
    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.
    Specified by:
    
    startExecution in interface AWSStepFunctions
    
    Returns:
    
    Result of the StartExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startSyncExecution
```
public StartSyncExecutionResult startSyncExecution(StartSyncExecutionRequest request)
```
    Description copied from interface: AWSStepFunctions
    
    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.
    
    Specified by:
    
    startSyncExecution in interface AWSStepFunctions
    
    Returns:
    
    Result of the StartSyncExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopExecution
```
public StopExecutionResult stopExecution(StopExecutionRequest request)
```
    Description copied from interface: AWSStepFunctions
    
    Stops an execution.
    
    This API action is not supported by EXPRESS state machines.
    
    For an execution with encryption enabled, Step Functions will encrypt the error and cause fields using the KMS key for the execution role.
    
    A caller can stop an execution without using any KMS permissions in the execution role if the caller provides a null value for both error and cause fields because no data needs to be encrypted.
    
    Specified by:
    
    stopExecution in interface AWSStepFunctions
    
    Returns:
    
    Result of the StopExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AWSStepFunctions
    
    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: _ . : / = + - @.
    
    Specified by:
    
    tagResource in interface AWSStepFunctions
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - testState
```
public TestStateResult testState(TestStateRequest request)
```
    Description copied from interface: AWSStepFunctions
    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:
    - All Task types except Activity
    - Pass
    - Wait
    - Choice
    - Succeed
    - Fail
    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.
    Specified by:
    
    testState in interface AWSStepFunctions
    
    Returns:
    
    Result of the TestState operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AWSStepFunctions
    
    Remove a tag from a Step Functions resource
    
    Specified by:
    
    untagResource in interface AWSStepFunctions
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateMapRun
```
public UpdateMapRunResult updateMapRun(UpdateMapRunRequest request)
```
    Description copied from interface: AWSStepFunctions
    
    Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure.
    
    Specified by:
    
    updateMapRun in interface AWSStepFunctions
    
    Returns:
    
    Result of the UpdateMapRun operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateStateMachine
```
public UpdateStateMachineResult updateStateMachine(UpdateStateMachineRequest request)
```
    Description copied from interface: AWSStepFunctions
    Updates an existing state machine by modifying its definition, roleArn, loggingConfiguration, or EncryptionConfiguration. 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.
    Specified by:
    
    updateStateMachine in interface AWSStepFunctions
    
    Returns:
    
    Result of the UpdateStateMachine operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateStateMachineAlias
```
public UpdateStateMachineAliasResult updateStateMachineAlias(UpdateStateMachineAliasRequest request)
```
    Description copied from interface: AWSStepFunctions
    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:
    Specified by:
    
    updateStateMachineAlias in interface AWSStepFunctions
    
    Returns:
    
    Result of the UpdateStateMachineAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - validateStateMachineDefinition
```
public ValidateStateMachineDefinitionResult validateStateMachineDefinition(ValidateStateMachineDefinitionRequest request)
```
    Description copied from interface: AWSStepFunctions
    Validates the syntax of a state machine definition.
    
    You can validate that a state machine definition is correct without creating a state machine resource. Step Functions will implicitly perform the same syntax check when you invoke CreateStateMachine and UpdateStateMachine. State machine definitions are specified using a JSON-based, structured language. For more information on Amazon States Language see Amazon States Language (ASL).
    
    Suggested uses for ValidateStateMachineDefinition:
    - Integrate automated checks into your code review or Continuous Integration (CI) process to validate state machine definitions before starting deployments.
    - Run the validation from a Git pre-commit hook to check your state machine definitions before committing them to your source repository.
    Errors found in the state machine definition will be returned in the response as a list of diagnostic elements, rather than raise an exception.
    Specified by:
    
    validateStateMachineDefinition in interface AWSStepFunctions
    
    Returns:
    
    Result of the ValidateStateMachineDefinition operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSStepFunctions
    
    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.
    
    Specified by:
    
    shutdown in interface AWSStepFunctions
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSStepFunctions
    
    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.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSStepFunctions
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

AWS SDK for Java 1.x API Reference - 1.12.779

Class AbstractAWSStepFunctions

Field Summary

Fields inherited from interface com.amazonaws.services.stepfunctions.AWSStepFunctions

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

createActivity

createStateMachine

createStateMachineAlias

deleteActivity

deleteStateMachine

deleteStateMachineAlias

deleteStateMachineVersion

describeActivity

describeExecution

describeMapRun

describeStateMachine

describeStateMachineAlias

describeStateMachineForExecution

getActivityTask

getExecutionHistory

listActivities

listExecutions

listMapRuns

listStateMachineAliases

listStateMachineVersions

listStateMachines

listTagsForResource

publishStateMachineVersion

redriveExecution

sendTaskFailure

sendTaskHeartbeat

sendTaskSuccess

startExecution

startSyncExecution

stopExecution

tagResource

testState

untagResource

updateMapRun

updateStateMachine

updateStateMachineAlias

validateStateMachineDefinition

shutdown

getCachedResponseMetadata