Expand description
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 .
If you’re using the service, you’re probably looking for StepFunctionsClient and StepFunctions.
Structs§
- Activity
Failed Event Details Contains details about an activity that failed during an execution.
- Activity
List Item Contains details about an activity.
- Activity
Schedule Failed Event Details Contains details about an activity schedule failure that occurred during an execution.
- Activity
Scheduled Event Details Contains details about an activity scheduled during an execution.
- Activity
Started Event Details Contains details about the start of an activity during an execution.
- Activity
Succeeded Event Details Contains details about an activity that successfully terminated during an execution.
- Activity
Timed OutEvent Details Contains details about an activity timeout that occurred during an execution.
- Billing
Details An object that describes workflow billing details.
- Cloud
Watch Events Execution Data Details Provides details about execution input or output.
- Cloud
Watch Logs LogGroup - Create
Activity Input - Create
Activity Output - Create
State Machine Input - Create
State Machine Output - Delete
Activity Input - Delete
Activity Output - Delete
State Machine Input - Delete
State Machine Output - Describe
Activity Input - Describe
Activity Output - Describe
Execution Input - Describe
Execution Output - Describe
State Machine ForExecution Input - Describe
State Machine ForExecution Output - Describe
State Machine Input - Describe
State Machine Output - Execution
Aborted Event Details Contains details about an abort of an execution.
- Execution
Failed Event Details Contains details about an execution failure event.
- Execution
List Item Contains details about an execution.
- Execution
Started Event Details Contains details about the start of the execution.
- Execution
Succeeded Event Details Contains details about the successful termination of the execution.
- Execution
Timed OutEvent Details Contains details about the execution timeout that occurred during the execution.
- GetActivity
Task Input - GetActivity
Task Output - GetExecution
History Input - GetExecution
History Output - History
Event Contains details about the events of an execution.
- History
Event Execution Data Details Provides details about input or output in an execution history event.
- Lambda
Function Failed Event Details Contains details about a lambda function that failed during an execution.
- Lambda
Function Schedule Failed Event Details Contains details about a failed lambda function schedule event that occurred during an execution.
- Lambda
Function Scheduled Event Details Contains details about a lambda function scheduled during an execution.
- Lambda
Function Start Failed Event Details Contains details about a lambda function that failed to start during an execution.
- Lambda
Function Succeeded Event Details Contains details about a lambda function that successfully terminated during an execution.
- Lambda
Function Timed OutEvent Details Contains details about a lambda function timeout that occurred during an execution.
- List
Activities Input - List
Activities Output - List
Executions Input - List
Executions Output - List
State Machines Input - List
State Machines Output - List
Tags ForResource Input - List
Tags ForResource Output - LogDestination
- Logging
Configuration The
LoggingConfigurationdata type is used to set CloudWatch Logs options.- MapIteration
Event Details Contains details about an iteration of a Map state.
- MapState
Started Event Details Details about a Map state that was started.
- Send
Task Failure Input - Send
Task Failure Output - Send
Task Heartbeat Input - Send
Task Heartbeat Output - Send
Task Success Input - Send
Task Success Output - Start
Execution Input - Start
Execution Output - Start
Sync Execution Input - Start
Sync Execution Output - State
Entered Event Details Contains details about a state entered during an execution.
- State
Exited Event Details Contains details about an exit from a state during an execution.
- State
Machine List Item Contains details about the state machine.
- Step
Functions Client - A client for the AWS SFN API.
- Stop
Execution Input - Stop
Execution Output - Tag
Tags are key-value pairs that can be associated with Step Functions state machines and activities.
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:
_ . : / = + - @.- TagResource
Input - TagResource
Output - Task
Failed Event Details Contains details about a task failure event.
- Task
Scheduled Event Details Contains details about a task scheduled during an execution.
- Task
Start Failed Event Details Contains details about a task that failed to start during an execution.
- Task
Started Event Details Contains details about the start of a task during an execution.
- Task
Submit Failed Event Details Contains details about a task that failed to submit during an execution.
- Task
Submitted Event Details Contains details about a task submitted to a resource .
- Task
Succeeded Event Details Contains details about the successful completion of a task state.
- Task
Timed OutEvent Details Contains details about a resource timeout that occurred during an execution.
- Tracing
Configuration Selects whether or not the state machine's AWS X-Ray tracing is enabled. Default is
false- Untag
Resource Input - Untag
Resource Output - Update
State Machine Input - Update
State Machine Output
Enums§
- Create
Activity Error - Errors returned by CreateActivity
- Create
State Machine Error - Errors returned by CreateStateMachine
- Delete
Activity Error - Errors returned by DeleteActivity
- Delete
State Machine Error - Errors returned by DeleteStateMachine
- Describe
Activity Error - Errors returned by DescribeActivity
- Describe
Execution Error - Errors returned by DescribeExecution
- Describe
State Machine Error - Errors returned by DescribeStateMachine
- Describe
State Machine ForExecution Error - Errors returned by DescribeStateMachineForExecution
- GetActivity
Task Error - Errors returned by GetActivityTask
- GetExecution
History Error - Errors returned by GetExecutionHistory
- List
Activities Error - Errors returned by ListActivities
- List
Executions Error - Errors returned by ListExecutions
- List
State Machines Error - Errors returned by ListStateMachines
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- Send
Task Failure Error - Errors returned by SendTaskFailure
- Send
Task Heartbeat Error - Errors returned by SendTaskHeartbeat
- Send
Task Success Error - Errors returned by SendTaskSuccess
- Start
Execution Error - Errors returned by StartExecution
- Start
Sync Execution Error - Errors returned by StartSyncExecution
- Stop
Execution Error - Errors returned by StopExecution
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
State Machine Error - Errors returned by UpdateStateMachine
Traits§
- Step
Functions - Trait representing the capabilities of the AWS SFN API. AWS SFN clients implement this trait.