DESCRIBEVIRTUALINTERFACES()`¶

About DescribeVirtualInterfaces¶

Displays all virtual interfaces for an Amazon Web Services account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also returned. If you specify a connection ID, only the virtual interfaces associated with the connection are returned. If you specify a virtual interface ID, then only a single virtual interface is returned.

A virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer network.

If you're using an asn, the response includes ASN value in both the asn and asnLong fields.
If you're using asnLong, the response returns a value of 0 (zero) for the asn attribute because it exceeds the highest ASN value of 2,147,483,647 that it can support

Method Signature¶

METHODS /AWS1/IF_DCO~DESCRIBEVIRTUALINTERFACES
  IMPORTING
    !IV_CONNECTIONID TYPE /AWS1/DCOCONNECTIONID OPTIONAL
    !IV_VIRTUALINTERFACEID TYPE /AWS1/DCOVIRTUALINTERFACEID OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/DCOMAXRESULTSETSIZE OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/DCOPAGINATIONTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dcovirtualinterfaces
  RAISING
    /AWS1/CX_DCODIRECTCNCTCLIENTEX
    /AWS1/CX_DCODIRECTCNCTSERVEREX
    /AWS1/CX_DCOCLIENTEXC
    /AWS1/CX_DCOSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_connectionid` `TYPE /AWS1/DCOCONNECTIONID` `/AWS1/DCOCONNECTIONID`¶

The ID of the connection.

`iv_virtualinterfaceid` `TYPE /AWS1/DCOVIRTUALINTERFACEID` `/AWS1/DCOVIRTUALINTERFACEID`¶

The ID of the virtual interface.

`iv_maxresults` `TYPE /AWS1/DCOMAXRESULTSETSIZE` `/AWS1/DCOMAXRESULTSETSIZE`¶

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

If MaxResults is given a value larger than 100, only 100 results are returned.

`iv_nexttoken` `TYPE /AWS1/DCOPAGINATIONTOKEN` `/AWS1/DCOPAGINATIONTOKEN`¶

The token for the next page of results.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_dcovirtualinterfaces` `/AWS1/CL_DCOVIRTUALINTERFACES`¶

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->describevirtualinterfaces(
  iv_connectionid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_virtualinterfaceid = |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_virtualinterfaces( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_owneraccount = lo_row_1->get_owneraccount( ).
      lv_virtualinterfaceid = lo_row_1->get_virtualinterfaceid( ).
      lv_locationcode = lo_row_1->get_location( ).
      lv_connectionid = lo_row_1->get_connectionid( ).
      lv_virtualinterfacetype = lo_row_1->get_virtualinterfacetype( ).
      lv_virtualinterfacename = lo_row_1->get_virtualinterfacename( ).
      lv_vlan = lo_row_1->get_vlan( ).
      lv_asn = lo_row_1->get_asn( ).
      lv_longasn = lo_row_1->get_asnlong( ).
      lv_longasn = lo_row_1->get_amazonsideasn( ).
      lv_bgpauthkey = lo_row_1->get_authkey( ).
      lv_amazonaddress = lo_row_1->get_amazonaddress( ).
      lv_customeraddress = lo_row_1->get_customeraddress( ).
      lv_addressfamily = lo_row_1->get_addressfamily( ).
      lv_virtualinterfacestate = lo_row_1->get_virtualinterfacestate( ).
      lv_routerconfig = lo_row_1->get_customerrouterconfig( ).
      lv_mtu = lo_row_1->get_mtu( ).
      lv_jumboframecapable = lo_row_1->get_jumboframecapable( ).
      lv_virtualgatewayid = lo_row_1->get_virtualgatewayid( ).
      lv_directconnectgatewayid = lo_row_1->get_directconnectgatewayid( ).
      LOOP AT lo_row_1->get_routefilterprefixes( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_cidr = lo_row_3->get_cidr( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_bgppeers( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_bgppeerid = lo_row_5->get_bgppeerid( ).
          lv_asn = lo_row_5->get_asn( ).
          lv_longasn = lo_row_5->get_asnlong( ).
          lv_bgpauthkey = lo_row_5->get_authkey( ).
          lv_addressfamily = lo_row_5->get_addressfamily( ).
          lv_amazonaddress = lo_row_5->get_amazonaddress( ).
          lv_customeraddress = lo_row_5->get_customeraddress( ).
          lv_bgppeerstate = lo_row_5->get_bgppeerstate( ).
          lv_bgpstatus = lo_row_5->get_bgpstatus( ).
          lv_awsdevicev2 = lo_row_5->get_awsdevicev2( ).
          lv_awslogicaldeviceid = lo_row_5->get_awslogicaldeviceid( ).
        ENDIF.
      ENDLOOP.
      lv_region = lo_row_1->get_region( ).
      lv_awsdevicev2 = lo_row_1->get_awsdevicev2( ).
      lv_awslogicaldeviceid = lo_row_1->get_awslogicaldeviceid( ).
      LOOP AT lo_row_1->get_tags( ) into lo_row_6.
        lo_row_7 = lo_row_6.
        IF lo_row_7 IS NOT INITIAL.
          lv_tagkey = lo_row_7->get_key( ).
          lv_tagvalue = lo_row_7->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_sitelinkenabled = lo_row_1->get_sitelinkenabled( ).
    ENDIF.
  ENDLOOP.
  lv_paginationtoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_DCO=>DESCRIBEVIRTUALINTERFACES()¶