DescribeCustomImageResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/cloudera/main/json-schema/cloudera-describe-custom-image-response-schema.json",
  "title": "DescribeCustomImageResponse",
  "description": "The response object holding the data of the image retrieved from the given custom catalog.",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cloudera-imagecatalog-api-openapi.yml#/components/schemas/DescribeCustomImageResponse",
  "type": "object",
  "properties": {
    "imageId": {
      "type": "string",
      "description": "Image UUID"
    },
    "imageDate": {
      "type": "integer",
      "format": "int64",
      "description": "Image creation date"
    },
    "imageType": {
      "description": "Image type - either \"FREEIPA\" or \"RUNTIME\"",
      "$ref": "#/$defs/VmImageType"
    },
    "sourceImageId": {
      "type": "string",
      "description": "Customized image UUID"
    },
    "sourceImageDate": {
      "type": "integer",
      "format": "int64",
      "description": "Customized image creation date"
    },
    "versions": {
      "type": "object",
      "description": "Package versions",
      "additionalProperties": {
        "type": "string"
      }
    },
    "provider": {
      "description": "Cloud provider - either AWS, AZURE or GCP",
      "$ref": "#/$defs/VmImageProvider"
    },
    "baseParcelUrl": {
      "type": "string",
      "description": "Base parcel URL"
    },
    "vmImages": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/VmImageResponse"
      },
      "description": "List of images"
    }
  },
  "$defs": {
    "VmImageProvider": {
      "type": "string",
      "description": "Object representing a valid cloud provider name.\n `AWS` - The image is an AWS VM image `AZURE` - The image is an Azure VM image `GCP` - The image is a GCP VM image",
      "enum": [
        "AWS",
        "AZURE",
        "GCP"
      ]
    },
    "VmImageResponse": {
      "type": "object",
      "description": "Model holding information about a custom VM image and the cloud region it belongs to. The format of the image reference is specific to the cloud provider, e.g. URL in case of Azure, AMI ID in case of AWS.",
      "properties": {
        "region": {
          "type": "string",
          "description": "Region"
        },
        "imageReference": {
          "type": "string",
          "description": "Image reference"
        }
      }
    },
    "VmImageType": {
      "type": "string",
      "description": "Object representing a valid VM image type.\n `FREEIPA` - FreeIPA image `RUNTIME` - Cloudera Runtime image",
      "enum": [
        "FREEIPA",
        "RUNTIME"
      ]
    }
  }
}