AWS Step Functions AWS Step Functions API
The AWS Step Functions API from AWS Step Functions — 26 operation(s) for aws step functions.
AWS Step Functions AWS Step Functions API is one of 8 APIs that AWS Step Functions publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include AWS Step Functions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, and pricing.
This API exposes 26 operations across 26 paths, and defines 173 schemas. It is described by OpenAPI 3.2.0, at version 2016-11-23.
Requests are made against 4 base URLs: http://states.{region}.amazonaws.com, https://states.{region}.amazonaws.com, http://states.{region}.amazonaws.com.cn, https://states.{region}.amazonaws.com.cn.
26 operations
26 paths
173 schemas
26 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
AWS Step Functions AWS Step Functions API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac— Amazon Signature authorization v4
Paths & Operations 26
Across 26 paths, the API surfaces 26 operations — 26 POST. Each is listed below with its method, path, parameters, and response codes.
AWS Step Functions 26
POST
/#X-Amz-Target=AWSStepFunctions.CreateActivity
AWS Step Functions - Create Activity
POST
/#X-Amz-Target=AWSStepFunctions.CreateStateMachine
AWS Step Functions - Create State Machine
POST
/#X-Amz-Target=AWSStepFunctions.DeleteActivity
AWS Step Functions - Delete Activity
POST
/#X-Amz-Target=AWSStepFunctions.DeleteStateMachine
AWS Step Functions - Delete State Machine
POST
/#X-Amz-Target=AWSStepFunctions.DescribeActivity
AWS Step Functions - Describe Activity
POST
/#X-Amz-Target=AWSStepFunctions.DescribeExecution
AWS Step Functions - Describe Execution
POST
/#X-Amz-Target=AWSStepFunctions.DescribeMapRun
AWS Step Functions - Describe Map Run
POST
/#X-Amz-Target=AWSStepFunctions.DescribeStateMachine
AWS Step Functions - Describe State Machine
POST
/#X-Amz-Target=AWSStepFunctions.DescribeStateMachineForExecution
AWS Step Functions - Describe State Machine for Execution
POST
/#X-Amz-Target=AWSStepFunctions.GetActivityTask
AWS Step Functions - Get Activity Task
POST
/#X-Amz-Target=AWSStepFunctions.GetExecutionHistory
AWS Step Functions - Get Execution History
POST
/#X-Amz-Target=AWSStepFunctions.ListActivities
AWS Step Functions - List Activities
POST
/#X-Amz-Target=AWSStepFunctions.ListExecutions
AWS Step Functions - List Executions
POST
/#X-Amz-Target=AWSStepFunctions.ListMapRuns
AWS Step Functions - List Map Runs
POST
/#X-Amz-Target=AWSStepFunctions.ListStateMachines
AWS Step Functions - List State Machines
POST
/#X-Amz-Target=AWSStepFunctions.ListTagsForResource
AWS Step Functions - List Tags for Resource
POST
/#X-Amz-Target=AWSStepFunctions.SendTaskFailure
AWS Step Functions - Send Task Failure
POST
/#X-Amz-Target=AWSStepFunctions.SendTaskHeartbeat
AWS Step Functions - Send Task Heartbeat
POST
/#X-Amz-Target=AWSStepFunctions.SendTaskSuccess
AWS Step Functions - Send Task Success
POST
/#X-Amz-Target=AWSStepFunctions.StartExecution
AWS Step Functions - Start Execution
POST
/#X-Amz-Target=AWSStepFunctions.StartSyncExecution
AWS Step Functions - Start Sync Execution
POST
/#X-Amz-Target=AWSStepFunctions.StopExecution
AWS Step Functions - Stop Execution
POST
/#X-Amz-Target=AWSStepFunctions.TagResource
AWS Step Functions - Tag Resource
POST
/#X-Amz-Target=AWSStepFunctions.UntagResource
AWS Step Functions - Untag Resource
POST
/#X-Amz-Target=AWSStepFunctions.UpdateMapRun
AWS Step Functions - Update Map Run
POST
/#X-Amz-Target=AWSStepFunctions.UpdateStateMachine
AWS Step Functions - Update State Machine
Schemas 173
The contract defines 173 schemas that model the data the API accepts and returns. The most detailed are HistoryEvent (38 properties), DescribeExecutionOutput (14 properties), StartSyncExecutionOutput (14 properties), DescribeStateMachineOutput (10 properties). Each schema is shown below with its type and property counts.
SendTaskSuccessOutput
object
ExecutionTimedOutEventDetails
object
Contains details about the execution timeout that occurred during the execution.
2 properties
ActivityScheduleFailedEventDetails
object
Contains details about an activity schedule failure that occurred during an execution.
2 properties
CreateStateMachineOutput
object
2 properties
2 required
ListTagsForResourceOutput
object
1 property
ListStateMachinesOutput
object
2 properties
1 required
InvalidToken
DescribeActivityOutput
object
3 properties
3 required
GetActivityTaskInput
object
2 properties
1 required
UntagResourceInput
object
2 properties
2 required
TracingConfiguration
object
Selects whether or not the state machine's X-Ray tracing is enabled. Default is false
1 property
LambdaFunctionFailedEventDetails
object
Contains details about a Lambda function that failed during an execution.
2 properties
ActivityLimitExceeded
StateMachineLimitExceeded
LogLevel
string
Tag
object
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…
2 properties
SendTaskHeartbeatInput
object
1 property
1 required
TaskStartedEventDetails
object
Contains details about the start of a task during an execution.
2 properties
2 required
LambdaFunctionScheduleFailedEventDetails
object
Contains details about a failed Lambda function schedule event that occurred during an execution.
2 properties
DeleteActivityOutput
object
Definition
string
Name
string
TaskToken
string
ValidationException
DescribeMapRunOutput
object
10 properties
9 required
LambdaFunctionTimedOutEventDetails
object
Contains details about a Lambda function timeout that occurred during an execution.
2 properties
ExecutionStartedEventDetails
object
Contains details about the start of the execution.
3 properties
TagValue
string
ExecutionLimitExceeded
ActivityListItem
object
Contains details about an activity.
3 properties
3 required
ActivityTimedOutEventDetails
object
Contains details about an activity timeout that occurred during an execution.
2 properties
InvalidLoggingConfiguration
ToleratedFailureCount
integer
MapRunExecutionCounts
object
Contains details about all of the child workflow executions started by a Map Run.
8 properties
8 required
IncludeExecutionData
boolean
StateMachineListItem
object
Contains details about the state machine.
4 properties
4 required
PageSize
integer
Enabled
boolean
MapRunListItem
object
Contains details about a specific Map Run.
5 properties
4 required
ActivityWorkerLimitExceeded
DeleteStateMachineOutput
object
StopExecutionOutput
object
1 property
1 required
ListActivitiesInput
object
2 properties
MaxConcurrency
integer
ExecutionFailedEventDetails
object
Contains details about an execution failure event.
2 properties
GetActivityTaskOutput
object
2 properties
ExecutionSucceededEventDetails
object
Contains details about the successful termination of the execution.
2 properties
SensitiveCause
string
LogDestination
object
1 property
SyncExecutionStatus
string
LambdaFunctionScheduledEventDetails
object
Contains details about a Lambda function scheduled during an execution.
5 properties
1 required
MapRunList
array
TaskTimedOut
ActivityDoesNotExist
StopExecutionInput
object
3 properties
1 required
DescribeStateMachineForExecutionInput
object
1 property
1 required
SensitiveError
string
InvalidOutput
MissingRequiredParameter
HistoryEventType
string
UntagResourceOutput
object
SendTaskSuccessInput
object
2 properties
2 required
MapIterationEventDetails
object
Contains details about an iteration of a Map state.
2 properties
StateMachineList
array
StateMachineStatus
string
TraceHeader
string
HistoryEvent
object
Contains details about the events of an execution.
38 properties
3 required
TooManyTags
ToleratedFailurePercentage
number
LongArn
string
ActivityList
array
MapRunFailedEventDetails
object
Contains details about a Map Run failure event that occurred during a state machine execution.
2 properties
ResourceNotFound
InvalidExecutionInput
DescribeStateMachineForExecutionOutput
object
9 properties
5 required
ListActivitiesOutput
object
2 properties
1 required
GetExecutionHistoryOutput
object
2 properties
1 required
StartExecutionOutput
object
2 properties
2 required
DescribeExecutionInput
object
1 property
1 required
HistoryEventExecutionDataDetails
object
Provides details about input or output in an execution history event.
1 property
DeleteStateMachineInput
object
1 property
1 required
MapStateStartedEventDetails
object
Details about a Map state that was started.
1 property
StartSyncExecutionInput
object
4 properties
1 required
ListMapRunsOutput
object
2 properties
1 required
DescribeExecutionOutput
object
14 properties
4 required
TaskSucceededEventDetails
object
Contains details about the successful completion of a task state.
4 properties
2 required
BilledMemoryUsed
integer
CreateActivityOutput
object
2 properties
2 required
DescribeActivityInput
object
1 property
1 required
MapRunStatus
string
TaskDoesNotExist
TaskCredentials
object
Contains details about the credentials that Step Functions uses for a task.
1 property
TagResourceInput
object
2 properties
2 required
ActivitySucceededEventDetails
object
Contains details about an activity that successfully terminated during an execution.
2 properties
StartExecutionInput
object
4 properties
1 required
DescribeMapRunInput
object
1 property
1 required
SendTaskHeartbeatOutput
object
StateEnteredEventDetails
object
Contains details about a state entered during an execution.
3 properties
1 required
Identity
string
TaskFailedEventDetails
object
Contains details about a task failure event.
4 properties
2 required
Timestamp
string
StartSyncExecutionOutput
object
14 properties
4 required
BilledDuration
integer
LogDestinationList
array
StateMachineAlreadyExists
UpdateStateMachineInput
object
5 properties
1 required
InvalidDefinition
SensitiveDataJobInput
string
SendTaskFailureOutput
object
InvalidTracingConfiguration
HistoryEventList
array
Contains details about the events that occurred during an execution.
GetExecutionHistoryInput
object
5 properties
1 required
ExecutionAlreadyExists
InvalidArn
TaskStartFailedEventDetails
object
Contains details about a task that failed to start during an execution.
4 properties
2 required
LambdaFunctionSucceededEventDetails
object
Contains details about a Lambda function that successfully terminated during an execution.
2 properties
TagKey
string
StateExitedEventDetails
object
Contains details about an exit from a state during an execution.
3 properties
1 required
includedDetails
boolean
TaskSubmittedEventDetails
object
Contains details about a task submitted to a resource .
4 properties
2 required
UpdateStateMachineOutput
object
1 property
1 required
EventId
integer
TagKeyList
array
CloudWatchLogsLogGroup
object
1 property
UpdateMapRunOutput
object
ListExecutionsInput
object
5 properties
SensitiveData
string
ExecutionAbortedEventDetails
object
Contains details about an abort of an execution.
2 properties
ListExecutionsOutput
object
2 properties
1 required
MapRunStartedEventDetails
object
Contains details about a Map Run that was started during a state machine execution.
1 property
ConnectorParameters
string
ListTagsForResourceInput
object
1 property
1 required
CreateStateMachineInput
object
7 properties
3 required
TagList
array
ExecutionDoesNotExist
DescribeStateMachineInput
object
1 property
1 required
PageToken
string
StateMachineTypeNotSupported
UpdateMapRunInput
object
4 properties
1 required
SendTaskFailureInput
object
3 properties
1 required
StateMachineDeleting
TaskSubmitFailedEventDetails
object
Contains details about a task that failed to submit during an execution.
4 properties
2 required
DeleteActivityInput
object
1 property
1 required
CreateActivityInput
object
2 properties
1 required
ExecutionListItem
object
Contains details about an execution.
8 properties
5 required
ReverseOrder
boolean
StateMachineType
string
MapRunLabel
string
TaskTimedOutEventDetails
object
Contains details about a resource timeout that occurred during an execution.
4 properties
2 required
ExecutionStatus
string
DescribeStateMachineOutput
object
10 properties
6 required
UnsignedLong
integer
TaskScheduledEventDetails
object
Contains details about a task scheduled during an execution.
7 properties
4 required
ActivityFailedEventDetails
object
Contains details about an activity that failed during an execution.
2 properties
ListMapRunsInput
object
3 properties
1 required
ActivityStartedEventDetails
object
Contains details about the start of an activity during an execution.
1 property
ListStateMachinesInput
object
2 properties
ActivityScheduledEventDetails
object
Contains details about an activity scheduled during an execution.
5 properties
1 required
InvalidName
MapRunItemCounts
object
Contains details about items that were processed in all of the child workflow executions that were started by a Map Run.
8 properties
8 required
TagResourceOutput
object
CloudWatchEventsExecutionDataDetails
object
Provides details about execution input or output.
1 property
truncated
boolean
LambdaFunctionStartFailedEventDetails
object
Contains details about a lambda function that failed to start during an execution.
2 properties
StateMachineDoesNotExist
ListExecutionsPageToken
string
TimeoutInSeconds
integer
ExecutionList
array
LoggingConfiguration
object
The LoggingConfiguration data type is used to set CloudWatch Logs options.
3 properties
BillingDetails
object
An object that describes workflow billing details.
2 properties
Arn
string
IncludeExecutionDataGetExecutionHistory
boolean
UnsignedInteger
integer
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from AWS Step Functions 7
Other APIs AWS Step Functions publishes across the network.
AWS Step Functions State Machines API
AWS Step Functions AWS Step Functions #X Amz Target=AWSStepFunctions.CreateStat… API
AWS Step Functions AWS Step Functions #X Amz Target=AWSStepFunctions.DeleteStat… API
AWS Step Functions AWS Step Functions #X Amz Target=AWSStepFunctions.DescribeSt… API
AWS Step Functions AWS Step Functions #X Amz Target=AWSStepFunctions.ListStateM… API
AWS Step Functions AWS Step Functions #X Amz Target=AWSStepFunctions.PublishSta… API
AWS Step Functions AWS Step Functions #X Amz Target=AWSStepFunctions.UpdateStat… API
#AWS Step Functions
Where this information came from
This is an independent, third-party profile of AWS Step Functions AWS Step Functions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.