attach_image_watermark¶
Operation¶
attach_image_watermark
async
¶
attach_image_watermark(request: AttachImageWatermarkInput | AttachImageWatermarkInputDict, /, *, plugins: list[Plugin] | None = None) -> AttachImageWatermarkOutput
attach_image_watermark(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[AttachImageWatermarkInputDict]) -> 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 |
|---|---|---|---|
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 |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
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.
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(_)
Dictionaries¶
AttachImageWatermarkInputDict
¶
Bases: TypedDict
Dictionary form of AttachImageWatermarkInput.
Attributes¶
dry_run
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.
watermark_name
instance-attribute
¶
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.