DESCRIBEIPAMPOOLALLOCATIONS()`¶

About DescribeIpamPoolAllocations¶

Describes IPAM pool allocations. You can describe all allocations owned by you across all pools, or you can describe specific allocations by ID.

If you specify IpamPoolAllocationIds, the results include only the specified allocations. If you do not specify IpamPoolAllocationIds, the results include all allocations owned by you. You can use Filters to narrow the results.

This action returns only allocations directly owned by you. To view all allocations in a pool you own or that has been shared with you, including allocations owned by other accounts, use GetIpamPoolAllocations.

Method Signature¶

METHODS /AWS1/IF_EC2~DESCRIBEIPAMPOOLALLOCATIONS
  IMPORTING
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IT_IPAMPOOLALLOCATIONIDS TYPE /AWS1/CL_EC2VALUESTRINGLIST_W=>TT_VALUESTRINGLIST OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/EC2DSCIPAMPOOLALCMAXRSLT OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/EC2NEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2dscipampoolalcrs
  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_ipampoolallocationids` `TYPE /AWS1/CL_EC2VALUESTRINGLIST_W=>TT_VALUESTRINGLIST` `TT_VALUESTRINGLIST`¶

The IDs of the IPAM pool allocations you want to describe.

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

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.

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

The token for the next page of results.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ec2dscipampoolalcrs` `/AWS1/CL_EC2DSCIPAMPOOLALCRS`¶

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->describeipampoolallocations(
  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_ipampoolallocationids = 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.
  LOOP AT lo_result->get_ipampoolallocations( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_cidr( ).
      lv_ipampoolallocationid = lo_row_1->get_ipampoolallocationid( ).
      lv_string = lo_row_1->get_description( ).
      lv_string = lo_row_1->get_resourceid( ).
      lv_ipampoolallocationresou = lo_row_1->get_resourcetype( ).
      lv_string = lo_row_1->get_resourceregion( ).
      lv_string = lo_row_1->get_resourceowner( ).
      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.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_EC2=>DESCRIBEIPAMPOOLALLOCATIONS()¶