AWS Step Functions · Schema
TestStateInput
Amazon Web ServicesiPaaSOrchestrationServerlessWorkflowsState Machines
Properties
| Name | Type | Description |
|---|---|---|
| definition | string | The Amazon States Language (ASL) definition of the state or state machine. |
| roleArn | string | The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state. |
| input | string | A string that contains the JSON input data for the state. |
| inspectionLevel | string | Determines the values to return when a state is tested. You can specify one of the following types: INFO: Shows the final state output. By default, Step Functions sets inspectionLevel to INFO if you d |
| revealSecrets | boolean | Specifies whether or not to include secret information in the test result. For HTTP Tasks, a secret includes the data that an EventBridge connection adds to modify the HTTP request headers, query para |
| variables | string | JSON object literal that sets variables used in the state under test. Object keys are the variable names and values are the variable values. |
| stateName | string | Denotes the particular state within a state machine definition to be tested. If this field is specified, the definition must contain a fully-formed state machine definition. |
| mock | object | |
| context | string | A JSON string representing a valid Context object for the state under test. This field may only be specified if a mock is specified in the same request. |
| stateConfiguration | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/aws-step-functions/json-schema/aws-step-functions-test-state-input-schema.json",
"title": "TestStateInput",
"x-generated": "2026-11-11",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/aws-step-functions-operations-api-openapi.yml#/components/schemas/TestStateInput",
"type": "object",
"properties": {
"definition": {
"type": "string",
"description": "The Amazon States Language (ASL) definition of the state or state machine."
},
"roleArn": {
"type": "string",
"description": "The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state."
},
"input": {
"type": "string",
"description": "A string that contains the JSON input data for the state."
},
"inspectionLevel": {
"type": "string",
"enum": [
"INFO",
"DEBUG",
"TRACE"
],
"description": "Determines the values to return when a state is tested. You can specify one of the following types: INFO: Shows the final state output. By default, Step Functions sets inspectionLevel to INFO if you don't specify a level. DEBUG: Shows the final state output along with the input and output data processing result. TRACE: Shows the HTTP request and response for an HTTP Task. This level also shows the final state output along with the input and output data processing result. Each of these levels also provide information about the status of the state execution and the next state to transition to."
},
"revealSecrets": {
"type": "boolean",
"description": "Specifies whether or not to include secret information in the test result. For HTTP Tasks, a secret includes the data that an EventBridge connection adds to modify the HTTP request headers, query parameters, and body. Step Functions doesn't omit any information included in the state definition or the HTTP response. If you set revealSecrets to true, you must make sure that the IAM user that calls the TestState API has permission for the states:RevealSecrets action. For an example of IAM policy that sets the states:RevealSecrets permission, see IAM permissions to test a state. Without this permi"
},
"variables": {
"type": "string",
"description": "JSON object literal that sets variables used in the state under test. Object keys are the variable names and values are the variable values."
},
"stateName": {
"type": "string",
"description": "Denotes the particular state within a state machine definition to be tested. If this field is specified, the definition must contain a fully-formed state machine definition."
},
"mock": {
"$ref": "#/$defs/MockInput"
},
"context": {
"type": "string",
"description": "A JSON string representing a valid Context object for the state under test. This field may only be specified if a mock is specified in the same request."
},
"stateConfiguration": {
"$ref": "#/$defs/TestStateConfiguration"
}
},
"required": [
"definition"
],
"$defs": {
"MockErrorOutput": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "A string denoting the error code of the exception thrown when invoking the tested state. This field is required if mock.errorOutput is specified."
},
"cause": {
"type": "string",
"description": "A string containing the cause of the exception thrown when executing the state's logic."
}
}
},
"MockInput": {
"type": "object",
"properties": {
"result": {
"type": "string",
"description": "A JSON string containing the mocked result of the state invocation."
},
"errorOutput": {
"$ref": "#/$defs/MockErrorOutput"
},
"fieldValidationMode": {
"type": "string",
"enum": [
"STRICT",
"PRESENT",
"NONE"
],
"description": "Determines the level of strictness when validating mocked results against their respective API models. Values include: STRICT: All required fields must be present, and all present fields must conform to the API's schema. PRESENT: All present fields must conform to the API's schema. NONE: No validation is performed. If no value is specified, the default value is STRICT."
}
}
},
"TestStateConfiguration": {
"type": "object",
"properties": {
"retrierRetryCount": {
"type": "integer",
"description": "The number of retry attempts that have occurred for the state's Retry that applies to the mocked error."
},
"errorCausedByState": {
"type": "string",
"description": "The name of the state from which an error originates when an error is mocked for a Map or Parallel state."
},
"mapIterationFailureCount": {
"type": "integer",
"description": "The number of Map state iterations that failed during the Map state invocation."
},
"mapItemReaderData": {
"type": "string",
"description": "The data read by ItemReader in Distributed Map states as found in its original source."
}
}
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/aws-step-functions-test-state-input"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.