Skip to content

Removes a watermark from the specified AMI

Description

Removes a watermark from the specified AMI. This is an idempotent operation. It succeeds even if the watermark does not exist on the image.

Removing a watermark from an image does not affect derivative images that already carry the watermark.

Only the AMI owner can detach watermarks.

Usage

ec2_detach_image_watermark(ImageId, WatermarkKey, DryRun)

Arguments

  • ImageId

[required] The ID of the AMI.

  • WatermarkKey

[required] The watermark key to remove, in accountId:watermarkName format (for example, 123456789012:approvedAmi).

  • DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Value

A list with the following syntax:

list(
  Return = TRUE|FALSE
)

Request syntax

svc$detach_image_watermark(
  ImageId = "string",
  WatermarkKey = "string",
  DryRun = TRUE|FALSE
)