Skip to content

/AWS1/IF_EC2=>DESCRIBESECONDARYNETWORKS()

About DescribeSecondaryNetworks

Describes one or more secondary networks.

Method Signature

METHODS /AWS1/IF_EC2~DESCRIBESECONDARYNETWORKS
  IMPORTING
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/EC2DESCRSECNETSMAXRSLTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/EC2STRING OPTIONAL
    !IT_SECONDARYNETWORKIDS TYPE /AWS1/CL_EC2SECNETWORKIDLIST_W=>TT_SECONDARYNETWORKIDLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2descrsecnetsresult
  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. The following are the possible values:

  • ipv4-cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the secondary network.

  • ipv4-cidr-block-association.cidr-block - An IPv4 CIDR block associated with the secondary network.

  • ipv4-cidr-block-association.state - The state of an IPv4 CIDR block associated with the secondary network.

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

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

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

  • state - The state of the secondary network (create-in-progress | create-complete | create-failed | delete-in-progress | delete-complete | delete-failed).

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

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

iv_maxresults TYPE /AWS1/EC2DESCRSECNETSMAXRSLTS /AWS1/EC2DESCRSECNETSMAXRSLTS

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_secondarynetworkids TYPE /AWS1/CL_EC2SECNETWORKIDLIST_W=>TT_SECONDARYNETWORKIDLIST TT_SECONDARYNETWORKIDLIST

The IDs of the secondary networks.

RETURNING

oo_output TYPE REF TO /aws1/cl_ec2descrsecnetsresult /AWS1/CL_EC2DESCRSECNETSRESULT

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->describesecondarynetworks(
  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_secondarynetworkids = VALUE /aws1/cl_ec2secnetworkidlist_w=>tt_secondarynetworkidlist(
    ( new /aws1/cl_ec2secnetworkidlist_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_secondarynetworks( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_secondarynetworkid = lo_row_1->get_secondarynetworkid( ).
      lv_string = lo_row_1->get_secondarynetworkarn( ).
      lv_string = lo_row_1->get_ownerid( ).
      lv_secondarynetworktype = lo_row_1->get_type( ).
      lv_secondarynetworkstate = lo_row_1->get_state( ).
      lv_string = lo_row_1->get_statereason( ).
      LOOP AT lo_row_1->get_ipv4cidrblockassocs( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_secondarynetworkcidrass = lo_row_3->get_associationid( ).
          lv_string = lo_row_3->get_cidrblock( ).
          lv_secondarynetworkcidrblo = lo_row_3->get_state( ).
          lv_string = lo_row_3->get_statereason( ).
        ENDIF.
      ENDLOOP.
      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 specified secondary networks

This example describes the specified secondary networks.

DATA(lo_result) = lo_client->describesecondarynetworks(
  it_secondarynetworkids = VALUE /aws1/cl_ec2secnetworkidlist_w=>tt_secondarynetworkidlist(
    ( new /aws1/cl_ec2secnetworkidlist_w( |sn-0123456789abcdef0| ) )
    ( new /aws1/cl_ec2secnetworkidlist_w( |sn-0987654321fedcba0| ) )
  )
).

To describe secondary networks using filters

This example uses filters to describe any secondary network you own that has a tag with the key Environment and the value Production and whose state is create-complete.

DATA(lo_result) = lo_client->describesecondarynetworks(
  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( |Production| ) )
        )
        iv_name = |tag:Environment|
      )
    )
    (
      new /aws1/cl_ec2filter(
        it_values = VALUE /aws1/cl_ec2valuestringlist_w=>tt_valuestringlist(
          ( new /aws1/cl_ec2valuestringlist_w( |create-complete| ) )
        )
        iv_name = |state|
      )
    )
  )
  iv_maxresults = 5
).