Amazon EC2 Image Builder · JSON Structure

Ec2 Image Builder Import Vm Image Request Structure

ImportVmImageRequest schema from EC2 Image Builder

Type: object Properties: 8 Required: 5
Amazon Web ServicesAutomationContainer ImagesEC2Image BuildingVirtual Machine Images

ImportVmImageRequest is a JSON Structure definition published by Amazon EC2 Image Builder, describing 8 properties, of which 5 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

name semanticVersion description platform osVersion vmImportTaskId tags clientToken

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-ec2-image-builder/refs/heads/main/json-structure/ec2-image-builder-import-vm-image-request-structure.json",
  "name": "ImportVmImageRequest",
  "description": "ImportVmImageRequest schema from EC2 Image Builder",
  "type": "object",
  "properties": {
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonEmptyString"
        },
        {
          "description": "The name of the base image that is created by the import process."
        }
      ]
    },
    "semanticVersion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VersionNumber"
        },
        {
          "description": "<p>The semantic version to attach to the base image that was created during the import process. This version follows the semantic version syntax.</p> <note> <p>The semantic version has four nodes: &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can assign values for the first three, and can filter on all of them.</p> <p> <b>Assignment:</b> For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.</p> <p> <b>Patterns:</b> You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.</p> </note>"
        }
      ]
    },
    "description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonEmptyString"
        },
        {
          "description": "The description for the base image that is created by the import process."
        }
      ]
    },
    "platform": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Platform"
        },
        {
          "description": "The operating system platform for the imported VM."
        }
      ]
    },
    "osVersion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OsVersion"
        },
        {
          "description": "The operating system version for the imported VM."
        }
      ]
    },
    "vmImportTaskId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonEmptyString"
        },
        {
          "description": "The <code>importTaskId</code> (API) or <code>ImportTaskId</code> (CLI) from the Amazon EC2 VM import process. Image Builder retrieves information from the import process to pull in the AMI that is created from the VM source as the base image for your recipe."
        }
      ]
    },
    "tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagMap"
        },
        {
          "description": "Tags that are attached to the import resources."
        }
      ]
    },
    "clientToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientToken"
        },
        {
          "description": "Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html\">Ensuring idempotency</a> in the <i>Amazon EC2 API Reference</i>."
        }
      ]
    }
  },
  "required": [
    "name",
    "semanticVersion",
    "platform",
    "vmImportTaskId",
    "clientToken"
  ]
}