Skip to content

/AWS1/IF_EC2=>SEARCHLOCALGATEWAYROUTES()

About SearchLocalGatewayRoutes

Searches for routes in the specified local gateway route table.

Method Signature

METHODS /AWS1/IF_EC2~SEARCHLOCALGATEWAYROUTES
  IMPORTING
    !IV_LOCALGATEWAYROUTETABLEID TYPE /AWS1/EC2LOCALGWROUTETABLEID OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/EC2MAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/EC2STRING OPTIONAL
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2srchlocalgwroute01
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_localgatewayroutetableid TYPE /AWS1/EC2LOCALGWROUTETABLEID /AWS1/EC2LOCALGWROUTETABLEID

The ID of the local gateway route table.

Optional arguments:

it_filters TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST TT_FILTERLIST

One or more filters.

  • prefix-list-id - The ID of the prefix list.

  • route-search.exact-match - The exact match of the specified filter.

  • route-search.longest-prefix-match - The longest prefix that matches the route.

  • route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.

  • route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.

  • state - The state of the route.

  • type - The route type.

iv_maxresults TYPE /AWS1/EC2MAXRESULTS /AWS1/EC2MAXRESULTS

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

iv_nexttoken TYPE /AWS1/EC2STRING /AWS1/EC2STRING

The token for the next page of results.

iv_dryrun TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

Checks 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.

RETURNING

oo_output TYPE REF TO /aws1/cl_ec2srchlocalgwroute01 /AWS1/CL_EC2SRCHLOCALGWROUTE01

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->searchlocalgatewayroutes(
  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_localgatewayroutetableid = |string|
  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_routes( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_destinationcidrblock( ).
      lv_localgatewayvirtualinte = lo_row_1->get_localgwvirtualinterfac00( ).
      lv_localgatewayroutetype = lo_row_1->get_type( ).
      lv_localgatewayroutestate = lo_row_1->get_state( ).
      lv_localgatewayroutetablei = lo_row_1->get_localgatewayroutetableid( ).
      lv_resourcearn = lo_row_1->get_localgwroutetablearn( ).
      lv_string = lo_row_1->get_ownerid( ).
      lv_subnetid = lo_row_1->get_subnetid( ).
      lv_coippoolid = lo_row_1->get_coippoolid( ).
      lv_networkinterfaceid = lo_row_1->get_networkinterfaceid( ).
      lv_prefixlistresourceid = lo_row_1->get_destinationprefixlistid( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.