Skip to content

/AWS1/IF_EC2=>DETACHIMAGEWATERMARK()

About DetachImageWatermark

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.

Method Signature

METHODS /AWS1/IF_EC2~DETACHIMAGEWATERMARK
  IMPORTING
    !IV_IMAGEID TYPE /AWS1/EC2IMAGEID OPTIONAL
    !IV_WATERMARKKEY TYPE /AWS1/EC2STRING OPTIONAL
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2dtchimgwtrmrkrslt
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_imageid TYPE /AWS1/EC2IMAGEID /AWS1/EC2IMAGEID

The ID of the AMI.

iv_watermarkkey TYPE /AWS1/EC2STRING /AWS1/EC2STRING

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

Optional arguments:

iv_dryrun TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

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.

RETURNING

oo_output TYPE REF TO /aws1/cl_ec2dtchimgwtrmrkrslt /AWS1/CL_EC2DTCHIMGWTRMRKRSLT

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->detachimagewatermark(
  iv_dryrun = ABAP_TRUE
  iv_imageid = |string|
  iv_watermarkkey = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_boolean = lo_result->get_return( ).
ENDIF.