Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AWS Step Functions State Machines API

Create, describe, update, delete, and list state machines

AWS Step Functions State Machines API is published by AWS Step Functions on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include State Machines. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and pricing.

This API exposes 1 operation across 1 path, and defines 7 schemas. It is described by OpenAPI 3.0.3, at version 2016-11-23.

Requests are made against a single base URL, https://states.{region}.amazonaws.com.

1 operations 1 paths 7 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2016-11-23
Base URL
https://states.{region}.amazonaws.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

AWS Step Functions State Machines API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (awsSigV4). By default, every request must be authenticated.

  • awsSigV4 — AWS Signature Version 4. The authorization header includes the credential, signed headers, and signature. Use AWS SDK for automatic signing.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

State Machines 1

Create, describe, update, delete, and list state machines

POST
/
Create State Machine
createStateMachine 1 param body → 200400409

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are CreateStateMachineRequest (10 properties), CreateStateMachineResponse (3 properties), EncryptionConfiguration (3 properties), LoggingConfiguration (3 properties). Each schema is shown below with its type and property counts.

CreateStateMachineRequest
object
10 properties 3 required
LoggingConfiguration
object
3 properties
EncryptionConfiguration
object
3 properties
TracingConfiguration
object
1 property
CreateStateMachineResponse
object
3 properties
Error
object
2 properties
Tag
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

step-functions-state-machines-api-openapi.yml Raw ↑