Skip to content

/AWS1/IF_EC2=>DESCRIBESECONDARYINTERFACES()

About DescribeSecondaryInterfaces

Describes one or more of your secondary interfaces.

Method Signature

METHODS /AWS1/IF_EC2~DESCRIBESECONDARYINTERFACES
  IMPORTING
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/EC2DSCSECINTFSMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/EC2STRING OPTIONAL
    !IT_SECONDARYINTERFACEIDS TYPE /AWS1/CL_EC2SECIFACEIDLIST_W=>TT_SECONDARYINTERFACEIDLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2descrsecifacesrslt
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

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.

it_filters TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST TT_FILTERLIST

The filters.

  • attachment.attachment-id - The ID of the secondary interface attachment.

  • attachment.instance-id - The ID of the instance to which the secondary interface is attached.

  • attachment.instance-owner-id - The ID of the Amazon Web Services account that owns the instance to which the secondary interface is attached.

  • attachment.status - The attachment status (attaching | attached | detaching | detached).

  • private-ipv4-addresses.private-ip-address - The private IPv4 address associated with the secondary interface.

  • owner-id - The ID of the Amazon Web Services account that owns the secondary interface.

  • secondary-interface-arn - The ARN of the secondary interface.

  • secondary-interface-id - The ID of the secondary interface.

  • secondary-interface-type - The type of secondary interface (secondary).

  • secondary-network-id - The ID of the secondary network.

  • secondary-network-type - The type of the secondary network (rdma).

  • secondary-subnet-id - The ID of the secondary subnet.

  • status - The status of the secondary interface (available | in-use).

  • tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

iv_maxresults TYPE /AWS1/EC2DSCSECINTFSMAXRESULTS /AWS1/EC2DSCSECINTFSMAXRESULTS

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.

it_secondaryinterfaceids TYPE /AWS1/CL_EC2SECIFACEIDLIST_W=>TT_SECONDARYINTERFACEIDLIST TT_SECONDARYINTERFACEIDLIST

The IDs of the secondary interfaces.

RETURNING

oo_output TYPE REF TO /aws1/cl_ec2descrsecifacesrslt /AWS1/CL_EC2DESCRSECIFACESRSLT

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->describesecondaryinterfaces(
  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|
      )
    )
  )
  it_secondaryinterfaceids = VALUE /aws1/cl_ec2secifaceidlist_w=>tt_secondaryinterfaceidlist(
    ( new /aws1/cl_ec2secifaceidlist_w( |string| ) )
  )
  iv_dryrun = ABAP_TRUE
  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_secondaryinterfaces( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_availabilityzonename = lo_row_1->get_availabilityzone( ).
      lv_availabilityzoneid = lo_row_1->get_availabilityzoneid( ).
      lo_secondaryinterfaceattac = lo_row_1->get_attachment( ).
      IF lo_secondaryinterfaceattac IS NOT INITIAL.
        lv_string = lo_secondaryinterfaceattac->get_attachmentid( ).
        lv_milliseconddatetime = lo_secondaryinterfaceattac->get_attachtime( ).
        lv_boolean = lo_secondaryinterfaceattac->get_deleteontermination( ).
        lv_integer = lo_secondaryinterfaceattac->get_deviceindex( ).
        lv_string = lo_secondaryinterfaceattac->get_instanceid( ).
        lv_string = lo_secondaryinterfaceattac->get_instanceownerid( ).
        lv_integer = lo_secondaryinterfaceattac->get_networkcardindex( ).
        lv_attachmentstatus = lo_secondaryinterfaceattac->get_status( ).
      ENDIF.
      lv_string = lo_row_1->get_macaddress( ).
      lv_string = lo_row_1->get_ownerid( ).
      LOOP AT lo_row_1->get_privateipv4addresses( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_privateipaddress( ).
        ENDIF.
      ENDLOOP.
      lv_secondaryinterfaceid = lo_row_1->get_secondaryinterfaceid( ).
      lv_string = lo_row_1->get_secondaryinterfacearn( ).
      lv_secondaryinterfacetype = lo_row_1->get_secondaryinterfacetype( ).
      lv_secondarysubnetid = lo_row_1->get_secondarysubnetid( ).
      lv_secondarynetworkid = lo_row_1->get_secondarynetworkid( ).
      lv_secondarynetworktype = lo_row_1->get_secondarynetworktype( ).
      lv_boolean = lo_row_1->get_sourcedestcheck( ).
      lv_secondaryinterfacestatu = lo_row_1->get_status( ).
      LOOP AT lo_row_1->get_tags( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_string = lo_row_5->get_key( ).
          lv_string = lo_row_5->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

To describe all secondary interfaces

This example describes all secondary interfaces in the current Region.

DATA(lo_result) = lo_client->describesecondaryinterfaces( ).

To describe secondary interfaces using filters

This example uses filters to describe secondary interfaces attached to a specific instance.

DATA(lo_result) = lo_client->describesecondaryinterfaces(
  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( |i-1234567890abcdef0| ) )
        )
        iv_name = |attachment.instance-id|
      )
    )
  )
  iv_maxresults = 5
).