DEREGISTERIMAGE()`¶

About DeregisterImage¶

Deregisters the specified AMI. A deregistered AMI can't be used to launch new instances.

If a deregistered EBS-backed AMI matches a Recycle Bin retention rule, it moves to the Recycle Bin for the specified retention period. It can be restored before its retention period expires, after which it is permanently deleted. If the deregistered AMI doesn't match a retention rule, it is permanently deleted immediately. For more information, see Recover deleted Amazon EBS snapshots and EBS-backed AMIs with Recycle Bin in the Amazon EBS User Guide.

When deregistering an EBS-backed AMI, you can optionally delete its associated snapshots at the same time. However, if a snapshot is associated with multiple AMIs, it won't be deleted even if specified for deletion, although the AMI will still be deregistered.

Deregistering an AMI does not delete the following:

Instances already launched from the AMI. You'll continue to incur usage costs for the instances until you terminate them.
For EBS-backed AMIs: Snapshots that are associated with multiple AMIs. You'll continue to incur snapshot storage costs.
For instance store-backed AMIs: The files uploaded to Amazon S3 during AMI creation. You'll continue to incur S3 storage costs.

For more information, see Deregister an Amazon EC2 AMI in the Amazon EC2 User Guide.

Method Signature¶

METHODS /AWS1/IF_EC2~DEREGISTERIMAGE
  IMPORTING
    !IV_IMAGEID TYPE /AWS1/EC2IMAGEID OPTIONAL
    !IV_DELETEASSOCIATEDSNAPSHOTS TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2deregimageresult
  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.

Optional arguments:¶

`iv_deleteassociatedsnapshots` `TYPE /AWS1/EC2BOOLEAN` `/AWS1/EC2BOOLEAN`¶

Specifies whether to delete the snapshots associated with the AMI during deregistration.

If a snapshot is associated with multiple AMIs, it is not deleted, regardless of this setting.

Default: The snapshots are not deleted.

`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_ec2deregimageresult` `/AWS1/CL_EC2DEREGIMAGERESULT`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

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->deregisterimage(
  iv_deleteassociatedsnapshots = ABAP_TRUE
  iv_dryrun = ABAP_TRUE
  iv_imageid = |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( ).
  LOOP AT lo_result->get_deletesnapshotresults( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_snapshotid = lo_row_1->get_snapshotid( ).
      lv_snapshotreturncodes = lo_row_1->get_returncode( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_EC2=>DEREGISTERIMAGE()¶