AttachImageWatermark
Attaches a watermark to a non-public AMI. The watermark is a structured identifier that automatically propagates to all derivative images created through CreateImage, CopyImage, and CreateRestoreImageTask.
Only the AMI owner can attach watermarks. Watermarks cannot be added to public AMIs.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- 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 isUnauthorizedOperation.Type: Boolean
Required: No
- ImageId
-
The ID of the AMI.
Type: String
Required: Yes
- WatermarkName
-
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(_)
Type: String
Length Constraints: Minimum length of 3. Maximum length of 128.
Required: Yes
Response Elements
The following elements are returned by the service.
- requestId
-
The ID of the request.
Type: String
- watermarkKey
-
The watermark identifier, in
accountId:watermarkNameformat (for example,123456789012:approvedAmi).Type: String
Errors
For information about the errors that are common to all actions, see Common Error Types.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
