/AWS1/IF_EC2=>GETIPAMDISCOVEREDROUTES()

About GetIpamDiscoveredRoutes

Retrieves Border Gateway Protocol (BGP) routes discovered by IPAM resource discovery for a specified Region. Use this operation to view the Bring Your Own IP (BYOIP) address ranges that are currently advertised through BGP. We recommend using pagination to ensure that the operation returns quickly and successfully.

Method Signature

METHODS /AWS1/IF_EC2~GETIPAMDISCOVEREDROUTES
  IMPORTING
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IV_IPAMRESOURCEDISCOVERYID TYPE /AWS1/EC2IPAMRESRCDISCOVERYID OPTIONAL
    !IV_RESOURCEREGION TYPE /AWS1/EC2STRING OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/EC2NEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/EC2IPAMMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2getipamdiscvrters
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_ipamresourcediscoveryid TYPE /AWS1/EC2IPAMRESRCDISCOVERYID /AWS1/EC2IPAMRESRCDISCOVERYID

The ID of the IPAM resource discovery.

iv_resourceregion TYPE /AWS1/EC2STRING /AWS1/EC2STRING

The Amazon Web Services Region to retrieve discovered routes for.

Optional arguments:

iv_dryrun TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

Checks whether you have the required permissions for the operation, 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 to apply to the results.

iv_nexttoken TYPE /AWS1/EC2NEXTTOKEN /AWS1/EC2NEXTTOKEN

The token for the next page of results.

iv_maxresults TYPE /AWS1/EC2IPAMMAXRESULTS /AWS1/EC2IPAMMAXRESULTS

The maximum number of results to return in a single call. If not specified, all available results are returned. To retrieve the remaining results, make another call with the returned nextToken value.

RETURNING

oo_output TYPE REF TO /aws1/cl_ec2getipamdiscvrters /AWS1/CL_EC2GETIPAMDISCVRTERS

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->getipamdiscoveredroutes(
  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|
      )
    )
  )
  iv_dryrun = ABAP_TRUE
  iv_ipamresourcediscoveryid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_resourceregion = |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_ipamdiscoveredroutes( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_ipamresourcediscoveryid = lo_row_1->get_ipamresourcediscoveryid( ).
      lv_string = lo_row_1->get_resourceregion( ).
      lv_string = lo_row_1->get_resourceownerid( ).
      lv_string = lo_row_1->get_cidr( ).
      lv_string = lo_row_1->get_asn( ).
      lv_ipambyoipcidrstate = lo_row_1->get_state( ).
      lv_ipambyoipadvertisementt = lo_row_1->get_advertisementtype( ).
      lv_string = lo_row_1->get_networkbordergroup( ).
      lv_string = lo_row_1->get_poolid( ).
      lv_string = lo_row_1->get_ipampoolid( ).
      lv_milliseconddatetime = lo_row_1->get_sampletime( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.