AWS Step Functions
Step Functions With Step Functions, you can create workflows, also called state machines , to build distributed applications, automate processes, orchestrate…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Step Functions
With Step Functions, you can create workflows, also called state machines , to build distributed applications, automate processes, orchestrate microservices, and create data and machine learning pipelines.
Through the Step Functions API, you can create, list, update, and delete state machines, activities, and other data types. You can start, stop, and redrive your state machines. Your activity workers can send task success, heartbeat, and failure responses.
With API calls, you can also manage other aspects of your workflow, such as tags, versions, and aliases.
For more information about developing solutions with Step Functions, see the
Step Functions Developer Guide
.
If you use the Step Functions API actions using Amazon Web Services SDK integrations, make sure the API actions are in camel case and parameter names are in Pascal case. For example, you might use Step Functions API action startSyncExecution and specify its parameter as StateMachineArn .
Endpoints 37
- POSTCreate activity
/#X-Amz-Target=AWSStepFunctions.CreateActivityCreates 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… - POSTCreate state machine
/#X-Amz-Target=AWSStepFunctions.CreateStateMachineCreates 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 (… - POSTCreate state machine alias
/#X-Amz-Target=AWSStepFunctions.CreateStateMachineAliasCreates an alias for a state machine that points to one or two versions of the same state machine. You can set your application to call StartExecution with an… - POSTDelete activity
/#X-Amz-Target=AWSStepFunctions.DeleteActivityDeletes an activity. - POSTDelete state machine
/#X-Amz-Target=AWSStepFunctions.DeleteStateMachineDeletes a state machine. This is an asynchronous operation. It sets the state machine's status to DELETING and begins the deletion process. A state machine is… - POSTDelete state machine alias
/#X-Amz-Target=AWSStepFunctions.DeleteStateMachineAliasDeletes a state machine alias . After you delete a state machine alias, you can't use it to start executions. When you delete a state machine alias, Step… - POSTDelete state machine version
/#X-Amz-Target=AWSStepFunctions.DeleteStateMachineVersionDeletes a state machine version . After you delete a version, you can't call StartExecution using that version's ARN or use the version with a state machine… - POSTDescribe activity
/#X-Amz-Target=AWSStepFunctions.DescribeActivityDescribes an activity. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. - POSTDescribe execution
/#X-Amz-Target=AWSStepFunctions.DescribeExecutionProvides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant… - POSTDescribe map run
/#X-Amz-Target=AWSStepFunctions.DescribeMapRunProvides information about a Map Run's configuration, progress, and results. If you've redriven a Map Run, this API action also returns information about the… - POSTDescribe state machine
/#X-Amz-Target=AWSStepFunctions.DescribeStateMachineProvides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration. A qualified state machine ARN can either… - POSTDescribe state machine alias
/#X-Amz-Target=AWSStepFunctions.DescribeStateMachineAliasReturns details about a state machine alias . Related operations: CreateStateMachineAlias ListStateMachineAliases UpdateStateMachineAlias… - POSTDescribe state machine for execution
/#X-Amz-Target=AWSStepFunctions.DescribeStateMachineForExecutionProvides information about a state machine's definition, its execution role ARN, and configuration. If a Map Run dispatched the execution, this action returns… - POSTGet activity task
/#X-Amz-Target=AWSStepFunctions.GetActivityTaskUsed 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… - POSTGet execution history
/#X-Amz-Target=AWSStepFunctions.GetExecutionHistoryReturns 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.… - POSTList activities
/#X-Amz-Target=AWSStepFunctions.ListActivitiesLists the existing activities. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.… - POSTList executions
/#X-Amz-Target=AWSStepFunctions.ListExecutionsLists 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… - POSTList map runs
/#X-Amz-Target=AWSStepFunctions.ListMapRunsLists 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… - POSTList state machine aliases
/#X-Amz-Target=AWSStepFunctions.ListStateMachineAliasesLists aliases for a specified state machine ARN. Results are sorted by time, with the most recently created aliases listed first. To list aliases that… - POSTList state machine versions
/#X-Amz-Target=AWSStepFunctions.ListStateMachineVersionsLists versions for the specified state machine Amazon Resource Name (ARN). The results are sorted in descending order of the version creation time. If… - POSTList state machines
/#X-Amz-Target=AWSStepFunctions.ListStateMachinesLists the existing state machines. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each… - POSTList tags for resource
/#X-Amz-Target=AWSStepFunctions.ListTagsForResourceList tags for a given resource. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @ . - POSTPublish state machine version
/#X-Amz-Target=AWSStepFunctions.PublishStateMachineVersionCreates a version from the current revision of a state machine. Use versions to create immutable snapshots of your state machine. You can start executions… - POSTRedrive execution
/#X-Amz-Target=AWSStepFunctions.RedriveExecutionRestarts unsuccessful executions of Standard workflows that didn't complete successfully in the last 14 days. These include failed, aborted, or timed out… - POSTSend task failure
/#X-Amz-Target=AWSStepFunctions.SendTaskFailureUsed by activity workers, Task states using the callback pattern, and optionally Task states using the job run pattern to report that the task identified by… - POSTSend task heartbeat
/#X-Amz-Target=AWSStepFunctions.SendTaskHeartbeatUsed by activity workers and Task states using the callback pattern, and optionally Task states using the job run pattern to report to Step Functions that the… - POSTSend task success
/#X-Amz-Target=AWSStepFunctions.SendTaskSuccessUsed by activity workers, Task states using the callback pattern, and optionally Task states using the job run pattern to report that the task identified by… - POSTStart execution
/#X-Amz-Target=AWSStepFunctions.StartExecutionStarts a state machine execution. A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or… - POSTStart sync execution
/#X-Amz-Target=AWSStepFunctions.StartSyncExecutionStarts a Synchronous Express state machine execution. StartSyncExecution is not available for STANDARD workflows. StartSyncExecution will return a 200 OK… - POSTStop execution
/#X-Amz-Target=AWSStepFunctions.StopExecutionStops an execution. This API action is not supported by EXPRESS state machines. For an execution with encryption enabled, Step Functions will encrypt the… - POSTTag resource
/#X-Amz-Target=AWSStepFunctions.TagResourceAdd 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… - POSTTest state
/#X-Amz-Target=AWSStepFunctions.TestStateAccepts the definition of a single state and executes it. You can test a state without creating a state machine or updating an existing state machine. Using… - POSTUntag resource
/#X-Amz-Target=AWSStepFunctions.UntagResourceRemove a tag from a Step Functions resource - POSTUpdate map run
/#X-Amz-Target=AWSStepFunctions.UpdateMapRunUpdates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure. - POSTUpdate state machine
/#X-Amz-Target=AWSStepFunctions.UpdateStateMachineUpdates an existing state machine by modifying its definition , roleArn , loggingConfiguration , or EncryptionConfiguration . Running executions will continue… - POSTUpdate state machine alias
/#X-Amz-Target=AWSStepFunctions.UpdateStateMachineAliasUpdates the configuration of an existing state machine alias by modifying its description or routingConfiguration . You must specify at least one of the… - POSTValidate state machine definition
/#X-Amz-Target=AWSStepFunctions.ValidateStateMachineDefinitionValidates the syntax of a state machine definition specified in Amazon States Language (ASL), a JSON-based, structured language. You can validate that a state…
API details
- Base URL
https://states.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 37 operations on 37 pathsPOST 37
- Description format
- AWS Smithy model, API version
2016-11-23 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS Step Functions in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Step Functions collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Create activity” (POST /#X-Amz-Target=AWSStepFunctions.CreateActivity), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS Step Functions?
Step Functions With Step Functions, you can create workflows, also called state machines , to build distributed applications, automate processes, orchestrate… It is listed under Developer tools and has 37 endpoints.
Who publishes the AWS Step Functions?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS Step Functions?
Requests go to https://states.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS Step Functions?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS Step Functions have?
37 operations on 37 paths (37 POST).
Is forking the AWS Step Functions free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.