{ "$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-state-machine-output-schema.json", "title": "DescribeStateMachineOutput", "description": "DescribeStateMachineOutput schema from Amazon Step Functions API", "type": "object", "properties": { "stateMachineArn": { "allOf": [ { "$ref": "#/components/schemas/Arn" }, { "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": { "allOf": [ { "$ref": "#/components/schemas/Name" }, { "description": "

The name of the state machine.

A name must not contain:

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

" } ] }, "status": { "allOf": [ { "$ref": "#/components/schemas/StateMachineStatus" }, { "description": "The current status of the state machine." } ] }, "definition": { "allOf": [ { "$ref": "#/components/schemas/Definition" }, { "description": "The Amazon States Language definition of the state machine. See Amazon States Language." } ] }, "roleArn": { "allOf": [ { "$ref": "#/components/schemas/Arn" }, { "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": { "allOf": [ { "$ref": "#/components/schemas/StateMachineType" }, { "description": "The type of the state machine (STANDARD or EXPRESS)." } ] }, "creationDate": { "allOf": [ { "$ref": "#/components/schemas/Timestamp" }, { "description": "

The date the state machine is created.

For a state machine version, creationDate is the date the version was created.

" } ] }, "loggingConfiguration": { "$ref": "#/components/schemas/LoggingConfiguration" }, "tracingConfiguration": { "allOf": [ { "$ref": "#/components/schemas/TracingConfiguration" }, { "description": "Selects whether X-Ray tracing is enabled." } ] }, "label": { "allOf": [ { "$ref": "#/components/schemas/MapRunLabel" }, { "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": { "allOf": [ { "$ref": "#/components/schemas/RevisionId" }, { "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": { "allOf": [ { "$ref": "#/components/schemas/VersionDescription" }, { "description": "The description of the state machine version." } ] } }, "required": [ "stateMachineArn", "name", "definition", "roleArn", "type", "creationDate" ] }