DESCRIBEIPAMS()`¶

About DescribeIpams¶

Get information about your IPAM pools.

For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.

Method Signature¶

METHODS /AWS1/IF_EC2~DESCRIBEIPAMS
  IMPORTING
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/EC2IPAMMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/EC2NEXTTOKEN OPTIONAL
    !IT_IPAMIDS TYPE /AWS1/CL_EC2VALUESTRINGLIST_W=>TT_VALUESTRINGLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2descripamsresult
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_dryrun` `TYPE /AWS1/EC2BOOLEAN` `/AWS1/EC2BOOLEAN`¶

A check for 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.

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

One or more filters for the request. For more information about filtering, see Filtering CLI output.

`iv_maxresults` `TYPE /AWS1/EC2IPAMMAXRESULTS` `/AWS1/EC2IPAMMAXRESULTS`¶

The maximum number of results to return in the request.

`iv_nexttoken` `TYPE /AWS1/EC2NEXTTOKEN` `/AWS1/EC2NEXTTOKEN`¶

The token for the next page of results.

`it_ipamids` `TYPE /AWS1/CL_EC2VALUESTRINGLIST_W=>TT_VALUESTRINGLIST` `TT_VALUESTRINGLIST`¶

The IDs of the IPAMs you want information on.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ec2descripamsresult` `/AWS1/CL_EC2DESCRIPAMSRESULT`¶

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->describeipams(
  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_ipamids = VALUE /aws1/cl_ec2valuestringlist_w=>tt_valuestringlist(
    ( new /aws1/cl_ec2valuestringlist_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.
  lv_nexttoken = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_ipams( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_ownerid( ).
      lv_ipamid = lo_row_1->get_ipamid( ).
      lv_resourcearn = lo_row_1->get_ipamarn( ).
      lv_string = lo_row_1->get_ipamregion( ).
      lv_ipamscopeid = lo_row_1->get_publicdefaultscopeid( ).
      lv_ipamscopeid = lo_row_1->get_privatedefaultscopeid( ).
      lv_integer = lo_row_1->get_scopecount( ).
      lv_string = lo_row_1->get_description( ).
      LOOP AT lo_row_1->get_operatingregions( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_regionname( ).
        ENDIF.
      ENDLOOP.
      lv_ipamstate = lo_row_1->get_state( ).
      LOOP AT lo_row_1->get_tags( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_string = lo_row_5->get_key( ).
          lv_string = lo_row_5->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_ipamresourcediscoveryid = lo_row_1->get_defresourcediscoveryid( ).
      lv_ipamresourcediscoveryas = lo_row_1->get_defresrcdiscoveryassoc00( ).
      lv_integer = lo_row_1->get_resrcdiscoveryassociat00( ).
      lv_string = lo_row_1->get_statemessage( ).
      lv_ipamtier = lo_row_1->get_tier( ).
      lv_boolean = lo_row_1->get_enableprivategua( ).
      lv_ipammeteredaccount = lo_row_1->get_meteredaccount( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_EC2=>DESCRIBEIPAMS()¶