Skip to content

EC2  >  Operations  >  detach_image_watermark

detach_image_watermark

Operation

detach_image_watermark async

detach_image_watermark(request: DetachImageWatermarkInput | DetachImageWatermarkInputDict, /, *, plugins: list[Plugin] | None = None) -> DetachImageWatermarkOutput
detach_image_watermark(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DetachImageWatermarkInputDict]) -> DetachImageWatermarkOutput

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.

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
DetachImageWatermarkOutput

An instance of DetachImageWatermarkOutput.

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

DetachImageWatermarkInput dataclass

Bases: _SerdeShape

Dataclass for DetachImageWatermarkInput 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_key class-attribute instance-attribute
watermark_key: str | None = ...

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

Dictionaries

DetachImageWatermarkInputDict

Bases: TypedDict

Dictionary form of DetachImageWatermarkInput.

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.

image_id instance-attribute
image_id: Required[str]

The ID of the AMI.

watermark_key instance-attribute
watermark_key: Required[str]

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

Output

DetachImageWatermarkOutput dataclass

Bases: _SerdeShape

Dataclass for DetachImageWatermarkOutput 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.

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

Returns true if the request succeeds; otherwise, it returns an error.