DESCRIBEINSTANCEIMAGEMET()`¶

About DescribeInstanceImageMetadata¶

Describes the AMI that was used to launch an instance, even if the AMI is deprecated, deregistered, made private (no longer public or shared with your account), or not allowed.

If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance.

If you specify an instance ID that is not valid, an instance that doesn't exist, or an instance that you do not own, an error (InvalidInstanceID.NotFound) is returned.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

In the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected Availability Zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs that are in an unaffected Availability Zone, the call works normally.

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~DESCRIBEINSTANCEIMAGEMET
  IMPORTING
    !IT_FILTERS TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST OPTIONAL
    !IT_INSTANCEIDS TYPE /AWS1/CL_EC2INSTIDSTRINGLIST_W=>TT_INSTANCEIDSTRINGLIST OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/EC2DSCINSTIMAGEMETMAXRSS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/EC2STRING OPTIONAL
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2dscinstimagemetrs
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`it_filters` `TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST` `TT_FILTERLIST`¶

The filters.

availability-zone - The name of the Availability Zone (for example, us-west-2a) or Local Zone (for example, us-west-2-lax-1b) of the instance.

instance-id - The ID of the instance.

image-allowed - A Boolean that indicates whether the image meets the criteria specified for Allowed AMIs.

instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

instance-type - The type of instance (for example, t3.micro).

launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2023-09-29T11:04:43.305Z. You can use a wildcard (), for example, 2023-09-29T, which matches an entire day.

owner-alias - The owner alias (amazon | aws-marketplace | aws-backup-vault). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be set using the IAM console. We recommend that you use the Owner request parameter instead of this filter.

owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the Owner request parameter instead of this filter.

tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

zone-id - The ID of the Availability Zone (for example, usw2-az2) or Local Zone (for example, usw2-lax1-az1) of the instance.

`it_instanceids` `TYPE /AWS1/CL_EC2INSTIDSTRINGLIST_W=>TT_INSTANCEIDSTRINGLIST` `TT_INSTANCEIDSTRINGLIST`¶

The instance IDs.

If you don't specify an instance ID or filters, the output includes information for all instances.

`iv_maxresults` `TYPE /AWS1/EC2DSCINSTIMAGEMETMAXRSS` `/AWS1/EC2DSCINSTIMAGEMETMAXRSS`¶

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

Default: 1000

`iv_nexttoken` `TYPE /AWS1/EC2STRING` `/AWS1/EC2STRING`¶

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

`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_ec2dscinstimagemetrs` `/AWS1/CL_EC2DSCINSTIMAGEMETRS`¶

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->describeinstanceimagemet(
  it_filters = VALUE /aws1/cl_ec2filter=>tt_filterlist(
    (
      new /aws1/cl_ec2filter(
        it_values = VALUE /aws1/cl_ec2valuestringlist_w=>tt_valuestringlist(
          ( new /aws1/cl_ec2valuestringlist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  it_instanceids = VALUE /aws1/cl_ec2instidstringlist_w=>tt_instanceidstringlist(
    ( new /aws1/cl_ec2instidstringlist_w( |string| ) )
  )
  iv_dryrun = ABAP_TRUE
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_instanceimagemetadata( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_instanceid = lo_row_1->get_instanceid( ).
      lv_instancetype = lo_row_1->get_instancetype( ).
      lv_milliseconddatetime = lo_row_1->get_launchtime( ).
      lv_string = lo_row_1->get_availabilityzone( ).
      lv_string = lo_row_1->get_zoneid( ).
      lo_instancestate = lo_row_1->get_state( ).
      IF lo_instancestate IS NOT INITIAL.
        lv_integer = lo_instancestate->get_code( ).
        lv_instancestatename = lo_instancestate->get_name( ).
      ENDIF.
      lv_string = lo_row_1->get_ownerid( ).
      LOOP AT lo_row_1->get_tags( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_key( ).
          lv_string = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lo_imagemetadata = lo_row_1->get_imagemetadata( ).
      IF lo_imagemetadata IS NOT INITIAL.
        lv_imageid = lo_imagemetadata->get_imageid( ).
        lv_string = lo_imagemetadata->get_name( ).
        lv_string = lo_imagemetadata->get_ownerid( ).
        lv_imagestate = lo_imagemetadata->get_state( ).
        lv_string = lo_imagemetadata->get_imageowneralias( ).
        lv_string = lo_imagemetadata->get_creationdate( ).
        lv_string = lo_imagemetadata->get_deprecationtime( ).
        lv_boolean = lo_imagemetadata->get_imageallowed( ).
        lv_boolean = lo_imagemetadata->get_ispublic( ).
      ENDIF.
      lo_operatorresponse = lo_row_1->get_operator( ).
      IF lo_operatorresponse IS NOT INITIAL.
        lv_boolean = lo_operatorresponse->get_managed( ).
        lv_string = lo_operatorresponse->get_principal( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_EC2=>DESCRIBEINSTANCEIMAGEMET()¶