Skip to content

/AWS1/IF_EC2=>MODIFYIPAMPOOLALLOCATION()

About ModifyIpamPoolAllocation

Modifies the description of an IPAM pool allocation. For more information, see Modify an IPAM pool allocation in the Amazon VPC IPAM User Guide.

Method Signature

METHODS /AWS1/IF_EC2~MODIFYIPAMPOOLALLOCATION
  IMPORTING
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IV_IPAMPOOLALLOCATIONID TYPE /AWS1/EC2IPAMPOOLALLOCATIONID OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/EC2STRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2modipampoolallocrs
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_ipampoolallocationid TYPE /AWS1/EC2IPAMPOOLALLOCATIONID /AWS1/EC2IPAMPOOLALLOCATIONID

The ID of the IPAM pool allocation you want to modify.

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.

iv_description TYPE /AWS1/EC2STRING /AWS1/EC2STRING

The new description for the IPAM pool allocation. If you submit a null value, the description is removed from the allocation.

RETURNING

oo_output TYPE REF TO /aws1/cl_ec2modipampoolallocrs /AWS1/CL_EC2MODIPAMPOOLALLOCRS

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->modifyipampoolallocation(
  iv_description = |string|
  iv_dryrun = ABAP_TRUE
  iv_ipampoolallocationid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_ipampoolallocation = lo_result->get_ipampoolallocation( ).
  IF lo_ipampoolallocation IS NOT INITIAL.
    lv_string = lo_ipampoolallocation->get_cidr( ).
    lv_ipampoolallocationid = lo_ipampoolallocation->get_ipampoolallocationid( ).
    lv_string = lo_ipampoolallocation->get_description( ).
    lv_string = lo_ipampoolallocation->get_resourceid( ).
    lv_ipampoolallocationresou = lo_ipampoolallocation->get_resourcetype( ).
    lv_string = lo_ipampoolallocation->get_resourceregion( ).
    lv_string = lo_ipampoolallocation->get_resourceowner( ).
    LOOP AT lo_ipampoolallocation->get_tags( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_string = lo_row_1->get_key( ).
        lv_string = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
ENDIF.