aws-elixir v0.5.0 AWS.StepFunctions
AWS Step Functions
AWS Step Functions is a web service that enables you to coordinate the components of distributed applications and microservices using visual workflows. You build applications from individual components that each perform a discrete function, or task, allowing you to scale and change applications quickly. Step Functions provides a graphical console to visualize the components of your application as a series of steps. It automatically triggers and tracks each step, and retries when there are errors, so your application executes in order and as expected, every time. Step Functions logs the state of each step, so when things do go wrong, you can diagnose and debug problems quickly.
Step Functions manages the operations and underlying infrastructure for you to ensure your application is available at any scale. You can run tasks on the AWS cloud, on your own servers, or an any system that has access to AWS. Step Functions can be accessed and used with the Step Functions console, the AWS SDKs (included with your Beta release invitation email), or an HTTP API (the subject of this document).
Summary
Functions
Creates an activity
Creates a state machine
Deletes an activity
Deletes a state machine. This is an asynchronous operation— it sets the state machine’s status to “DELETING” and begins the delete process
Describes an activity
Describes an execution
Describes a state machine
Used by workers to retrieve a task (with the specified activity ARN)
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 will return an empty result, that is, the taskToken returned is an
empty string
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. The results may be split into multiple pages. To retrieve subsequent
pages, make the call again using the nextToken returned by the previous
call
Lists the existing activities. The results may be split into multiple
pages. To retrieve subsequent pages, make the call again using the
nextToken returned by the previous call
Lists the executions of a state machine that meet the filtering criteria.
The results may be split into multiple pages. To retrieve subsequent pages,
make the call again using the nextToken returned by the previous call
Lists the existing state machines. The results may be split into multiple
pages. To retrieve subsequent pages, make the call again using the
nextToken returned by the previous call
Used by workers to report that the task identified by the taskToken
failed
Used by workers to report to the service that the task represented by the
specified taskToken is still making progress. This action resets the
Heartbeat clock. The Heartbeat threshold is specified in the state
machine’s Amazon States Language definition. This action does not in itself
create an event in the execution history. However, if the task times out,
the execution history will contain an ActivityTimedOut event
Used by workers to report that the task identified by the taskToken
completed successfully
Starts a state machine execution
Stops an execution
Functions
Deletes a state machine. This is an asynchronous operation— it sets the state machine’s status to “DELETING” and begins the delete process.
Used by workers to retrieve a task (with the specified activity ARN)
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 will return an empty result, that is, the taskToken returned is an
empty string.
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. The results may be split into multiple pages. To retrieve subsequent
pages, make the call again using the nextToken returned by the previous
call.
Lists the existing activities. The results may be split into multiple
pages. To retrieve subsequent pages, make the call again using the
nextToken returned by the previous call.
Lists the executions of a state machine that meet the filtering criteria.
The results may be split into multiple pages. To retrieve subsequent pages,
make the call again using the nextToken returned by the previous call.
Lists the existing state machines. The results may be split into multiple
pages. To retrieve subsequent pages, make the call again using the
nextToken returned by the previous call.
Used by workers to report that the task identified by the taskToken
failed.
Used by workers to report to the service that the task represented by the
specified taskToken is still making progress. This action resets the
Heartbeat clock. The Heartbeat threshold is specified in the state
machine’s Amazon States Language definition. This action does not in itself
create an event in the execution history. However, if the task times out,
the execution history will contain an ActivityTimedOut event.
the liveliness of the task.
Used by workers to report that the task identified by the taskToken
completed successfully.