Skip to content

Attaches a watermark to a non-public AMI

Description

Attaches a watermark to a non-public AMI. The watermark is a structured identifier that automatically propagates to all derivative images created through create_image, and copy_image.

Only the AMI owner can attach watermarks. Watermarks cannot be added to public AMIs.

Usage

ec2_attach_image_watermark(ImageId, WatermarkName, DryRun)

Arguments

  • ImageId

[required] The ID of the AMI.

  • WatermarkName

[required] The name for the watermark. Combined with the caller's account ID to form the WatermarkKey (accountId:watermarkName).

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

  • 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(
  WatermarkKey = "string"
)

Request syntax

svc$attach_image_watermark(
  ImageId = "string",
  WatermarkName = "string",
  DryRun = TRUE|FALSE
)