{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-systems-manager/json-schema/amazon-systems-manager-get-document-result-schema.json",
  "title": "GetDocumentResult",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-systems-manager-documents-api-openapi.yml#/components/schemas/GetDocumentResult",
  "type": "object",
  "properties": {
    "Name": {
      "type": "string",
      "description": "The name of the SSM document."
    },
    "CreatedDate": {
      "type": "string",
      "format": "date-time",
      "description": "The date the SSM document was created."
    },
    "DisplayName": {
      "type": "string",
      "description": "The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument."
    },
    "VersionName": {
      "type": "string",
      "description": "The version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed."
    },
    "DocumentVersion": {
      "type": "string",
      "description": "The document version."
    },
    "Status": {
      "type": "string",
      "enum": [
        "Creating",
        "Active",
        "Updating",
        "Deleting",
        "Failed"
      ],
      "description": "The status of the SSM document, such as Creating, Active, Updating, Failed, and Deleting."
    },
    "StatusInformation": {
      "type": "string",
      "description": "A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, \"The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct.\""
    },
    "Content": {
      "type": "string",
      "description": "The contents of the SSM document."
    },
    "DocumentType": {
      "type": "string",
      "enum": [
        "Command",
        "Policy",
        "Automation",
        "Session",
        "Package",
        "ApplicationConfiguration",
        "ApplicationConfigurationSchema",
        "DeploymentStrategy",
        "ChangeCalendar",
        "Automation.ChangeTemplate",
        "ProblemAnalysis",
        "ProblemAnalysisTemplate",
        "CloudFormation",
        "ConformancePackTemplate",
        "QuickSetup",
        "ManualApprovalPolicy",
        "AutoApprovalPolicy"
      ],
      "description": "The document type."
    },
    "DocumentFormat": {
      "type": "string",
      "enum": [
        "YAML",
        "JSON",
        "TEXT"
      ],
      "description": "The document format, either JSON or YAML."
    },
    "Requires": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/DocumentRequires"
      },
      "description": "A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document."
    },
    "AttachmentsContent": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/AttachmentContent"
      },
      "description": "A description of the document attachments, including names, locations, sizes, and so on."
    },
    "ReviewStatus": {
      "type": "string",
      "enum": [
        "APPROVED",
        "NOT_REVIEWED",
        "PENDING",
        "REJECTED"
      ],
      "description": "The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document. Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED. Only one version of an SSM document can be in review, or PENDING, at a time."
    }
  },
  "$defs": {
    "AttachmentContent": {
      "type": "object",
      "properties": {
        "Name": {
          "type": "string",
          "description": "The name of an attachment."
        },
        "Size": {
          "type": "integer",
          "description": "The size of an attachment in bytes."
        },
        "Hash": {
          "type": "string",
          "description": "The cryptographic hash value of the document content."
        },
        "HashType": {
          "type": "string",
          "enum": [
            "Sha256"
          ],
          "description": "The hash algorithm used to calculate the hash value."
        },
        "Url": {
          "type": "string",
          "description": "The URL location of the attachment content."
        }
      }
    },
    "DocumentRequires": {
      "type": "object",
      "properties": {
        "Name": {
          "type": "string",
          "description": "The name of the required SSM document. The name can be an Amazon Resource Name (ARN)."
        },
        "Version": {
          "type": "string",
          "description": "The document version required by the current document."
        },
        "RequireType": {
          "type": "string",
          "description": "The document type of the required SSM document."
        },
        "VersionName": {
          "type": "string",
          "description": "An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed."
        }
      },
      "required": [
        "Name"
      ]
    }
  }
}