@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSStepFunctionsClient extends AmazonWebServiceClient implements AWSStepFunctions
AWS 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 AWS, your own servers, or any system that has access to AWS. You can access and use Step Functions using the console, the AWS SDKs, or an HTTP API. For more information about Step Functions, see the AWS Step Functions Developer Guide .
Modifier and Type | Field and Description |
---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to this client
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
ENDPOINT_PREFIX
Constructor and Description |
---|
AWSStepFunctionsClient()
Deprecated.
|
AWSStepFunctionsClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSStepFunctionsClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AWSStepFunctionsClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AWSStepFunctionsClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSStepFunctionsClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSStepFunctionsClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AWSStepFunctionsClient(ClientConfiguration clientConfiguration)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static AWSStepFunctionsClientBuilder |
builder() |
CreateActivityResult |
createActivity(CreateActivityRequest request)
Creates an activity.
|
CreateStateMachineResult |
createStateMachine(CreateStateMachineRequest request)
Creates a state machine.
|
DeleteActivityResult |
deleteActivity(DeleteActivityRequest request)
Deletes an activity.
|
DeleteStateMachineResult |
deleteStateMachine(DeleteStateMachineRequest request)
Deletes a state machine.
|
DescribeActivityResult |
describeActivity(DescribeActivityRequest request)
Describes an activity.
|
DescribeExecutionResult |
describeExecution(DescribeExecutionRequest request)
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.
|
SendTaskFailureResult |
sendTaskFailure(SendTaskFailureRequest request)
Used by workers to report that the task identified by the
taskToken failed. |
SendTaskHeartbeatResult |
sendTaskHeartbeat(SendTaskHeartbeatRequest request)
Used by workers to report to the service that the task represented by the specified
taskToken is
still making progress. |
SendTaskSuccessResult |
sendTaskSuccess(SendTaskSuccessRequest request)
Used by workers to report that the task identified by the
taskToken completed successfully. |
StartExecutionResult |
startExecution(StartExecutionRequest request)
Starts a state machine execution.
|
StopExecutionResult |
stopExecution(StopExecutionRequest request)
Stops an execution.
|
UpdateStateMachineResult |
updateStateMachine(UpdateStateMachineRequest request)
Updates an existing state machine by modifying its
definition and/or roleArn . |
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
protected static final ClientConfigurationFactory configFactory
@Deprecated public AWSStepFunctionsClient()
AWSStepFunctionsClientBuilder.defaultClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
@Deprecated public AWSStepFunctionsClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client connects to AWS SFN (ex: proxy settings,
retry counts, etc.).DefaultAWSCredentialsProviderChain
@Deprecated public AWSStepFunctionsClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
for example:
AWSStepFunctionsClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AWSStepFunctionsClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to AWS SFN (ex: proxy settings,
retry counts, etc.).@Deprecated public AWSStepFunctionsClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AWSStepFunctionsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to AWS SFN (ex: proxy settings,
retry counts, etc.).@Deprecated public AWSStepFunctionsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to AWS SFN (ex: proxy settings,
retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic static AWSStepFunctionsClientBuilder builder()
public CreateActivityResult createActivity(CreateActivityRequest request)
Creates an activity. An activity is a task which you write in any programming language and host on any machine
which 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.
createActivity
in interface AWSStepFunctions
createActivityRequest
- ActivityLimitExceededException
- The maximum number of activities has been reached. Existing activities must be deleted before a new
activity can be created.InvalidNameException
- The provided name is invalid.public CreateStateMachineResult createStateMachine(CreateStateMachineRequest request)
Creates a state machine. A state machine consists of a collection of states that can do work (Task
states), determine to which states to transition next (Choice
states), stop an execution with an
error (Fail
states), and so on. State machines are specified using a JSON-based, structured
language.
createStateMachine
in interface AWSStepFunctions
createStateMachineRequest
- InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.InvalidDefinitionException
- The provided Amazon States Language definition is invalid.InvalidNameException
- The provided name is invalid.StateMachineAlreadyExistsException
- A state machine with the same name but a different definition or role ARN already exists.StateMachineDeletingException
- The specified state machine is being deleted.StateMachineLimitExceededException
- The maximum number of state machines has been reached. Existing state machines must be deleted before a
new state machine can be created.public DeleteActivityResult deleteActivity(DeleteActivityRequest request)
Deletes an activity.
deleteActivity
in interface AWSStepFunctions
deleteActivityRequest
- InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.public DeleteStateMachineResult deleteStateMachine(DeleteStateMachineRequest request)
Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to
DELETING
and begins the deletion process. Each state machine execution is deleted the next time it
makes a state transition.
The state machine itself is deleted after all executions are completed or deleted.
deleteStateMachine
in interface AWSStepFunctions
deleteStateMachineRequest
- InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.public DescribeActivityResult describeActivity(DescribeActivityRequest request)
Describes an activity.
describeActivity
in interface AWSStepFunctions
describeActivityRequest
- ActivityDoesNotExistException
- The specified activity does not exist.InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.public DescribeExecutionResult describeExecution(DescribeExecutionRequest request)
Describes an execution.
describeExecution
in interface AWSStepFunctions
describeExecutionRequest
- ExecutionDoesNotExistException
- The specified execution does not exist.InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.public DescribeStateMachineResult describeStateMachine(DescribeStateMachineRequest request)
Describes a state machine.
describeStateMachine
in interface AWSStepFunctions
describeStateMachineRequest
- InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.StateMachineDoesNotExistException
- The specified state machine does not exist.public DescribeStateMachineForExecutionResult describeStateMachineForExecution(DescribeStateMachineForExecutionRequest request)
Describes the state machine associated with a specific execution.
describeStateMachineForExecution
in interface AWSStepFunctions
describeStateMachineForExecutionRequest
- ExecutionDoesNotExistException
- The specified execution does not exist.InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.public GetActivityTaskResult getActivityTask(GetActivityTaskRequest request)
Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a
running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds
as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the
service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the
poll returns a taskToken
with a null string.
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).
getActivityTask
in interface AWSStepFunctions
getActivityTaskRequest
- ActivityDoesNotExistException
- The specified activity does not exist.ActivityWorkerLimitExceededException
- The maximum number of workers concurrently polling for activity tasks has been reached.InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.public GetExecutionHistoryResult getExecutionHistory(GetExecutionHistoryRequest request)
Returns the history of the specified execution as a list of events. By default, the results are returned in
ascending order of the timeStamp
of the events. Use the reverseOrder
parameter to get
the latest events first.
If a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
getExecutionHistory
in interface AWSStepFunctions
getExecutionHistoryRequest
- ExecutionDoesNotExistException
- The specified execution does not exist.InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.InvalidTokenException
- The provided token is invalid.public ListActivitiesResult listActivities(ListActivitiesRequest request)
Lists the existing activities.
If a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
listActivities
in interface AWSStepFunctions
listActivitiesRequest
- InvalidTokenException
- The provided token is invalid.public ListExecutionsResult listExecutions(ListExecutionsRequest request)
Lists the executions of a state machine that meet the filtering criteria.
If a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
listExecutions
in interface AWSStepFunctions
listExecutionsRequest
- InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.InvalidTokenException
- The provided token is invalid.StateMachineDoesNotExistException
- The specified state machine does not exist.public ListStateMachinesResult listStateMachines(ListStateMachinesRequest request)
Lists the existing state machines.
If a nextToken
is returned by a previous call, there are more results available. To retrieve the
next page of results, make the call again using the returned token in nextToken
. Keep all other
arguments unchanged.
listStateMachines
in interface AWSStepFunctions
listStateMachinesRequest
- InvalidTokenException
- The provided token is invalid.public SendTaskFailureResult sendTaskFailure(SendTaskFailureRequest request)
Used by workers to report that the task identified by the taskToken
failed.
sendTaskFailure
in interface AWSStepFunctions
sendTaskFailureRequest
- TaskDoesNotExistException
InvalidTokenException
- The provided token is invalid.TaskTimedOutException
public SendTaskHeartbeatResult sendTaskHeartbeat(SendTaskHeartbeatRequest request)
Used by workers to report to the service 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. 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
event.
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.
This operation is only useful for long-lived tasks to report the liveliness of the task.
sendTaskHeartbeat
in interface AWSStepFunctions
sendTaskHeartbeatRequest
- TaskDoesNotExistException
InvalidTokenException
- The provided token is invalid.TaskTimedOutException
public SendTaskSuccessResult sendTaskSuccess(SendTaskSuccessRequest request)
Used by workers to report that the task identified by the taskToken
completed successfully.
sendTaskSuccess
in interface AWSStepFunctions
sendTaskSuccessRequest
- TaskDoesNotExistException
InvalidOutputException
- The provided JSON output data is invalid.InvalidTokenException
- The provided token is invalid.TaskTimedOutException
public StartExecutionResult startExecution(StartExecutionRequest request)
Starts a state machine execution.
startExecution
in interface AWSStepFunctions
startExecutionRequest
- ExecutionLimitExceededException
- The maximum number of running executions has been reached. Running executions must end or be stopped
before a new execution can be started.ExecutionAlreadyExistsException
- The execution has the same name
as another execution (but a different input
).
Executions with the same name
and input
are considered idempotent.
InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.InvalidExecutionInputException
- The provided JSON input data is invalid.InvalidNameException
- The provided name is invalid.StateMachineDoesNotExistException
- The specified state machine does not exist.StateMachineDeletingException
- The specified state machine is being deleted.public StopExecutionResult stopExecution(StopExecutionRequest request)
Stops an execution.
stopExecution
in interface AWSStepFunctions
stopExecutionRequest
- ExecutionDoesNotExistException
- The specified execution does not exist.InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.public UpdateStateMachineResult updateStateMachine(UpdateStateMachineRequest request)
Updates an existing state machine by modifying its definition
and/or roleArn
. Running
executions will continue to use the previous definition
and roleArn
.
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
. You must include at least one of
definition
or roleArn
or you will receive a MissingRequiredParameter
error.
updateStateMachine
in interface AWSStepFunctions
updateStateMachineRequest
- InvalidArnException
- The provided Amazon Resource Name (ARN) is invalid.InvalidDefinitionException
- The provided Amazon States Language definition is invalid.MissingRequiredParameterException
- Request is missing a required parameter. This error occurs if both definition
and
roleArn
are not specified.StateMachineDeletingException
- The specified state machine is being deleted.StateMachineDoesNotExistException
- The specified state machine does not exist.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AWSStepFunctions
request
- The originally executed requestCopyright © 2018. All rights reserved.