aws_sfn
AWS Step Functions
AWS Step Functions is a service that lets you coordinate the components of distributed applications and microservices using visual workflows.
You can use Step Functions to build applications from individual components, each of which performs a discrete function, or task, allowing you to scale and change applications quickly. Step Functions provides a console that helps visualize the components of your application as a series of steps. Step Functions automatically triggers and tracks each step, and retries steps when there are errors, so your application executes predictably and in the right order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any issues.
Step Functions manages operations and underlying infrastructure to ensure your application is available at any scale. You can run tasks on AWS, your own servers, or any system that has access to AWS. You can access and use Step Functions using the console, the AWS SDKs, or an HTTP API. For more information about Step Functions, see the AWS Step Functions Developer Guide .Summary
Functions
-
create_activity(Client, Input)
Creates an activity.
- create_activity(Client, Input, Options)
-
create_state_machine(Client, Input)
Creates a state machine.
- create_state_machine(Client, Input, Options)
-
delete_activity(Client, Input)
Deletes an activity.
- delete_activity(Client, Input, Options)
-
delete_state_machine(Client, Input)
Deletes a state machine.
- delete_state_machine(Client, Input, Options)
-
describe_activity(Client, Input)
Describes an activity.
- describe_activity(Client, Input, Options)
-
describe_execution(Client, Input)
Describes an execution.
- describe_execution(Client, Input, Options)
-
describe_state_machine(Client, Input)
Describes a state machine.
- describe_state_machine(Client, Input, Options)
-
describe_state_machine_for_execution(Client, Input)
Describes the state machine associated with a specific execution.
- describe_state_machine_for_execution(Client, Input, Options)
-
get_activity_task(Client, Input)
Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine.
- get_activity_task(Client, Input, Options)
-
get_execution_history(Client, Input)
Returns the history of the specified execution as a list of events.
- get_execution_history(Client, Input, Options)
-
list_activities(Client, Input)
Lists the existing activities.
- list_activities(Client, Input, Options)
-
list_executions(Client, Input)
Lists the executions of a state machine that meet the filtering criteria.
- list_executions(Client, Input, Options)
-
list_state_machines(Client, Input)
Lists the existing state machines.
- list_state_machines(Client, Input, Options)
-
list_tags_for_resource(Client, Input)
List tags for a given resource.
- list_tags_for_resource(Client, Input, Options)
-
send_task_failure(Client, Input)
Used by activity workers and task states using the callback pattern to report that the task identified by the
taskToken
failed. - send_task_failure(Client, Input, Options)
-
send_task_heartbeat(Client, Input)
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. - send_task_heartbeat(Client, Input, Options)
-
send_task_success(Client, Input)
Used by activity workers and task states using the callback pattern to report that the task identified by the
taskToken
completed successfully. - send_task_success(Client, Input, Options)
-
start_execution(Client, Input)
Starts a state machine execution.
- start_execution(Client, Input, Options)
-
start_sync_execution(Client, Input)
Starts a Synchronous Express state machine execution.
- start_sync_execution(Client, Input, Options)
-
stop_execution(Client, Input)
Stops an execution.
- stop_execution(Client, Input, Options)
-
tag_resource(Client, Input)
Add a tag to a Step Functions resource.
- tag_resource(Client, Input, Options)
-
untag_resource(Client, Input)
Remove a tag from a Step Functions resource.
- untag_resource(Client, Input, Options)
-
update_state_machine(Client, Input)
Updates an existing state machine by modifying its
definition
,roleArn
, orloggingConfiguration
. - update_state_machine(Client, Input, Options)
Functions
create_activity(Client, Input)
Creates an activity.
An activity is a task that you write in any programming language and host
on any machine that has access to AWS Step Functions. Activities must poll
Step Functions using the GetActivityTask
API action and respond using
SendTask*
API actions. This function lets Step Functions know the
existence of your activity and returns an identifier for use in a state
machine and when polling from the activity.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
CreateActivity
is an idempotent API. Subsequent requests won’t create a
duplicate resource if it was already created. CreateActivity
's
idempotency check is based on the activity name
. If a following request
has different tags
values, Step Functions will ignore these differences
and treat it as an idempotent request of the previous. In this case,
tags
will not be updated, even if they are different.
create_activity(Client, Input, Options)
create_state_machine(Client, Input)
Creates a state machine.
A state machine consists of a collection of states that can do work
(Task
states), determine to which states to transition next (Choice
states), stop an execution with an error (Fail
states), and so on. State
machines are specified using a JSON-based, structured language. For more
information, see Amazon States Language in the AWS Step Functions User
Guide.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
CreateStateMachine
is an idempotent API. Subsequent requests won’t
create a duplicate resource if it was already created.
CreateStateMachine
's idempotency check is based on the state machine
name
, definition
, type
, LoggingConfiguration
and
TracingConfiguration
. If a following request has a different roleArn
or tags
, Step Functions will ignore these differences and treat it as an
idempotent request of the previous. In this case, roleArn
and tags
will not be updated, even if they are different.
create_state_machine(Client, Input, Options)
delete_activity(Client, Input)
Deletes an activity.
delete_activity(Client, Input, Options)
delete_state_machine(Client, Input)
Deletes a state machine.
This is an asynchronous operation: It sets the state machine's status to
DELETING
and begins the deletion process.
EXPRESS
state machines, the deletion will happen eventually (usually
less than a minute). Running executions may emit logs after
DeleteStateMachine
API is called.
delete_state_machine(Client, Input, Options)
describe_activity(Client, Input)
Describes an activity.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.describe_activity(Client, Input, Options)
describe_execution(Client, Input)
Describes an execution.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported byEXPRESS
state machines.
describe_execution(Client, Input, Options)
describe_state_machine(Client, Input)
Describes a state machine.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.describe_state_machine(Client, Input, Options)
describe_state_machine_for_execution(Client, Input)
Describes the state machine associated with a specific execution.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported byEXPRESS
state machines.
describe_state_machine_for_execution(Client, Input, Options)
get_activity_task(Client, Input)
Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine.
This initiates a long poll, where the service holds the HTTP connection
open and responds as soon as a task becomes available (i.e. an execution
of a task of this type is needed.) The maximum time the service holds on
to the request before responding is 60 seconds. If no task is available
within 60 seconds, the poll returns a taskToken
with a null string.
Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request).
Polling withGetActivityTask
can cause latency in some implementations.
See Avoid Latency When Polling for Activity Tasks in the Step Functions
Developer Guide.
get_activity_task(Client, Input, Options)
get_execution_history(Client, Input)
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.
EXPRESS
state machines.
get_execution_history(Client, Input, Options)
list_activities(Client, Input)
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.
list_activities(Client, Input, Options)
list_executions(Client, Input)
Lists the executions of a state machine that meet the filtering criteria.
Results are sorted by time, with the most recent execution first.
If nextToken
is returned, there are more results available. The value of
nextToken
is a unique pagination token for each page. Make the call
again using the returned token to retrieve the next page. Keep all other
arguments unchanged. Each pagination token expires after 24 hours. Using
an expired pagination token will return an HTTP 400 InvalidToken error.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
This API action is not supported byEXPRESS
state machines.
list_executions(Client, Input, Options)
list_state_machines(Client, Input)
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.
list_state_machines(Client, Input, Options)
list_tags_for_resource(Client, Input)
List tags for a given resource.
Tags may only contain Unicode letters, digits, white space, or these symbols:_ . : / = + - @
.
list_tags_for_resource(Client, Input, Options)
send_task_failure(Client, Input)
Used by activity workers and task states using the callback pattern
to report that the task identified by the taskToken
failed.
send_task_failure(Client, Input, Options)
send_task_heartbeat(Client, Input)
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.
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.
send_task_heartbeat(Client, Input, Options)
send_task_success(Client, Input)
Used by activity workers and task states using the callback pattern
to report that the task identified by the taskToken
completed
successfully.
send_task_success(Client, Input, Options)
start_execution(Client, Input)
Starts a state machine execution.
StartExecution
is idempotent. If StartExecution
is called with the
same name and input as a running execution, the call will succeed and
return the same response as the original request. If the execution is
closed or if the input is different, it will return a 400
ExecutionAlreadyExists
error. Names can be reused after 90 days.
start_execution(Client, Input, Options)
start_sync_execution(Client, Input)
Starts a Synchronous Express state machine execution.
start_sync_execution(Client, Input, Options)
stop_execution(Client, Input)
Stops an execution.
This API action is not supported byEXPRESS
state machines.
stop_execution(Client, Input, Options)
tag_resource(Client, Input)
Add a tag to a Step Functions resource.
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these symbols:_ . : / = + - @
.
tag_resource(Client, Input, Options)
untag_resource(Client, Input)
Remove a tag from a Step Functions resource
untag_resource(Client, Input, Options)
update_state_machine(Client, Input)
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.
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
.