Amazon Step Functions · Schema
DescribeExecutionOutput
DescribeExecutionOutput schema from Amazon Step Functions API
OrchestrationServerlessState MachineWorkflow
Properties
| Name | Type | Description |
|---|---|---|
| executionArn | object | |
| stateMachineArn | object | |
| name | object | |
| status | object | |
| startDate | object | |
| stopDate | object | |
| input | object | |
| inputDetails | object | |
| output | object | |
| outputDetails | object | |
| traceHeader | object | |
| mapRunArn | object | |
| error | object | |
| cause | object | |
| stateMachineVersionArn | object | |
| stateMachineAliasArn | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-step-functions/refs/heads/main/json-schema/amazon-step-functions-describe-execution-output-schema.json",
"title": "DescribeExecutionOutput",
"description": "DescribeExecutionOutput schema from Amazon Step Functions API",
"type": "object",
"properties": {
"executionArn": {
"allOf": [
{
"$ref": "#/components/schemas/Arn"
},
{
"description": "The Amazon Resource Name (ARN) that identifies the execution."
}
]
},
"stateMachineArn": {
"allOf": [
{
"$ref": "#/components/schemas/Arn"
},
{
"description": "The Amazon Resource Name (ARN) of the executed stated machine."
}
]
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/Name"
},
{
"description": "<p>The name of the execution.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>< > { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ & , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul> <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>"
}
]
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/ExecutionStatus"
},
{
"description": "The current status of the execution."
}
]
},
"startDate": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "The date the execution is started."
}
]
},
"stopDate": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "If the execution ended, the date the execution stopped."
}
]
},
"input": {
"allOf": [
{
"$ref": "#/components/schemas/SensitiveData"
},
{
"description": "The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding."
}
]
},
"inputDetails": {
"$ref": "#/components/schemas/CloudWatchEventsExecutionDataDetails"
},
"output": {
"allOf": [
{
"$ref": "#/components/schemas/SensitiveData"
},
{
"description": "<p>The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p> <note> <p>This field is set only if the execution succeeds. If the execution fails, this field is null.</p> </note>"
}
]
},
"outputDetails": {
"$ref": "#/components/schemas/CloudWatchEventsExecutionDataDetails"
},
"traceHeader": {
"allOf": [
{
"$ref": "#/components/schemas/TraceHeader"
},
{
"description": "The X-Ray trace header that was passed to the execution."
}
]
},
"mapRunArn": {
"allOf": [
{
"$ref": "#/components/schemas/LongArn"
},
{
"description": "The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution."
}
]
},
"error": {
"allOf": [
{
"$ref": "#/components/schemas/SensitiveError"
},
{
"description": "The error string if the state machine execution failed."
}
]
},
"cause": {
"allOf": [
{
"$ref": "#/components/schemas/SensitiveCause"
},
{
"description": "The cause string if the state machine execution failed."
}
]
},
"stateMachineVersionArn": {
"allOf": [
{
"$ref": "#/components/schemas/Arn"
},
{
"description": "<p>The Amazon Resource Name (ARN) of the state machine version associated with the execution. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, <code>stateMachineARN:1</code>.</p> <p>If you start an execution from a <code>StartExecution</code> request without specifying a state machine version or alias ARN, Step Functions returns a null value.</p>"
}
]
},
"stateMachineAliasArn": {
"allOf": [
{
"$ref": "#/components/schemas/Arn"
},
{
"description": "<p>The Amazon Resource Name (ARN) of the state machine alias associated with the execution. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, <code>stateMachineARN:PROD</code>.</p> <p>If you start an execution from a <code>StartExecution</code> request with a state machine version ARN, this field will be null.</p>"
}
]
}
},
"required": [
"executionArn",
"stateMachineArn",
"status",
"startDate"
]
}