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.
`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)` Describes an execution.
`DescribeStateMachineResult`	`describeStateMachine(DescribeStateMachineRequest request)` Describes a state machine.
`DescribeStateMachineForExecutionResult`	`describeStateMachineForExecution(DescribeStateMachineForExecutionRequest request)` Describes the state machine associated with a specific execution.
`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 the executions of a state machine that meet the filtering criteria.
`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`	`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.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Remove a tag from a Step Functions resource
`UpdateStateMachineResult`	`updateStateMachine(UpdateStateMachineRequest request)` Updates an existing state machine by modifying its `definition`, `roleArn`, or `loggingConfiguration`.

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 AWS 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 AWS 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.
    
    Specified by:
    
    createStateMachine in interface AWSStepFunctions
    
    Returns:
    
    Result of the CreateStateMachine 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.
    
    For EXPRESSstate machines, the deletion will happen eventually (usually 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
  - 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
    
    Describes an execution.
    
    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:
    
    describeExecution in interface AWSStepFunctions
    
    Returns:
    
    Result of the DescribeExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeStateMachine
```
public DescribeStateMachineResult describeStateMachine(DescribeStateMachineRequest request)
```
    Description copied from interface: AWSStepFunctions
    
    Describes a state machine.
    
    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
  - describeStateMachineForExecution
```
public DescribeStateMachineForExecutionResult describeStateMachineForExecution(DescribeStateMachineForExecutionRequest request)
```
    Description copied from interface: AWSStepFunctions
    
    Describes the state machine associated with a specific execution.
    
    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.
    
    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 the executions of a state machine that meet the filtering criteria. 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
  - 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
  - sendTaskFailure
```
public SendTaskFailureResult sendTaskFailure(SendTaskFailureRequest request)
```
    Description copied from interface: AWSStepFunctions
    
    Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed.
    
    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 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.
    
    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 and task states using the callback 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.
    
    StartExecution is idempotent. 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.
    
    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.
    
    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.
    
    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 AWS 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
  - 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
  - updateStateMachine
```
public UpdateStateMachineResult updateStateMachine(UpdateStateMachineRequest request)
```
    Description copied from interface: AWSStepFunctions
    
    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.
    
    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.
    
    Specified by:
    
    updateStateMachine in interface AWSStepFunctions
    
    Returns:
    
    Result of the UpdateStateMachine 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.

Did this page help you?

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

deleteActivity

deleteStateMachine

describeActivity

describeExecution

describeStateMachine

describeStateMachineForExecution

getActivityTask

getExecutionHistory

listActivities

listExecutions

listStateMachines

listTagsForResource

sendTaskFailure

sendTaskHeartbeat

sendTaskSuccess

startExecution

startSyncExecution

stopExecution

tagResource

untagResource

updateStateMachine

shutdown

getCachedResponseMetadata