AWS Step Functions · Schema
DescribeStateMachineOutput
Amazon Web ServicesiPaaSOrchestrationServerlessWorkflowsState Machines
Properties
| Name | Type | Description |
|---|---|---|
| stateMachineArn | string | The Amazon Resource Name (ARN) that identifies the state machine. If you specified a state machine version ARN in your request, the API returns the version ARN. The version ARN is a combination of sta |
| name | string | The name of the state machine. A name must not contain: white space brackets { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F |
| status | string | The current status of the state machine. |
| definition | string | The Amazon States Language definition of the state machine. See Amazon States Language. If called with includedData = METADATA_ONLY, the returned definition will be {}. |
| roleArn | string | The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role maintains security by granting Step Functions access to Amazon Web Services resources.) |
| type | string | The type of the state machine (STANDARD or EXPRESS). |
| creationDate | string | The date the state machine is created. For a state machine version, creationDate is the date the version was created. |
| loggingConfiguration | object | |
| tracingConfiguration | object | |
| label | string | A user-defined or an auto-generated string that identifies a Map state. This parameter is present only if the stateMachineArn specified in input is a qualified state machine ARN. |
| revisionId | string | The revision identifier for the state machine. Use the revisionId parameter to compare between versions of a state machine configuration used for executions without performing a diff of the properties |
| description | string | The description of the state machine version. |
| encryptionConfiguration | object | |
| variableReferences | object | A map of state name to a list of variables referenced by that state. States that do not use variable references will not be shown in the response. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/aws-step-functions/json-schema/aws-step-functions-describe-state-machine-output-schema.json",
"title": "DescribeStateMachineOutput",
"x-generated": "2026-11-11",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/aws-step-functions-state-machines-api-openapi.yml#/components/schemas/DescribeStateMachineOutput",
"type": "object",
"properties": {
"stateMachineArn": {
"type": "string",
"description": "The Amazon Resource Name (ARN) that identifies the state machine. If you specified a state machine version ARN in your request, the API returns the version ARN. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1."
},
"name": {
"type": "string",
"description": "The name of the state machine. A name must not contain: white space brackets { } [ ] wildcard characters ? * special characters \" # % \\ ^ | ~ ` $ & , ; : / control characters (U+0000-001F, U+007F-009F, U+FFFE-FFFF) surrogates (U+D800-DFFF) invalid characters ( U+10FFFF) To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _."
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETING"
],
"description": "The current status of the state machine."
},
"definition": {
"type": "string",
"description": "The Amazon States Language definition of the state machine. See Amazon States Language. If called with includedData = METADATA_ONLY, the returned definition will be {}."
},
"roleArn": {
"type": "string",
"description": "The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role maintains security by granting Step Functions access to Amazon Web Services resources.)"
},
"type": {
"type": "string",
"enum": [
"STANDARD",
"EXPRESS"
],
"description": "The type of the state machine (STANDARD or EXPRESS)."
},
"creationDate": {
"type": "string",
"format": "date-time",
"description": "The date the state machine is created. For a state machine version, creationDate is the date the version was created."
},
"loggingConfiguration": {
"$ref": "#/$defs/LoggingConfiguration"
},
"tracingConfiguration": {
"$ref": "#/$defs/TracingConfiguration"
},
"label": {
"type": "string",
"description": "A user-defined or an auto-generated string that identifies a Map state. This parameter is present only if the stateMachineArn specified in input is a qualified state machine ARN."
},
"revisionId": {
"type": "string",
"description": "The revision identifier for the state machine. Use the revisionId parameter to compare between versions of a state machine configuration used for executions without performing a diff of the properties, such as definition and roleArn."
},
"description": {
"type": "string",
"description": "The description of the state machine version."
},
"encryptionConfiguration": {
"$ref": "#/$defs/EncryptionConfiguration"
},
"variableReferences": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "A map of state name to a list of variables referenced by that state. States that do not use variable references will not be shown in the response."
}
},
"required": [
"stateMachineArn",
"name",
"definition",
"roleArn",
"type",
"creationDate"
],
"$defs": {
"CloudWatchLogsLogGroup": {
"type": "object",
"properties": {
"logGroupArn": {
"type": "string",
"description": "The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN must end with :*"
}
}
},
"EncryptionConfiguration": {
"type": "object",
"properties": {
"kmsKeyId": {
"type": "string",
"description": "An alias, alias ARN, key ID, or key ARN of a symmetric encryption KMS key to encrypt data. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN."
},
"kmsDataKeyReusePeriodSeconds": {
"type": "integer",
"description": "Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call GenerateDataKey. Only applies to customer managed keys."
},
"type": {
"type": "string",
"enum": [
"AWS_OWNED_KEY",
"CUSTOMER_MANAGED_KMS_KEY"
],
"description": "Encryption type"
}
},
"required": [
"type"
]
},
"LogDestination": {
"type": "object",
"properties": {
"cloudWatchLogsLogGroup": {
"$ref": "#/$defs/CloudWatchLogsLogGroup"
}
}
},
"LoggingConfiguration": {
"type": "object",
"properties": {
"level": {
"type": "string",
"enum": [
"ALL",
"ERROR",
"FATAL",
"OFF"
],
"description": "Defines which category of execution history events are logged."
},
"includeExecutionData": {
"type": "boolean",
"description": "Determines whether execution data is included in your log. When set to false, data is excluded."
},
"destinations": {
"type": "array",
"items": {
"$ref": "#/$defs/LogDestination"
},
"description": "An array of objects that describes where your execution history events will be logged. Limited to size 1. Required, if your log level is not set to OFF."
}
}
},
"TracingConfiguration": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "When set to true, X-Ray tracing is enabled."
}
}
}
}
}
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-describe-state-machine-output"
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.