Skip to content

EC2  >  Operations  >  attach_image_watermark

attach_image_watermark

Operation

attach_image_watermark async 

attach_image_watermark(input: AttachImageWatermarkInput, plugins: list[Plugin] | None = None) -> AttachImageWatermarkOutput

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

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

Parameters:

Name Type Description Default
input AttachImageWatermarkInput

An instance of AttachImageWatermarkInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
AttachImageWatermarkOutput

An instance of AttachImageWatermarkOutput.

Input

AttachImageWatermarkInput dataclass

Bases: _SerdeShape

Dataclass for AttachImageWatermarkInput structure.

Attributes

dry_run class-attribute instance-attribute 
dry_run: bool | None = ...

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.

image_id class-attribute instance-attribute 
image_id: str | None = ...

The ID of the AMI.

watermark_name class-attribute instance-attribute 
watermark_name: str | None = ...

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(_)

Output

AttachImageWatermarkOutput dataclass

Bases: _SerdeShape

Dataclass for AttachImageWatermarkOutput structure.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

watermark_key class-attribute instance-attribute 
watermark_key: str | None = ...

The watermark identifier, in accountId:watermarkName format (for example, 123456789012:approvedAmi).