EC2 / Client / detach_image_watermark

detach_image_watermark

EC2.Client.detach_image_watermark(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.detach_image_watermark(
    ImageId='string',
    WatermarkKey='string',
    DryRun=True|False
)
Parameters:

  • ImageId (string) –

    [REQUIRED]

    The ID of the AMI.

  • WatermarkKey (string) –

    [REQUIRED]

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

  • DryRun (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Return': True|False
}

Response Structure

  • (dict) –

    • Return (boolean) –

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