@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface SfnClient extends AwsClient
builder() method.
Step Functions is a service that lets you coordinate the components of distributed applications and microservices using visual workflows.
You can use Step Functions to build applications from individual components, each of which performs a discrete function, or task, allowing you to scale and change applications quickly. Step Functions provides a console that helps visualize the components of your application as a series of steps. Step Functions automatically triggers and tracks each step, and retries steps when there are errors, so your application executes predictably and in the right order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any issues.
Step Functions manages operations and underlying infrastructure to ensure your application is available at any scale. You can run tasks on Amazon Web Services, your own servers, or any system that has access to Amazon Web Services. You can access and use Step Functions using the console, the Amazon Web Services SDKs, or an HTTP API. For more information about Step Functions, see the Step Functions Developer Guide .
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static SfnClientBuilder |
builder()
Create a builder that can be used to configure and create a
SfnClient. |
static SfnClient |
create()
Create a
SfnClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateActivityResponse |
createActivity(Consumer<CreateActivityRequest.Builder> createActivityRequest)
Creates an activity.
|
default CreateActivityResponse |
createActivity(CreateActivityRequest createActivityRequest)
Creates an activity.
|
default CreateStateMachineResponse |
createStateMachine(Consumer<CreateStateMachineRequest.Builder> createStateMachineRequest)
Creates a state machine.
|
default CreateStateMachineResponse |
createStateMachine(CreateStateMachineRequest createStateMachineRequest)
Creates a state machine.
|
default DeleteActivityResponse |
deleteActivity(Consumer<DeleteActivityRequest.Builder> deleteActivityRequest)
Deletes an activity.
|
default DeleteActivityResponse |
deleteActivity(DeleteActivityRequest deleteActivityRequest)
Deletes an activity.
|
default DeleteStateMachineResponse |
deleteStateMachine(Consumer<DeleteStateMachineRequest.Builder> deleteStateMachineRequest)
Deletes a state machine.
|
default DeleteStateMachineResponse |
deleteStateMachine(DeleteStateMachineRequest deleteStateMachineRequest)
Deletes a state machine.
|
default DescribeActivityResponse |
describeActivity(Consumer<DescribeActivityRequest.Builder> describeActivityRequest)
Describes an activity.
|
default DescribeActivityResponse |
describeActivity(DescribeActivityRequest describeActivityRequest)
Describes an activity.
|
default DescribeExecutionResponse |
describeExecution(Consumer<DescribeExecutionRequest.Builder> describeExecutionRequest)
Provides all information about a state machine execution, such as the state machine associated with the
execution, the execution input and output, and relevant execution metadata.
|
default DescribeExecutionResponse |
describeExecution(DescribeExecutionRequest describeExecutionRequest)
Provides all information about a state machine execution, such as the state machine associated with the
execution, the execution input and output, and relevant execution metadata.
|
default DescribeMapRunResponse |
describeMapRun(Consumer<DescribeMapRunRequest.Builder> describeMapRunRequest)
Provides information about a Map Run's configuration, progress, and results.
|
default DescribeMapRunResponse |
describeMapRun(DescribeMapRunRequest describeMapRunRequest)
Provides information about a Map Run's configuration, progress, and results.
|
default DescribeStateMachineResponse |
describeStateMachine(Consumer<DescribeStateMachineRequest.Builder> describeStateMachineRequest)
Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and
configuration.
|
default DescribeStateMachineResponse |
describeStateMachine(DescribeStateMachineRequest describeStateMachineRequest)
Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and
configuration.
|
default DescribeStateMachineForExecutionResponse |
describeStateMachineForExecution(Consumer<DescribeStateMachineForExecutionRequest.Builder> describeStateMachineForExecutionRequest)
Provides information about a state machine's definition, its execution role ARN, and configuration.
|
default DescribeStateMachineForExecutionResponse |
describeStateMachineForExecution(DescribeStateMachineForExecutionRequest describeStateMachineForExecutionRequest)
Provides information about a state machine's definition, its execution role ARN, and configuration.
|
default GetActivityTaskResponse |
getActivityTask(Consumer<GetActivityTaskRequest.Builder> getActivityTaskRequest)
Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a
running state machine.
|
default GetActivityTaskResponse |
getActivityTask(GetActivityTaskRequest getActivityTaskRequest)
Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a
running state machine.
|
default GetExecutionHistoryResponse |
getExecutionHistory(Consumer<GetExecutionHistoryRequest.Builder> getExecutionHistoryRequest)
Returns the history of the specified execution as a list of events.
|
default GetExecutionHistoryResponse |
getExecutionHistory(GetExecutionHistoryRequest getExecutionHistoryRequest)
Returns the history of the specified execution as a list of events.
|
default GetExecutionHistoryIterable |
getExecutionHistoryPaginator(Consumer<GetExecutionHistoryRequest.Builder> getExecutionHistoryRequest)
Returns the history of the specified execution as a list of events.
|
default GetExecutionHistoryIterable |
getExecutionHistoryPaginator(GetExecutionHistoryRequest getExecutionHistoryRequest)
Returns the history of the specified execution as a list of events.
|
default ListActivitiesResponse |
listActivities()
Lists the existing activities.
|
default ListActivitiesResponse |
listActivities(Consumer<ListActivitiesRequest.Builder> listActivitiesRequest)
Lists the existing activities.
|
default ListActivitiesResponse |
listActivities(ListActivitiesRequest listActivitiesRequest)
Lists the existing activities.
|
default ListActivitiesIterable |
listActivitiesPaginator()
Lists the existing activities.
|
default ListActivitiesIterable |
listActivitiesPaginator(Consumer<ListActivitiesRequest.Builder> listActivitiesRequest)
Lists the existing activities.
|
default ListActivitiesIterable |
listActivitiesPaginator(ListActivitiesRequest listActivitiesRequest)
Lists the existing activities.
|
default ListExecutionsResponse |
listExecutions(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)
Lists all executions of a state machine or a Map Run.
|
default ListExecutionsResponse |
listExecutions(ListExecutionsRequest listExecutionsRequest)
Lists all executions of a state machine or a Map Run.
|
default ListExecutionsIterable |
listExecutionsPaginator(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)
Lists all executions of a state machine or a Map Run.
|
default ListExecutionsIterable |
listExecutionsPaginator(ListExecutionsRequest listExecutionsRequest)
Lists all executions of a state machine or a Map Run.
|
default ListMapRunsResponse |
listMapRuns(Consumer<ListMapRunsRequest.Builder> listMapRunsRequest)
Lists all Map Runs that were started by a given state machine execution.
|
default ListMapRunsResponse |
listMapRuns(ListMapRunsRequest listMapRunsRequest)
Lists all Map Runs that were started by a given state machine execution.
|
default ListMapRunsIterable |
listMapRunsPaginator(Consumer<ListMapRunsRequest.Builder> listMapRunsRequest)
Lists all Map Runs that were started by a given state machine execution.
|
default ListMapRunsIterable |
listMapRunsPaginator(ListMapRunsRequest listMapRunsRequest)
Lists all Map Runs that were started by a given state machine execution.
|
default ListStateMachinesResponse |
listStateMachines()
Lists the existing state machines.
|
default ListStateMachinesResponse |
listStateMachines(Consumer<ListStateMachinesRequest.Builder> listStateMachinesRequest)
Lists the existing state machines.
|
default ListStateMachinesResponse |
listStateMachines(ListStateMachinesRequest listStateMachinesRequest)
Lists the existing state machines.
|
default ListStateMachinesIterable |
listStateMachinesPaginator()
Lists the existing state machines.
|
default ListStateMachinesIterable |
listStateMachinesPaginator(Consumer<ListStateMachinesRequest.Builder> listStateMachinesRequest)
Lists the existing state machines.
|
default ListStateMachinesIterable |
listStateMachinesPaginator(ListStateMachinesRequest listStateMachinesRequest)
Lists the existing state machines.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
List tags for a given resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List tags for a given resource.
|
default SendTaskFailureResponse |
sendTaskFailure(Consumer<SendTaskFailureRequest.Builder> sendTaskFailureRequest)
Used by activity workers and task states using the callback pattern to report that the task identified by the
taskToken failed. |
default SendTaskFailureResponse |
sendTaskFailure(SendTaskFailureRequest sendTaskFailureRequest)
Used by activity workers and task states using the callback pattern to report that the task identified by the
taskToken failed. |
default SendTaskHeartbeatResponse |
sendTaskHeartbeat(Consumer<SendTaskHeartbeatRequest.Builder> sendTaskHeartbeatRequest)
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. |
default SendTaskHeartbeatResponse |
sendTaskHeartbeat(SendTaskHeartbeatRequest sendTaskHeartbeatRequest)
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. |
default SendTaskSuccessResponse |
sendTaskSuccess(Consumer<SendTaskSuccessRequest.Builder> sendTaskSuccessRequest)
Used by activity workers and task states using the callback pattern to report that the task identified by the
taskToken completed successfully. |
default SendTaskSuccessResponse |
sendTaskSuccess(SendTaskSuccessRequest sendTaskSuccessRequest)
Used by activity workers and task states using the callback pattern to report that the task identified by the
taskToken completed successfully. |
default SfnServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
default StartExecutionResponse |
startExecution(Consumer<StartExecutionRequest.Builder> startExecutionRequest)
Starts a state machine execution.
|
default StartExecutionResponse |
startExecution(StartExecutionRequest startExecutionRequest)
Starts a state machine execution.
|
default StartSyncExecutionResponse |
startSyncExecution(Consumer<StartSyncExecutionRequest.Builder> startSyncExecutionRequest)
Starts a Synchronous Express state machine execution.
|
default StartSyncExecutionResponse |
startSyncExecution(StartSyncExecutionRequest startSyncExecutionRequest)
Starts a Synchronous Express state machine execution.
|
default StopExecutionResponse |
stopExecution(Consumer<StopExecutionRequest.Builder> stopExecutionRequest)
Stops an execution.
|
default StopExecutionResponse |
stopExecution(StopExecutionRequest stopExecutionRequest)
Stops an execution.
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Add a tag to a Step Functions resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Add a tag to a Step Functions resource.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Remove a tag from a Step Functions resource
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Remove a tag from a Step Functions resource
|
default UpdateMapRunResponse |
updateMapRun(Consumer<UpdateMapRunRequest.Builder> updateMapRunRequest)
Updates an in-progress Map Run's configuration to include changes to the settings that control maximum
concurrency and Map Run failure.
|
default UpdateMapRunResponse |
updateMapRun(UpdateMapRunRequest updateMapRunRequest)
Updates an in-progress Map Run's configuration to include changes to the settings that control maximum
concurrency and Map Run failure.
|
default UpdateStateMachineResponse |
updateStateMachine(Consumer<UpdateStateMachineRequest.Builder> updateStateMachineRequest)
Updates an existing state machine by modifying its
definition, roleArn, or
loggingConfiguration. |
default UpdateStateMachineResponse |
updateStateMachine(UpdateStateMachineRequest updateStateMachineRequest)
Updates an existing state machine by modifying its
definition, roleArn, or
loggingConfiguration. |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CreateActivityResponse createActivity(CreateActivityRequest createActivityRequest) throws ActivityLimitExceededException, InvalidNameException, TooManyTagsException, AwsServiceException, SdkClientException, SfnException
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.
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 not valid.TooManyTagsException - You've exceeded the number of tags allowed for a resource. See the Limits Topic in the Step
Functions Developer Guide.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateActivityResponse createActivity(Consumer<CreateActivityRequest.Builder> createActivityRequest) throws ActivityLimitExceededException, InvalidNameException, TooManyTagsException, AwsServiceException, SdkClientException, SfnException
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.
This is a convenience which creates an instance of the CreateActivityRequest.Builder avoiding the need to
create one manually via CreateActivityRequest.builder()
createActivityRequest - A Consumer that will call methods on CreateActivityInput.Builder to create a request.ActivityLimitExceededException - The maximum number of activities has been reached. Existing activities must be deleted before a new
activity can be created.InvalidNameException - The provided name is not valid.TooManyTagsException - You've exceeded the number of tags allowed for a resource. See the Limits Topic in the Step
Functions Developer Guide.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateStateMachineResponse createStateMachine(CreateStateMachineRequest createStateMachineRequest) throws InvalidArnException, InvalidDefinitionException, InvalidNameException, InvalidLoggingConfigurationException, InvalidTracingConfigurationException, StateMachineAlreadyExistsException, StateMachineDeletingException, StateMachineLimitExceededException, StateMachineTypeNotSupportedException, TooManyTagsException, AwsServiceException, SdkClientException, SfnException
Creates a state machine. A state machine consists of a collection of states that can do work (Task
states), determine to which states to transition next (Choice states), stop an execution with an
error (Fail states), and so on. State machines are specified using a JSON-based, structured
language. For more information, see Amazon States
Language in the Step Functions User Guide.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it
was already created. CreateStateMachine's idempotency check is based on the state machine
name, definition, type, LoggingConfiguration and
TracingConfiguration. If a following request has a different roleArn or
tags, Step Functions will ignore these differences and treat it as an idempotent request of the
previous. In this case, roleArn and tags will not be updated, even if they are
different.
createStateMachineRequest - InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.InvalidDefinitionException - The provided Amazon States Language definition is not valid.InvalidNameException - The provided name is not valid.InvalidLoggingConfigurationExceptionInvalidTracingConfigurationException - Your tracingConfiguration key does not match, or enabled has not been set to
true or false.StateMachineAlreadyExistsException - A state machine with the same name but a different definition or role ARN already exists.StateMachineDeletingException - The specified state machine is being deleted.StateMachineLimitExceededException - The maximum number of state machines has been reached. Existing state machines must be deleted before a
new state machine can be created.StateMachineTypeNotSupportedExceptionTooManyTagsException - You've exceeded the number of tags allowed for a resource. See the Limits Topic in the Step
Functions Developer Guide.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateStateMachineResponse createStateMachine(Consumer<CreateStateMachineRequest.Builder> createStateMachineRequest) throws InvalidArnException, InvalidDefinitionException, InvalidNameException, InvalidLoggingConfigurationException, InvalidTracingConfigurationException, StateMachineAlreadyExistsException, StateMachineDeletingException, StateMachineLimitExceededException, StateMachineTypeNotSupportedException, TooManyTagsException, AwsServiceException, SdkClientException, SfnException
Creates a state machine. A state machine consists of a collection of states that can do work (Task
states), determine to which states to transition next (Choice states), stop an execution with an
error (Fail states), and so on. State machines are specified using a JSON-based, structured
language. For more information, see Amazon States
Language in the Step Functions User Guide.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it
was already created. CreateStateMachine's idempotency check is based on the state machine
name, definition, type, LoggingConfiguration and
TracingConfiguration. If a following request has a different roleArn or
tags, Step Functions will ignore these differences and treat it as an idempotent request of the
previous. In this case, roleArn and tags will not be updated, even if they are
different.
This is a convenience which creates an instance of the CreateStateMachineRequest.Builder avoiding the
need to create one manually via CreateStateMachineRequest.builder()
createStateMachineRequest - A Consumer that will call methods on CreateStateMachineInput.Builder to create a request.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.InvalidDefinitionException - The provided Amazon States Language definition is not valid.InvalidNameException - The provided name is not valid.InvalidLoggingConfigurationExceptionInvalidTracingConfigurationException - Your tracingConfiguration key does not match, or enabled has not been set to
true or false.StateMachineAlreadyExistsException - A state machine with the same name but a different definition or role ARN already exists.StateMachineDeletingException - The specified state machine is being deleted.StateMachineLimitExceededException - The maximum number of state machines has been reached. Existing state machines must be deleted before a
new state machine can be created.StateMachineTypeNotSupportedExceptionTooManyTagsException - You've exceeded the number of tags allowed for a resource. See the Limits Topic in the Step
Functions Developer Guide.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteActivityResponse deleteActivity(DeleteActivityRequest deleteActivityRequest) throws InvalidArnException, AwsServiceException, SdkClientException, SfnException
Deletes an activity.
deleteActivityRequest - InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteActivityResponse deleteActivity(Consumer<DeleteActivityRequest.Builder> deleteActivityRequest) throws InvalidArnException, AwsServiceException, SdkClientException, SfnException
Deletes an activity.
This is a convenience which creates an instance of the DeleteActivityRequest.Builder avoiding the need to
create one manually via DeleteActivityRequest.builder()
deleteActivityRequest - A Consumer that will call methods on DeleteActivityInput.Builder to create a request.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteStateMachineResponse deleteStateMachine(DeleteStateMachineRequest deleteStateMachineRequest) throws InvalidArnException, ValidationException, AwsServiceException, SdkClientException, SfnException
Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to
DELETING and begins the deletion process.
If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.
A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For
example, the qualified state machine ARN
arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a
Distributed Map state with a label mapStateLabel in the state machine named
stateMachineName.
For EXPRESS state machines, the deletion will happen eventually (usually less than a minute).
Running executions may emit logs after DeleteStateMachine API is called.
deleteStateMachineRequest - InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteStateMachineResponse deleteStateMachine(Consumer<DeleteStateMachineRequest.Builder> deleteStateMachineRequest) throws InvalidArnException, ValidationException, AwsServiceException, SdkClientException, SfnException
Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to
DELETING and begins the deletion process.
If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.
A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For
example, the qualified state machine ARN
arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a
Distributed Map state with a label mapStateLabel in the state machine named
stateMachineName.
For EXPRESS state machines, the deletion will happen eventually (usually less than a minute).
Running executions may emit logs after DeleteStateMachine API is called.
This is a convenience which creates an instance of the DeleteStateMachineRequest.Builder avoiding the
need to create one manually via DeleteStateMachineRequest.builder()
deleteStateMachineRequest - A Consumer that will call methods on DeleteStateMachineInput.Builder to create a request.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeActivityResponse describeActivity(DescribeActivityRequest describeActivityRequest) throws ActivityDoesNotExistException, InvalidArnException, AwsServiceException, SdkClientException, SfnException
Describes an activity.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
describeActivityRequest - ActivityDoesNotExistException - The specified activity does not exist.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeActivityResponse describeActivity(Consumer<DescribeActivityRequest.Builder> describeActivityRequest) throws ActivityDoesNotExistException, InvalidArnException, AwsServiceException, SdkClientException, SfnException
Describes an activity.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This is a convenience which creates an instance of the DescribeActivityRequest.Builder avoiding the need
to create one manually via DescribeActivityRequest.builder()
describeActivityRequest - A Consumer that will call methods on DescribeActivityInput.Builder to create a request.ActivityDoesNotExistException - The specified activity does not exist.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeExecutionResponse describeExecution(DescribeExecutionRequest describeExecutionRequest) throws ExecutionDoesNotExistException, InvalidArnException, AwsServiceException, SdkClientException, SfnException
Provides all information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. Use this API action to return the Map Run ARN if the execution was dispatched by a Map Run.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machine executions unless they were dispatched by
a Map Run.
describeExecutionRequest - ExecutionDoesNotExistException - The specified execution does not exist.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeExecutionResponse describeExecution(Consumer<DescribeExecutionRequest.Builder> describeExecutionRequest) throws ExecutionDoesNotExistException, InvalidArnException, AwsServiceException, SdkClientException, SfnException
Provides all information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. Use this API action to return the Map Run ARN if the execution was dispatched by a Map Run.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machine executions unless they were dispatched by
a Map Run.
This is a convenience which creates an instance of the DescribeExecutionRequest.Builder avoiding the need
to create one manually via DescribeExecutionRequest.builder()
describeExecutionRequest - A Consumer that will call methods on DescribeExecutionInput.Builder to create a request.ExecutionDoesNotExistException - The specified execution does not exist.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeMapRunResponse describeMapRun(DescribeMapRunRequest describeMapRunRequest) throws ResourceNotFoundException, InvalidArnException, AwsServiceException, SdkClientException, SfnException
Provides information about a Map Run's configuration, progress, and results. For more information, see Examining Map Run in the Step Functions Developer Guide.
describeMapRunRequest - ResourceNotFoundException - Could not find the referenced resource. Only state machine and activity ARNs are supported.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeMapRunResponse describeMapRun(Consumer<DescribeMapRunRequest.Builder> describeMapRunRequest) throws ResourceNotFoundException, InvalidArnException, AwsServiceException, SdkClientException, SfnException
Provides information about a Map Run's configuration, progress, and results. For more information, see Examining Map Run in the Step Functions Developer Guide.
This is a convenience which creates an instance of the DescribeMapRunRequest.Builder avoiding the need to
create one manually via DescribeMapRunRequest.builder()
describeMapRunRequest - A Consumer that will call methods on DescribeMapRunInput.Builder to create a request.ResourceNotFoundException - Could not find the referenced resource. Only state machine and activity ARNs are supported.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStateMachineResponse describeStateMachine(DescribeStateMachineRequest describeStateMachineRequest) throws InvalidArnException, StateMachineDoesNotExistException, AwsServiceException, SdkClientException, SfnException
Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and
configuration. If the state machine ARN is a qualified state machine ARN, the response returned includes the
Map state's label.
A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For
example, the qualified state machine ARN
arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a
Distributed Map state with a label mapStateLabel in the state machine named
stateMachineName.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
describeStateMachineRequest - InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.StateMachineDoesNotExistException - The specified state machine does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStateMachineResponse describeStateMachine(Consumer<DescribeStateMachineRequest.Builder> describeStateMachineRequest) throws InvalidArnException, StateMachineDoesNotExistException, AwsServiceException, SdkClientException, SfnException
Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and
configuration. If the state machine ARN is a qualified state machine ARN, the response returned includes the
Map state's label.
A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For
example, the qualified state machine ARN
arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a
Distributed Map state with a label mapStateLabel in the state machine named
stateMachineName.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This is a convenience which creates an instance of the DescribeStateMachineRequest.Builder avoiding the
need to create one manually via DescribeStateMachineRequest.builder()
describeStateMachineRequest - A Consumer that will call methods on DescribeStateMachineInput.Builder to create a
request.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.StateMachineDoesNotExistException - The specified state machine does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStateMachineForExecutionResponse describeStateMachineForExecution(DescribeStateMachineForExecutionRequest describeStateMachineForExecutionRequest) throws ExecutionDoesNotExistException, InvalidArnException, AwsServiceException, SdkClientException, SfnException
Provides information about a state machine's definition, its execution role ARN, and configuration. If an execution was dispatched by a Map Run, the Map Run is returned in the response. Additionally, the state machine returned will be the state machine associated with the Map Run.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machines.
describeStateMachineForExecutionRequest - ExecutionDoesNotExistException - The specified execution does not exist.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeStateMachineForExecutionResponse describeStateMachineForExecution(Consumer<DescribeStateMachineForExecutionRequest.Builder> describeStateMachineForExecutionRequest) throws ExecutionDoesNotExistException, InvalidArnException, AwsServiceException, SdkClientException, SfnException
Provides information about a state machine's definition, its execution role ARN, and configuration. If an execution was dispatched by a Map Run, the Map Run is returned in the response. Additionally, the state machine returned will be the state machine associated with the Map Run.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machines.
This is a convenience which creates an instance of the DescribeStateMachineForExecutionRequest.Builder
avoiding the need to create one manually via DescribeStateMachineForExecutionRequest.builder()
describeStateMachineForExecutionRequest - A Consumer that will call methods on DescribeStateMachineForExecutionInput.Builder to
create a request.ExecutionDoesNotExistException - The specified execution does not exist.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetActivityTaskResponse getActivityTask(GetActivityTaskRequest getActivityTaskRequest) throws ActivityDoesNotExistException, ActivityWorkerLimitExceededException, InvalidArnException, AwsServiceException, SdkClientException, SfnException
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.
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 not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetActivityTaskResponse getActivityTask(Consumer<GetActivityTaskRequest.Builder> getActivityTaskRequest) throws ActivityDoesNotExistException, ActivityWorkerLimitExceededException, InvalidArnException, AwsServiceException, SdkClientException, SfnException
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.
This is a convenience which creates an instance of the GetActivityTaskRequest.Builder avoiding the need
to create one manually via GetActivityTaskRequest.builder()
getActivityTaskRequest - A Consumer that will call methods on GetActivityTaskInput.Builder to create a request.ActivityDoesNotExistException - The specified activity does not exist.ActivityWorkerLimitExceededException - The maximum number of workers concurrently polling for activity tasks has been reached.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetExecutionHistoryResponse getExecutionHistory(GetExecutionHistoryRequest getExecutionHistoryRequest) throws ExecutionDoesNotExistException, InvalidArnException, InvalidTokenException, AwsServiceException, SdkClientException, SfnException
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.
getExecutionHistoryRequest - ExecutionDoesNotExistException - The specified execution does not exist.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.InvalidTokenException - The provided token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetExecutionHistoryResponse getExecutionHistory(Consumer<GetExecutionHistoryRequest.Builder> getExecutionHistoryRequest) throws ExecutionDoesNotExistException, InvalidArnException, InvalidTokenException, AwsServiceException, SdkClientException, SfnException
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.
This is a convenience which creates an instance of the GetExecutionHistoryRequest.Builder avoiding the
need to create one manually via GetExecutionHistoryRequest.builder()
getExecutionHistoryRequest - A Consumer that will call methods on GetExecutionHistoryInput.Builder to create a request.ExecutionDoesNotExistException - The specified execution does not exist.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.InvalidTokenException - The provided token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetExecutionHistoryIterable getExecutionHistoryPaginator(GetExecutionHistoryRequest getExecutionHistoryRequest) throws ExecutionDoesNotExistException, InvalidArnException, InvalidTokenException, AwsServiceException, SdkClientException, SfnException
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.
This is a variant of
getExecutionHistory(software.amazon.awssdk.services.sfn.model.GetExecutionHistoryRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sfn.paginators.GetExecutionHistoryIterable responses = client.getExecutionHistoryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.sfn.paginators.GetExecutionHistoryIterable responses = client
.getExecutionHistoryPaginator(request);
for (software.amazon.awssdk.services.sfn.model.GetExecutionHistoryResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.sfn.paginators.GetExecutionHistoryIterable responses = client.getExecutionHistoryPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getExecutionHistory(software.amazon.awssdk.services.sfn.model.GetExecutionHistoryRequest) operation.
getExecutionHistoryRequest - ExecutionDoesNotExistException - The specified execution does not exist.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.InvalidTokenException - The provided token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetExecutionHistoryIterable getExecutionHistoryPaginator(Consumer<GetExecutionHistoryRequest.Builder> getExecutionHistoryRequest) throws ExecutionDoesNotExistException, InvalidArnException, InvalidTokenException, AwsServiceException, SdkClientException, SfnException
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.
This is a variant of
getExecutionHistory(software.amazon.awssdk.services.sfn.model.GetExecutionHistoryRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sfn.paginators.GetExecutionHistoryIterable responses = client.getExecutionHistoryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.sfn.paginators.GetExecutionHistoryIterable responses = client
.getExecutionHistoryPaginator(request);
for (software.amazon.awssdk.services.sfn.model.GetExecutionHistoryResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.sfn.paginators.GetExecutionHistoryIterable responses = client.getExecutionHistoryPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getExecutionHistory(software.amazon.awssdk.services.sfn.model.GetExecutionHistoryRequest) operation.
This is a convenience which creates an instance of the GetExecutionHistoryRequest.Builder avoiding the
need to create one manually via GetExecutionHistoryRequest.builder()
getExecutionHistoryRequest - A Consumer that will call methods on GetExecutionHistoryInput.Builder to create a request.ExecutionDoesNotExistException - The specified execution does not exist.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.InvalidTokenException - The provided token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListActivitiesResponse listActivities() throws InvalidTokenException, AwsServiceException, SdkClientException, SfnException
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.
InvalidTokenException - The provided token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistActivities(ListActivitiesRequest),
AWS API
Documentationdefault ListActivitiesResponse listActivities(ListActivitiesRequest listActivitiesRequest) throws InvalidTokenException, AwsServiceException, SdkClientException, SfnException
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.
listActivitiesRequest - InvalidTokenException - The provided token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListActivitiesResponse listActivities(Consumer<ListActivitiesRequest.Builder> listActivitiesRequest) throws InvalidTokenException, AwsServiceException, SdkClientException, SfnException
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.
This is a convenience which creates an instance of the ListActivitiesRequest.Builder avoiding the need to
create one manually via ListActivitiesRequest.builder()
listActivitiesRequest - A Consumer that will call methods on ListActivitiesInput.Builder to create a request.InvalidTokenException - The provided token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListActivitiesIterable listActivitiesPaginator() throws InvalidTokenException, AwsServiceException, SdkClientException, SfnException
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.
This is a variant of listActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sfn.paginators.ListActivitiesIterable responses = client.listActivitiesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.sfn.paginators.ListActivitiesIterable responses = client.listActivitiesPaginator(request);
for (software.amazon.awssdk.services.sfn.model.ListActivitiesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.sfn.paginators.ListActivitiesIterable responses = client.listActivitiesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest) operation.
InvalidTokenException - The provided token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistActivitiesPaginator(ListActivitiesRequest),
AWS API
Documentationdefault ListActivitiesIterable listActivitiesPaginator(ListActivitiesRequest listActivitiesRequest) throws InvalidTokenException, AwsServiceException, SdkClientException, SfnException
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.
This is a variant of listActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sfn.paginators.ListActivitiesIterable responses = client.listActivitiesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.sfn.paginators.ListActivitiesIterable responses = client.listActivitiesPaginator(request);
for (software.amazon.awssdk.services.sfn.model.ListActivitiesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.sfn.paginators.ListActivitiesIterable responses = client.listActivitiesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest) operation.
listActivitiesRequest - InvalidTokenException - The provided token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListActivitiesIterable listActivitiesPaginator(Consumer<ListActivitiesRequest.Builder> listActivitiesRequest) throws InvalidTokenException, AwsServiceException, SdkClientException, SfnException
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.
This is a variant of listActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sfn.paginators.ListActivitiesIterable responses = client.listActivitiesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.sfn.paginators.ListActivitiesIterable responses = client.listActivitiesPaginator(request);
for (software.amazon.awssdk.services.sfn.model.ListActivitiesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.sfn.paginators.ListActivitiesIterable responses = client.listActivitiesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listActivities(software.amazon.awssdk.services.sfn.model.ListActivitiesRequest) operation.
This is a convenience which creates an instance of the ListActivitiesRequest.Builder avoiding the need to
create one manually via ListActivitiesRequest.builder()
listActivitiesRequest - A Consumer that will call methods on ListActivitiesInput.Builder to create a request.InvalidTokenException - The provided token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListExecutionsResponse listExecutions(ListExecutionsRequest listExecutionsRequest) throws InvalidArnException, InvalidTokenException, StateMachineDoesNotExistException, StateMachineTypeNotSupportedException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, SfnException
Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN.
Results are sorted by time, with the most recent execution first.
If nextToken is returned, there are more results available. The value of nextToken is a
unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination
token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machines.
listExecutionsRequest - InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.InvalidTokenException - The provided token is not valid.StateMachineDoesNotExistException - The specified state machine does not exist.StateMachineTypeNotSupportedExceptionValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException - Could not find the referenced resource. Only state machine and activity ARNs are supported.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListExecutionsResponse listExecutions(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest) throws InvalidArnException, InvalidTokenException, StateMachineDoesNotExistException, StateMachineTypeNotSupportedException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, SfnException
Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN.
Results are sorted by time, with the most recent execution first.
If nextToken is returned, there are more results available. The value of nextToken is a
unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination
token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machines.
This is a convenience which creates an instance of the ListExecutionsRequest.Builder avoiding the need to
create one manually via ListExecutionsRequest.builder()
listExecutionsRequest - A Consumer that will call methods on ListExecutionsInput.Builder to create a request.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.InvalidTokenException - The provided token is not valid.StateMachineDoesNotExistException - The specified state machine does not exist.StateMachineTypeNotSupportedExceptionValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException - Could not find the referenced resource. Only state machine and activity ARNs are supported.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListExecutionsIterable listExecutionsPaginator(ListExecutionsRequest listExecutionsRequest) throws InvalidArnException, InvalidTokenException, StateMachineDoesNotExistException, StateMachineTypeNotSupportedException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, SfnException
Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN.
Results are sorted by time, with the most recent execution first.
If nextToken is returned, there are more results available. The value of nextToken is a
unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination
token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machines.
This is a variant of listExecutions(software.amazon.awssdk.services.sfn.model.ListExecutionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sfn.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.sfn.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request);
for (software.amazon.awssdk.services.sfn.model.ListExecutionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.sfn.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExecutions(software.amazon.awssdk.services.sfn.model.ListExecutionsRequest) operation.
listExecutionsRequest - InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.InvalidTokenException - The provided token is not valid.StateMachineDoesNotExistException - The specified state machine does not exist.StateMachineTypeNotSupportedExceptionValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException - Could not find the referenced resource. Only state machine and activity ARNs are supported.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListExecutionsIterable listExecutionsPaginator(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest) throws InvalidArnException, InvalidTokenException, StateMachineDoesNotExistException, StateMachineTypeNotSupportedException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, SfnException
Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN.
Results are sorted by time, with the most recent execution first.
If nextToken is returned, there are more results available. The value of nextToken is a
unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination
token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported by EXPRESS state machines.
This is a variant of listExecutions(software.amazon.awssdk.services.sfn.model.ListExecutionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sfn.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.sfn.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request);
for (software.amazon.awssdk.services.sfn.model.ListExecutionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.sfn.paginators.ListExecutionsIterable responses = client.listExecutionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExecutions(software.amazon.awssdk.services.sfn.model.ListExecutionsRequest) operation.
This is a convenience which creates an instance of the ListExecutionsRequest.Builder avoiding the need to
create one manually via ListExecutionsRequest.builder()
listExecutionsRequest - A Consumer that will call methods on ListExecutionsInput.Builder to create a request.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.InvalidTokenException - The provided token is not valid.StateMachineDoesNotExistException - The specified state machine does not exist.StateMachineTypeNotSupportedExceptionValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException - Could not find the referenced resource. Only state machine and activity ARNs are supported.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMapRunsResponse listMapRuns(ListMapRunsRequest listMapRunsRequest) throws ExecutionDoesNotExistException, InvalidArnException, InvalidTokenException, AwsServiceException, SdkClientException, SfnException
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.
listMapRunsRequest - ExecutionDoesNotExistException - The specified execution does not exist.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.InvalidTokenException - The provided token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMapRunsResponse listMapRuns(Consumer<ListMapRunsRequest.Builder> listMapRunsRequest) throws ExecutionDoesNotExistException, InvalidArnException, InvalidTokenException, AwsServiceException, SdkClientException, SfnException
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.
This is a convenience which creates an instance of the ListMapRunsRequest.Builder avoiding the need to
create one manually via ListMapRunsRequest.builder()
listMapRunsRequest - A Consumer that will call methods on ListMapRunsInput.Builder to create a request.ExecutionDoesNotExistException - The specified execution does not exist.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.InvalidTokenException - The provided token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMapRunsIterable listMapRunsPaginator(ListMapRunsRequest listMapRunsRequest) throws ExecutionDoesNotExistException, InvalidArnException, InvalidTokenException, AwsServiceException, SdkClientException, SfnException
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.
This is a variant of listMapRuns(software.amazon.awssdk.services.sfn.model.ListMapRunsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sfn.paginators.ListMapRunsIterable responses = client.listMapRunsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.sfn.paginators.ListMapRunsIterable responses = client.listMapRunsPaginator(request);
for (software.amazon.awssdk.services.sfn.model.ListMapRunsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.sfn.paginators.ListMapRunsIterable responses = client.listMapRunsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMapRuns(software.amazon.awssdk.services.sfn.model.ListMapRunsRequest) operation.
listMapRunsRequest - ExecutionDoesNotExistException - The specified execution does not exist.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.InvalidTokenException - The provided token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMapRunsIterable listMapRunsPaginator(Consumer<ListMapRunsRequest.Builder> listMapRunsRequest) throws ExecutionDoesNotExistException, InvalidArnException, InvalidTokenException, AwsServiceException, SdkClientException, SfnException
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.
This is a variant of listMapRuns(software.amazon.awssdk.services.sfn.model.ListMapRunsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sfn.paginators.ListMapRunsIterable responses = client.listMapRunsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.sfn.paginators.ListMapRunsIterable responses = client.listMapRunsPaginator(request);
for (software.amazon.awssdk.services.sfn.model.ListMapRunsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.sfn.paginators.ListMapRunsIterable responses = client.listMapRunsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMapRuns(software.amazon.awssdk.services.sfn.model.ListMapRunsRequest) operation.
This is a convenience which creates an instance of the ListMapRunsRequest.Builder avoiding the need to
create one manually via ListMapRunsRequest.builder()
listMapRunsRequest - A Consumer that will call methods on ListMapRunsInput.Builder to create a request.ExecutionDoesNotExistException - The specified execution does not exist.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.InvalidTokenException - The provided token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStateMachinesResponse listStateMachines() throws InvalidTokenException, AwsServiceException, SdkClientException, SfnException
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.
InvalidTokenException - The provided token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistStateMachines(ListStateMachinesRequest),
AWS API
Documentationdefault ListStateMachinesResponse listStateMachines(ListStateMachinesRequest listStateMachinesRequest) throws InvalidTokenException, AwsServiceException, SdkClientException, SfnException
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.
listStateMachinesRequest - InvalidTokenException - The provided token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStateMachinesResponse listStateMachines(Consumer<ListStateMachinesRequest.Builder> listStateMachinesRequest) throws InvalidTokenException, AwsServiceException, SdkClientException, SfnException
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.
This is a convenience which creates an instance of the ListStateMachinesRequest.Builder avoiding the need
to create one manually via ListStateMachinesRequest.builder()
listStateMachinesRequest - A Consumer that will call methods on ListStateMachinesInput.Builder to create a request.InvalidTokenException - The provided token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStateMachinesIterable listStateMachinesPaginator() throws InvalidTokenException, AwsServiceException, SdkClientException, SfnException
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.
This is a variant of
listStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sfn.paginators.ListStateMachinesIterable responses = client.listStateMachinesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.sfn.paginators.ListStateMachinesIterable responses = client
.listStateMachinesPaginator(request);
for (software.amazon.awssdk.services.sfn.model.ListStateMachinesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.sfn.paginators.ListStateMachinesIterable responses = client.listStateMachinesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest) operation.
InvalidTokenException - The provided token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistStateMachinesPaginator(ListStateMachinesRequest),
AWS API
Documentationdefault ListStateMachinesIterable listStateMachinesPaginator(ListStateMachinesRequest listStateMachinesRequest) throws InvalidTokenException, AwsServiceException, SdkClientException, SfnException
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.
This is a variant of
listStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sfn.paginators.ListStateMachinesIterable responses = client.listStateMachinesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.sfn.paginators.ListStateMachinesIterable responses = client
.listStateMachinesPaginator(request);
for (software.amazon.awssdk.services.sfn.model.ListStateMachinesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.sfn.paginators.ListStateMachinesIterable responses = client.listStateMachinesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest) operation.
listStateMachinesRequest - InvalidTokenException - The provided token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListStateMachinesIterable listStateMachinesPaginator(Consumer<ListStateMachinesRequest.Builder> listStateMachinesRequest) throws InvalidTokenException, AwsServiceException, SdkClientException, SfnException
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.
This is a variant of
listStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.sfn.paginators.ListStateMachinesIterable responses = client.listStateMachinesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.sfn.paginators.ListStateMachinesIterable responses = client
.listStateMachinesPaginator(request);
for (software.amazon.awssdk.services.sfn.model.ListStateMachinesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.sfn.paginators.ListStateMachinesIterable responses = client.listStateMachinesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStateMachines(software.amazon.awssdk.services.sfn.model.ListStateMachinesRequest) operation.
This is a convenience which creates an instance of the ListStateMachinesRequest.Builder avoiding the need
to create one manually via ListStateMachinesRequest.builder()
listStateMachinesRequest - A Consumer that will call methods on ListStateMachinesInput.Builder to create a request.InvalidTokenException - The provided token is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidArnException, ResourceNotFoundException, AwsServiceException, SdkClientException, SfnException
List tags for a given resource.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
listTagsForResourceRequest - InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.ResourceNotFoundException - Could not find the referenced resource. Only state machine and activity ARNs are supported.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidArnException, ResourceNotFoundException, AwsServiceException, SdkClientException, SfnException
List tags for a given resource.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceInput.Builder to create a request.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.ResourceNotFoundException - Could not find the referenced resource. Only state machine and activity ARNs are supported.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SendTaskFailureResponse sendTaskFailure(SendTaskFailureRequest sendTaskFailureRequest) throws TaskDoesNotExistException, InvalidTokenException, TaskTimedOutException, AwsServiceException, SdkClientException, SfnException
Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed.
sendTaskFailureRequest - TaskDoesNotExistExceptionInvalidTokenException - The provided token is not valid.TaskTimedOutExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SendTaskFailureResponse sendTaskFailure(Consumer<SendTaskFailureRequest.Builder> sendTaskFailureRequest) throws TaskDoesNotExistException, InvalidTokenException, TaskTimedOutException, AwsServiceException, SdkClientException, SfnException
Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed.
This is a convenience which creates an instance of the SendTaskFailureRequest.Builder avoiding the need
to create one manually via SendTaskFailureRequest.builder()
sendTaskFailureRequest - A Consumer that will call methods on SendTaskFailureInput.Builder to create a request.TaskDoesNotExistExceptionInvalidTokenException - The provided token is not valid.TaskTimedOutExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SendTaskHeartbeatResponse sendTaskHeartbeat(SendTaskHeartbeatRequest sendTaskHeartbeatRequest) throws TaskDoesNotExistException, InvalidTokenException, TaskTimedOutException, AwsServiceException, SdkClientException, SfnException
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.
sendTaskHeartbeatRequest - TaskDoesNotExistExceptionInvalidTokenException - The provided token is not valid.TaskTimedOutExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SendTaskHeartbeatResponse sendTaskHeartbeat(Consumer<SendTaskHeartbeatRequest.Builder> sendTaskHeartbeatRequest) throws TaskDoesNotExistException, InvalidTokenException, TaskTimedOutException, AwsServiceException, SdkClientException, SfnException
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.
This is a convenience which creates an instance of the SendTaskHeartbeatRequest.Builder avoiding the need
to create one manually via SendTaskHeartbeatRequest.builder()
sendTaskHeartbeatRequest - A Consumer that will call methods on SendTaskHeartbeatInput.Builder to create a request.TaskDoesNotExistExceptionInvalidTokenException - The provided token is not valid.TaskTimedOutExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SendTaskSuccessResponse sendTaskSuccess(SendTaskSuccessRequest sendTaskSuccessRequest) throws TaskDoesNotExistException, InvalidOutputException, InvalidTokenException, TaskTimedOutException, AwsServiceException, SdkClientException, SfnException
Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken completed successfully.
sendTaskSuccessRequest - TaskDoesNotExistExceptionInvalidOutputException - The provided JSON output data is not valid.InvalidTokenException - The provided token is not valid.TaskTimedOutExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SendTaskSuccessResponse sendTaskSuccess(Consumer<SendTaskSuccessRequest.Builder> sendTaskSuccessRequest) throws TaskDoesNotExistException, InvalidOutputException, InvalidTokenException, TaskTimedOutException, AwsServiceException, SdkClientException, SfnException
Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken completed successfully.
This is a convenience which creates an instance of the SendTaskSuccessRequest.Builder avoiding the need
to create one manually via SendTaskSuccessRequest.builder()
sendTaskSuccessRequest - A Consumer that will call methods on SendTaskSuccessInput.Builder to create a request.TaskDoesNotExistExceptionInvalidOutputException - The provided JSON output data is not valid.InvalidTokenException - The provided token is not valid.TaskTimedOutExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartExecutionResponse startExecution(StartExecutionRequest startExecutionRequest) throws ExecutionLimitExceededException, ExecutionAlreadyExistsException, InvalidArnException, InvalidExecutionInputException, InvalidNameException, StateMachineDoesNotExistException, StateMachineDeletingException, ValidationException, AwsServiceException, SdkClientException, SfnException
Starts a state machine execution. If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.
A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For
example, the qualified state machine ARN
arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a
Distributed Map state with a label mapStateLabel in the state machine named
stateMachineName.
StartExecution is idempotent for STANDARD workflows. For a STANDARD
workflow, if StartExecution is called with the same name and input as a running execution, the call
will succeed and return the same response as the original request. If the execution is closed or if the input is
different, it will return a 400 ExecutionAlreadyExists error. Names can be reused after 90 days.
StartExecution is not idempotent for EXPRESS workflows.
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 not valid.InvalidExecutionInputException - The provided JSON input data is not valid.InvalidNameException - The provided name is not valid.StateMachineDoesNotExistException - The specified state machine does not exist.StateMachineDeletingException - The specified state machine is being deleted.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartExecutionResponse startExecution(Consumer<StartExecutionRequest.Builder> startExecutionRequest) throws ExecutionLimitExceededException, ExecutionAlreadyExistsException, InvalidArnException, InvalidExecutionInputException, InvalidNameException, StateMachineDoesNotExistException, StateMachineDeletingException, ValidationException, AwsServiceException, SdkClientException, SfnException
Starts a state machine execution. If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.
A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For
example, the qualified state machine ARN
arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a
Distributed Map state with a label mapStateLabel in the state machine named
stateMachineName.
StartExecution is idempotent for STANDARD workflows. For a STANDARD
workflow, if StartExecution is called with the same name and input as a running execution, the call
will succeed and return the same response as the original request. If the execution is closed or if the input is
different, it will return a 400 ExecutionAlreadyExists error. Names can be reused after 90 days.
StartExecution is not idempotent for EXPRESS workflows.
This is a convenience which creates an instance of the StartExecutionRequest.Builder avoiding the need to
create one manually via StartExecutionRequest.builder()
startExecutionRequest - A Consumer that will call methods on StartExecutionInput.Builder to create a request.ExecutionLimitExceededException - The maximum number of running executions has been reached. Running executions must end or be stopped
before a new execution can be started.ExecutionAlreadyExistsException - The execution has the same name as another execution (but a different input
).
Executions with the same name and input are considered idempotent.
InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.InvalidExecutionInputException - The provided JSON input data is not valid.InvalidNameException - The provided name is not valid.StateMachineDoesNotExistException - The specified state machine does not exist.StateMachineDeletingException - The specified state machine is being deleted.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartSyncExecutionResponse startSyncExecution(StartSyncExecutionRequest startSyncExecutionRequest) throws InvalidArnException, InvalidExecutionInputException, InvalidNameException, StateMachineDoesNotExistException, StateMachineDeletingException, StateMachineTypeNotSupportedException, AwsServiceException, SdkClientException, SfnException
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.
startSyncExecutionRequest - InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.InvalidExecutionInputException - The provided JSON input data is not valid.InvalidNameException - The provided name is not valid.StateMachineDoesNotExistException - The specified state machine does not exist.StateMachineDeletingException - The specified state machine is being deleted.StateMachineTypeNotSupportedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartSyncExecutionResponse startSyncExecution(Consumer<StartSyncExecutionRequest.Builder> startSyncExecutionRequest) throws InvalidArnException, InvalidExecutionInputException, InvalidNameException, StateMachineDoesNotExistException, StateMachineDeletingException, StateMachineTypeNotSupportedException, AwsServiceException, SdkClientException, SfnException
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.
This is a convenience which creates an instance of the StartSyncExecutionRequest.Builder avoiding the
need to create one manually via StartSyncExecutionRequest.builder()
startSyncExecutionRequest - A Consumer that will call methods on StartSyncExecutionInput.Builder to create a request.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.InvalidExecutionInputException - The provided JSON input data is not valid.InvalidNameException - The provided name is not valid.StateMachineDoesNotExistException - The specified state machine does not exist.StateMachineDeletingException - The specified state machine is being deleted.StateMachineTypeNotSupportedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopExecutionResponse stopExecution(StopExecutionRequest stopExecutionRequest) throws ExecutionDoesNotExistException, InvalidArnException, ValidationException, AwsServiceException, SdkClientException, SfnException
Stops an execution.
This API action is not supported by EXPRESS state machines.
stopExecutionRequest - ExecutionDoesNotExistException - The specified execution does not exist.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopExecutionResponse stopExecution(Consumer<StopExecutionRequest.Builder> stopExecutionRequest) throws ExecutionDoesNotExistException, InvalidArnException, ValidationException, AwsServiceException, SdkClientException, SfnException
Stops an execution.
This API action is not supported by EXPRESS state machines.
This is a convenience which creates an instance of the StopExecutionRequest.Builder avoiding the need to
create one manually via StopExecutionRequest.builder()
stopExecutionRequest - A Consumer that will call methods on StopExecutionInput.Builder to create a request.ExecutionDoesNotExistException - The specified execution does not exist.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidArnException, ResourceNotFoundException, TooManyTagsException, AwsServiceException, SdkClientException, SfnException
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: _ . : / = + - @.
tagResourceRequest - InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.ResourceNotFoundException - Could not find the referenced resource. Only state machine and activity ARNs are supported.TooManyTagsException - You've exceeded the number of tags allowed for a resource. See the Limits Topic in the Step
Functions Developer Guide.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidArnException, ResourceNotFoundException, TooManyTagsException, AwsServiceException, SdkClientException, SfnException
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: _ . : / = + - @.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceInput.Builder to create a request.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.ResourceNotFoundException - Could not find the referenced resource. Only state machine and activity ARNs are supported.TooManyTagsException - You've exceeded the number of tags allowed for a resource. See the Limits Topic in the Step
Functions Developer Guide.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InvalidArnException, ResourceNotFoundException, AwsServiceException, SdkClientException, SfnException
Remove a tag from a Step Functions resource
untagResourceRequest - InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.ResourceNotFoundException - Could not find the referenced resource. Only state machine and activity ARNs are supported.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InvalidArnException, ResourceNotFoundException, AwsServiceException, SdkClientException, SfnException
Remove a tag from a Step Functions resource
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceInput.Builder to create a request.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.ResourceNotFoundException - Could not find the referenced resource. Only state machine and activity ARNs are supported.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateMapRunResponse updateMapRun(UpdateMapRunRequest updateMapRunRequest) throws ResourceNotFoundException, InvalidArnException, ValidationException, AwsServiceException, SdkClientException, SfnException
Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure.
updateMapRunRequest - ResourceNotFoundException - Could not find the referenced resource. Only state machine and activity ARNs are supported.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateMapRunResponse updateMapRun(Consumer<UpdateMapRunRequest.Builder> updateMapRunRequest) throws ResourceNotFoundException, InvalidArnException, ValidationException, AwsServiceException, SdkClientException, SfnException
Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure.
This is a convenience which creates an instance of the UpdateMapRunRequest.Builder avoiding the need to
create one manually via UpdateMapRunRequest.builder()
updateMapRunRequest - A Consumer that will call methods on UpdateMapRunInput.Builder to create a request.ResourceNotFoundException - Could not find the referenced resource. Only state machine and activity ARNs are supported.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateStateMachineResponse updateStateMachine(UpdateStateMachineRequest updateStateMachineRequest) throws InvalidArnException, InvalidDefinitionException, InvalidLoggingConfigurationException, InvalidTracingConfigurationException, MissingRequiredParameterException, StateMachineDeletingException, StateMachineDoesNotExistException, ValidationException, AwsServiceException, SdkClientException, SfnException
Updates an existing state machine by modifying its definition, roleArn, or
loggingConfiguration. Running executions will continue to use the previous definition
and roleArn. You must include at least one of definition or roleArn or you
will receive a MissingRequiredParameter error.
If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.
A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For
example, the qualified state machine ARN
arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a
Distributed Map state with a label mapStateLabel in the state machine named
stateMachineName.
All StartExecution calls within a few seconds will use the updated definition and
roleArn. Executions started immediately after calling UpdateStateMachine may use the
previous state machine definition and roleArn.
updateStateMachineRequest - InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.InvalidDefinitionException - The provided Amazon States Language definition is not valid.InvalidLoggingConfigurationExceptionInvalidTracingConfigurationException - Your tracingConfiguration key does not match, or enabled has not been set to
true or false.MissingRequiredParameterException - Request is missing a required parameter. This error occurs if both definition and
roleArn are not specified.StateMachineDeletingException - The specified state machine is being deleted.StateMachineDoesNotExistException - The specified state machine does not exist.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateStateMachineResponse updateStateMachine(Consumer<UpdateStateMachineRequest.Builder> updateStateMachineRequest) throws InvalidArnException, InvalidDefinitionException, InvalidLoggingConfigurationException, InvalidTracingConfigurationException, MissingRequiredParameterException, StateMachineDeletingException, StateMachineDoesNotExistException, ValidationException, AwsServiceException, SdkClientException, SfnException
Updates an existing state machine by modifying its definition, roleArn, or
loggingConfiguration. Running executions will continue to use the previous definition
and roleArn. You must include at least one of definition or roleArn or you
will receive a MissingRequiredParameter error.
If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.
A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For
example, the qualified state machine ARN
arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a
Distributed Map state with a label mapStateLabel in the state machine named
stateMachineName.
All StartExecution calls within a few seconds will use the updated definition and
roleArn. Executions started immediately after calling UpdateStateMachine may use the
previous state machine definition and roleArn.
This is a convenience which creates an instance of the UpdateStateMachineRequest.Builder avoiding the
need to create one manually via UpdateStateMachineRequest.builder()
updateStateMachineRequest - A Consumer that will call methods on UpdateStateMachineInput.Builder to create a request.InvalidArnException - The provided Amazon Resource Name (ARN) is not valid.InvalidDefinitionException - The provided Amazon States Language definition is not valid.InvalidLoggingConfigurationExceptionInvalidTracingConfigurationException - Your tracingConfiguration key does not match, or enabled has not been set to
true or false.MissingRequiredParameterException - Request is missing a required parameter. This error occurs if both definition and
roleArn are not specified.StateMachineDeletingException - The specified state machine is being deleted.StateMachineDoesNotExistException - The specified state machine does not exist.ValidationException - The input does not satisfy the constraints specified by an Amazon Web Services service.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.SfnException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic SfnClient create()
SfnClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static SfnClientBuilder builder()
SfnClient.static ServiceMetadata serviceMetadata()
default SfnServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.