SFN class

AWS Step Functions is a service that lets you coordinate the components of distributed applications and microservices using visual workflows.

Constructors

SFN({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createActivity({required String name, List<Tag>? tags}) → Future<CreateActivityOutput>
Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to AWS Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity.
createStateMachine({required String definition, required String name, required String roleArn, LoggingConfiguration? loggingConfiguration, List<Tag>? tags, TracingConfiguration? tracingConfiguration, StateMachineType? type}) → Future<CreateStateMachineOutput>
Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. For more information, see Amazon States Language in the AWS Step Functions User Guide.
deleteActivity({required String activityArn}) → Future<void>
Deletes an activity.
deleteStateMachine({required String stateMachineArn}) → Future<void>
Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process.
describeActivity({required String activityArn}) → Future<DescribeActivityOutput>
Describes an activity.
describeExecution({required String executionArn}) → Future<DescribeExecutionOutput>
Describes an execution. This API action is not supported by EXPRESS state machines.
describeStateMachine({required String stateMachineArn}) → Future<DescribeStateMachineOutput>
Describes a state machine.
describeStateMachineForExecution({required String executionArn}) → Future<DescribeStateMachineForExecutionOutput>
Describes the state machine associated with a specific execution. This API action is not supported by EXPRESS state machines.
getActivityTask({required String activityArn, String? workerName}) → Future<GetActivityTaskOutput>
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.
getExecutionHistory({required String executionArn, bool? includeExecutionData, int? maxResults, String? nextToken, bool? reverseOrder}) → Future<GetExecutionHistoryOutput>
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.
listActivities({int? maxResults, String? nextToken}) → Future<ListActivitiesOutput>
Lists the existing activities.
listExecutions({required String stateMachineArn, int? maxResults, String? nextToken, ExecutionStatus? statusFilter}) → Future<ListExecutionsOutput>
Lists the executions of a state machine that meet the filtering criteria. Results are sorted by time, with the most recent execution first.
listStateMachines({int? maxResults, String? nextToken}) → Future<ListStateMachinesOutput>
Lists the existing state machines.
listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceOutput>
List tags for a given resource.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
sendTaskFailure({required String taskToken, String? cause, String? error}) → Future<void>
Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed.
sendTaskHeartbeat({required String taskToken}) → Future<void>
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.
sendTaskSuccess({required String output, required String taskToken}) → Future<void>
Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken completed successfully.
startExecution({required String stateMachineArn, String? input, String? name, String? traceHeader}) → Future<StartExecutionOutput>
Starts a state machine execution.
startSyncExecution({required String stateMachineArn, String? input, String? name, String? traceHeader}) → Future<StartSyncExecutionOutput>
Starts a Synchronous Express state machine execution.
stopExecution({required String executionArn, String? cause, String? error}) → Future<StopExecutionOutput>
Stops an execution.
tagResource({required String resourceArn, required List<Tag> tags}) → Future<void>
Add a tag to a Step Functions resource.
toString() → String
A string representation of this object.
inherited
untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>
Remove a tag from a Step Functions resource
updateStateMachine({required String stateMachineArn, String? definition, LoggingConfiguration? loggingConfiguration, String? roleArn, TracingConfiguration? tracingConfiguration}) → Future<UpdateStateMachineOutput>
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.

Operators

operator ==(Object other) → bool
The equality operator.
inherited