DESCRIBEIMAGEATTRIBUTE()`¶

About DescribeImageAttribute¶

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.

Method Signature¶

METHODS /AWS1/IF_EC2~DESCRIBEIMAGEATTRIBUTE
  IMPORTING
    !IV_ATTRIBUTE TYPE /AWS1/EC2IMAGEATTRIBUTENAME OPTIONAL
    !IV_IMAGEID TYPE /AWS1/EC2IMAGEID OPTIONAL
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2imageattribute
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_attribute` `TYPE /AWS1/EC2IMAGEATTRIBUTENAME` `/AWS1/EC2IMAGEATTRIBUTENAME`¶

The AMI attribute.

Note: The blockDeviceMapping attribute is deprecated. Using this attribute returns the Client.AuthFailure error. To get information about the block device mappings for an AMI, describe the image instead.

`iv_imageid` `TYPE /AWS1/EC2IMAGEID` `/AWS1/EC2IMAGEID`¶

The ID of the AMI.

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_ec2imageattribute` `/AWS1/CL_EC2IMAGEATTRIBUTE`¶

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->describeimageattribute(
  iv_attribute = |string|
  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.
  lo_attributevalue = lo_result->get_description( ).
  IF lo_attributevalue IS NOT INITIAL.
    lv_string = lo_attributevalue->get_value( ).
  ENDIF.
  lo_attributevalue = lo_result->get_kernelid( ).
  IF lo_attributevalue IS NOT INITIAL.
    lv_string = lo_attributevalue->get_value( ).
  ENDIF.
  lo_attributevalue = lo_result->get_ramdiskid( ).
  IF lo_attributevalue IS NOT INITIAL.
    lv_string = lo_attributevalue->get_value( ).
  ENDIF.
  lo_attributevalue = lo_result->get_sriovnetsupport( ).
  IF lo_attributevalue IS NOT INITIAL.
    lv_string = lo_attributevalue->get_value( ).
  ENDIF.
  lo_attributevalue = lo_result->get_bootmode( ).
  IF lo_attributevalue IS NOT INITIAL.
    lv_string = lo_attributevalue->get_value( ).
  ENDIF.
  lo_attributevalue = lo_result->get_tpmsupport( ).
  IF lo_attributevalue IS NOT INITIAL.
    lv_string = lo_attributevalue->get_value( ).
  ENDIF.
  lo_attributevalue = lo_result->get_uefidata( ).
  IF lo_attributevalue IS NOT INITIAL.
    lv_string = lo_attributevalue->get_value( ).
  ENDIF.
  lo_attributevalue = lo_result->get_lastlaunchedtime( ).
  IF lo_attributevalue IS NOT INITIAL.
    lv_string = lo_attributevalue->get_value( ).
  ENDIF.
  lo_attributevalue = lo_result->get_imdssupport( ).
  IF lo_attributevalue IS NOT INITIAL.
    lv_string = lo_attributevalue->get_value( ).
  ENDIF.
  lo_attributevalue = lo_result->get_deregistrationprotection( ).
  IF lo_attributevalue IS NOT INITIAL.
    lv_string = lo_attributevalue->get_value( ).
  ENDIF.
  lv_string = lo_result->get_imageid( ).
  LOOP AT lo_result->get_launchpermissions( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_organizationarn( ).
      lv_string = lo_row_1->get_organizationalunitarn( ).
      lv_string = lo_row_1->get_userid( ).
      lv_permissiongroup = lo_row_1->get_group( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_productcodes( ) into lo_row_2.
    lo_row_3 = lo_row_2.
    IF lo_row_3 IS NOT INITIAL.
      lv_string = lo_row_3->get_productcodeid( ).
      lv_productcodevalues = lo_row_3->get_productcodetype( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_blockdevicemappings( ) into lo_row_4.
    lo_row_5 = lo_row_4.
    IF lo_row_5 IS NOT INITIAL.
      lo_ebsblockdevice = lo_row_5->get_ebs( ).
      IF lo_ebsblockdevice IS NOT INITIAL.
        lv_boolean = lo_ebsblockdevice->get_deleteontermination( ).
        lv_integer = lo_ebsblockdevice->get_iops( ).
        lv_snapshotid = lo_ebsblockdevice->get_snapshotid( ).
        lv_integer = lo_ebsblockdevice->get_volumesize( ).
        lv_volumetype = lo_ebsblockdevice->get_volumetype( ).
        lv_string = lo_ebsblockdevice->get_kmskeyid( ).
        lv_integer = lo_ebsblockdevice->get_throughput( ).
        lv_string = lo_ebsblockdevice->get_outpostarn( ).
        lv_string = lo_ebsblockdevice->get_availabilityzone( ).
        lv_boolean = lo_ebsblockdevice->get_encrypted( ).
        lv_integer = lo_ebsblockdevice->get_volumeinitializationrate( ).
        lv_string = lo_ebsblockdevice->get_availabilityzoneid( ).
      ENDIF.
      lv_string = lo_row_5->get_nodevice( ).
      lv_string = lo_row_5->get_devicename( ).
      lv_string = lo_row_5->get_virtualname( ).
    ENDIF.
  ENDLOOP.
ENDIF.

To describe the launch permissions for an AMI¶

This example describes the launch permissions for the specified AMI.

DATA(lo_result) = lo_client->describeimageattribute(
  iv_attribute = |launchPermission|
  iv_imageid = |ami-5731123e|
).

/AWS1/IF_EC2=>DESCRIBEIMAGEATTRIBUTE()¶