Amazon Step Functions · JSON Structure

Amazon Step Functions Get Execution History Input Structure

GetExecutionHistoryInput schema from Amazon Step Functions API

Type: object Properties: 5 Required: 1
OrchestrationServerlessState MachineWorkflow

GetExecutionHistoryInput is a JSON Structure definition published by Amazon Step Functions, describing 5 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

executionArn maxResults reverseOrder nextToken includeExecutionData

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "type": "object",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-step-functions/refs/heads/main/json-structure/amazon-step-functions-get-execution-history-input-structure.json",
  "name": "GetExecutionHistoryInput",
  "description": "GetExecutionHistoryInput schema from Amazon Step Functions API",
  "properties": {
    "executionArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Arn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the execution."
        }
      ]
    },
    "maxResults": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PageSize"
        },
        {
          "description": "<p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.</p> <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>"
        }
      ]
    },
    "reverseOrder": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ReverseOrder"
        },
        {
          "description": "Lists events in descending order of their <code>timeStamp</code>."
        }
      ]
    },
    "nextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PageToken"
        },
        {
          "description": "If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken</i> error."
        }
      ]
    },
    "includeExecutionData": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IncludeExecutionDataGetExecutionHistory"
        },
        {
          "description": "You can select whether execution data (input or output of a history event) is returned. The default is <code>true</code>."
        }
      ]
    }
  },
  "required": [
    "executionArn"
  ]
}