ec2.snapshot-policies.update

Change, pause or resume a snapshot policy

PATCH /ec2/api/snapshot-policies/{id}IAM ec2:UpdateSnapshotPolicyChanges state

Request syntax

PATCH /ec2/api/snapshot-policies/{id}
{
  "name": "string",
  "description": "string",
  "enabled": "boolean",
  "targetInstanceIds": "array of string",
  "targetTags": "map of string",
  "intervalHours": "number",
  "startTime": "string",
  "retainCount": "number"
}

Path parameters

  • idRequired

    string

    Constraints: /^esp-[0-9a-f]{6,32}$/

Request body

  • nameOptional

    string

    A display name

    Constraints: 1-64 chars

  • descriptionOptional

    string

    Free text; null clears it

    Constraints: max 255 chars

    May be null.

  • enabledOptional

    boolean

    A paused policy takes nothing and keeps its images

  • targetInstanceIdsOptional

    array of string

    Instances to snapshot (i-…)

    Constraints: /^i-[0-9a-f]{6,32}$/

  • targetTagsOptional

    map of string

    Also snapshot every instance that carries all of these tags

    Constraints: key=value

  • intervalHoursOptional

    number

    Hours between runs: 1, 2, 3, 4, 6, 8, 12, 24 or 168 (weekly, on Mondays)

    Constraints: integer

  • startTimeOptional

    string

    HH:MM UTC; runs fall on this time plus whole intervals

    Constraints: /^([01]\d|2[0-3]):[0-5]\d$/

  • retainCountOptional

    number

    Images kept per instance; older ones this policy took are deregistered

    Constraints: integer, 1-100

Response

200: `data` is the policy after the change.

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:UpdateSnapshotPolicy 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 snapshot-policies update id

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