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.GetExecutionHistory API

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

AWS Step Functions #X Amz Target=AWSStepFunctions.GetExecutionHistory 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.GetExecutionHistory. 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 58 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 58 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.GetExecutionHistory 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.GetExecutionHistory 1
POST
/#X-Amz-Target=AWSStepFunctions.GetExecutionHistory
AWS Step Functions - Get Execution History
GetExecutionHistory 10 params body → 200480481482

Schemas 58

The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are HistoryEvent (38 properties), TaskScheduledEventDetails (7 properties), GetExecutionHistoryInput (5 properties), ActivityScheduledEventDetails (5 properties). Each schema is shown below with its type and property counts.

ActivityTimedOutEventDetails
object
Contains details about an activity timeout that occurred during an execution.
2 properties
StateExitedEventDetails
object
Contains details about an exit from a state during an execution.
3 properties 1 required
LambdaFunctionScheduleFailedEventDetails
object
Contains details about a failed Lambda function schedule event that occurred during an execution.
2 properties
ExecutionTimedOutEventDetails
object
Contains details about the execution timeout that occurred during the execution.
2 properties
LongArn
string
ActivityStartedEventDetails
object
Contains details about the start of an activity during an execution.
1 property
LambdaFunctionFailedEventDetails
object
Contains details about a Lambda function that failed during an execution.
2 properties
StateEnteredEventDetails
object
Contains details about a state entered during an execution.
3 properties 1 required
UnsignedInteger
integer
ExecutionStartedEventDetails
object
Contains details about the start of the execution.
3 properties
PageSize
integer
EventId
integer
HistoryEventList
array
Contains details about the events that occurred during an execution.
ExecutionSucceededEventDetails
object
Contains details about the successful termination of the execution.
2 properties
HistoryEventExecutionDataDetails
object
Provides details about input or output in an execution history event.
1 property
ExecutionFailedEventDetails
object
Contains details about an execution failure event.
2 properties
TaskStartFailedEventDetails
object
Contains details about a task that failed to start during an execution.
4 properties 2 required
ActivityScheduledEventDetails
object
Contains details about an activity scheduled during an execution.
5 properties 1 required
TaskSucceededEventDetails
object
Contains details about the successful completion of a task state.
4 properties 2 required
HistoryEvent
object
Contains details about the events of an execution.
38 properties 3 required
LambdaFunctionSucceededEventDetails
object
Contains details about a Lambda function that successfully terminated during an execution.
2 properties
truncated
boolean
TaskCredentials
object
Contains details about the credentials that Step Functions uses for a task.
1 property
LambdaFunctionStartFailedEventDetails
object
Contains details about a lambda function that failed to start during an execution.
2 properties
LambdaFunctionScheduledEventDetails
object
Contains details about a Lambda function scheduled during an execution.
5 properties 1 required
PageToken
string
TaskFailedEventDetails
object
Contains details about a task failure event.
4 properties 2 required
ConnectorParameters
string
MapIterationEventDetails
object
Contains details about an iteration of a Map state.
2 properties
ExecutionAbortedEventDetails
object
Contains details about an abort of an execution.
2 properties
TaskSubmittedEventDetails
object
Contains details about a task submitted to a resource .
4 properties 2 required
MapRunStartedEventDetails
object
Contains details about a Map Run that was started during a state machine execution.
1 property
ReverseOrder
boolean
TaskTimedOutEventDetails
object
Contains details about a resource timeout that occurred during an execution.
4 properties 2 required
HistoryEventType
string
ActivitySucceededEventDetails
object
Contains details about an activity that successfully terminated during an execution.
2 properties
TaskSubmitFailedEventDetails
object
Contains details about a task that failed to submit during an execution.
4 properties 2 required
SensitiveCause
string
GetExecutionHistoryInput
object
5 properties 1 required
GetExecutionHistoryOutput
object
2 properties 1 required
SensitiveData
string
IncludeExecutionDataGetExecutionHistory
boolean
LambdaFunctionTimedOutEventDetails
object
Contains details about a Lambda function timeout that occurred during an execution.
2 properties
MapStateStartedEventDetails
object
Details about a Map state that was started.
1 property
MapRunFailedEventDetails
object
Contains details about a Map Run failure event that occurred during a state machine execution.
2 properties
Arn
string
InvalidToken
ActivityFailedEventDetails
object
Contains details about an activity that failed during an execution.
2 properties
TimeoutInSeconds
integer
Timestamp
string
Name
string
TaskScheduledEventDetails
object
Contains details about a task scheduled during an execution.
7 properties 4 required
Identity
string
SensitiveError
string
InvalidArn
ActivityScheduleFailedEventDetails
object
Contains details about an activity schedule failure that occurred during an execution.
2 properties
ExecutionDoesNotExist
TaskStartedEventDetails
object
Contains details about the start of a task during an execution.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aws-step-functions-x-amz-target-awsstepfunctions-getexecutionhistory-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.ListActivities API
AWS Step Functions #X Amz Target=AWSStepFunctions.ListExecutions API