ec2.machine-images.create

Snapshot a running instance into a machine image

POST /ec2/api/machine-imagesIAM ec2:CreateImageChanges state

Request syntax

POST /ec2/api/machine-images
{
  "instanceId": "string",
  "name": "string",
  "description": "string",
  "tags": "map of string"
}

Request body

  • instanceIdRequired

    string

    The instance to snapshot (i-…), running or stopped

    Constraints: min 1 chars

  • nameRequired

    string

    A display name

    Constraints: 1-64 chars

  • descriptionOptional

    string

    Free text; omitted: none

    Constraints: max 255 chars

  • tagsOptional

    map of string

    Tags for the new resource, e.g. {"env": "prod", "project": "shop"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).

    Constraints: key=value

Response

201: `data` is the new machine image (id ewi-…, name, state, sourceInstanceId); the copy may finish in the background, and `state` says how it went.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow ec2:CreateImage on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud ec2 machine-images create --instance-id example --name example

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_ec2_machine-images_create.