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 #X Amz Target=AWSStepFunctions.StartSyncExecution API

The #X Amz Target=AWSStepFunctions.StartSyncExecution API from AWS Step Functions — 1 operation(s) for #x amz target=awsstepfunctions.startsyncexecution.

AWS Step Functions #X Amz Target=AWSStepFunctions.StartSyncExecution API is one of 26 APIs that AWS Step Functions publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include #X Amz Target=AWSStepFunctions.StartSyncExecution. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and an API reference.

This API exposes 1 operation across 1 path, and defines 21 schemas. It is described by OpenAPI 3.0.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.

1 operations 1 paths 21 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

AWS Step Functions #X Amz Target=AWSStepFunctions.StartSyncExecution 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 1

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

#X Amz Target=AWSStepFunctions.StartSyncExecution 1
POST
/#X-Amz-Target=AWSStepFunctions.StartSyncExecution
AWS Step Functions - Start Sync Execution
StartSyncExecution 8 params body → 200480481482483484485

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are StartSyncExecutionOutput (14 properties), StartSyncExecutionInput (4 properties), BillingDetails (2 properties), CloudWatchEventsExecutionDataDetails (1 property). Each schema is shown below with its type and property counts.

StateMachineDoesNotExist
InvalidName
BilledMemoryUsed
integer
TraceHeader
string
StateMachineTypeNotSupported
CloudWatchEventsExecutionDataDetails
object
Provides details about execution input or output.
1 property
StartSyncExecutionInput
object
4 properties 1 required
StateMachineDeleting
BillingDetails
object
An object that describes workflow billing details.
2 properties
StartSyncExecutionOutput
object
14 properties 4 required
SensitiveCause
string
InvalidExecutionInput
SensitiveData
string
SyncExecutionStatus
string
BilledDuration
integer
includedDetails
boolean
Arn
string
Timestamp
string
Name
string
SensitiveError
string
InvalidArn

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aws-step-functions-x-amz-target-awsstepfunctions-startsyncexecution-api-openapi.yml Raw ↑

Other APIs AWS Step Functions publishes across the network.

AWS Step Functions #X Amz Target=AWSStepFunctions.CreateActivity API
AWS Step Functions #X Amz Target=AWSStepFunctions.CreateStateMachine API
AWS Step Functions #X Amz Target=AWSStepFunctions.DeleteActivity API
AWS Step Functions #X Amz Target=AWSStepFunctions.DeleteStateMachine API
AWS Step Functions #X Amz Target=AWSStepFunctions.DescribeActivity API
AWS Step Functions #X Amz Target=AWSStepFunctions.DescribeExecution API
AWS Step Functions #X Amz Target=AWSStepFunctions.DescribeMapRun API
AWS Step Functions #X Amz Target=AWSStepFunctions.DescribeStateMachine API
AWS Step Functions #X Amz Target=AWSStepFunctions.DescribeStateMachineForExecution API
AWS Step Functions #X Amz Target=AWSStepFunctions.GetActivityTask API
AWS Step Functions #X Amz Target=AWSStepFunctions.GetExecutionHistory API
AWS Step Functions #X Amz Target=AWSStepFunctions.ListActivities API