Skip to content

/AWS1/IF_EC2=>GETIPAMADDRESSHISTORY()

About GetIpamAddressHistory

Retrieve historical information about a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide.

Method Signature

METHODS /AWS1/IF_EC2~GETIPAMADDRESSHISTORY
  IMPORTING
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IV_CIDR TYPE /AWS1/EC2STRING OPTIONAL
    !IV_IPAMSCOPEID TYPE /AWS1/EC2IPAMSCOPEID OPTIONAL
    !IV_VPCID TYPE /AWS1/EC2STRING OPTIONAL
    !IV_STARTTIME TYPE /AWS1/EC2MILLISECONDDATETIME OPTIONAL
    !IV_ENDTIME TYPE /AWS1/EC2MILLISECONDDATETIME OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/EC2IPAMADDRESSHISTORYM00 OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/EC2NEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2getipamaddresshi01
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_cidr TYPE /AWS1/EC2STRING /AWS1/EC2STRING

The CIDR you want the history of. The CIDR can be an IPv4 or IPv6 IP address range. If you enter a /16 IPv4 CIDR, you will get records that match it exactly. You will not get records for any subnets within the /16 CIDR.

iv_ipamscopeid TYPE /AWS1/EC2IPAMSCOPEID /AWS1/EC2IPAMSCOPEID

The ID of the IPAM scope that the CIDR is in.

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_vpcid TYPE /AWS1/EC2STRING /AWS1/EC2STRING

The ID of the VPC you want your history records filtered by.

iv_starttime TYPE /AWS1/EC2MILLISECONDDATETIME /AWS1/EC2MILLISECONDDATETIME

The start of the time period for which you are looking for history. If you omit this option, it will default to the value of EndTime.

iv_endtime TYPE /AWS1/EC2MILLISECONDDATETIME /AWS1/EC2MILLISECONDDATETIME

The end of the time period for which you are looking for history. If you omit this option, it will default to the current time.

iv_maxresults TYPE /AWS1/EC2IPAMADDRESSHISTORYM00 /AWS1/EC2IPAMADDRESSHISTORYM00

The maximum number of historical results you would like returned per page. Defaults to 100.

iv_nexttoken TYPE /AWS1/EC2NEXTTOKEN /AWS1/EC2NEXTTOKEN

The token for the next page of results.

RETURNING

oo_output TYPE REF TO /aws1/cl_ec2getipamaddresshi01 /AWS1/CL_EC2GETIPAMADDRESSHI01

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->getipamaddresshistory(
  iv_cidr = |string|
  iv_dryrun = ABAP_TRUE
  iv_endtime = '20150101000000.0000000'
  iv_ipamscopeid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_starttime = '20150101000000.0000000'
  iv_vpcid = |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_historyrecords( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_resourceownerid( ).
      lv_string = lo_row_1->get_resourceregion( ).
      lv_ipamaddresshistoryresou = lo_row_1->get_resourcetype( ).
      lv_string = lo_row_1->get_resourceid( ).
      lv_string = lo_row_1->get_resourcecidr( ).
      lv_string = lo_row_1->get_resourcename( ).
      lv_ipamcompliancestatus = lo_row_1->get_resourcecompliancestatus( ).
      lv_ipamoverlapstatus = lo_row_1->get_resourceoverlapstatus( ).
      lv_string = lo_row_1->get_vpcid( ).
      lv_milliseconddatetime = lo_row_1->get_sampledstarttime( ).
      lv_milliseconddatetime = lo_row_1->get_sampledendtime( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.