DESCRIBEOUTBOUNDCONNECTIONS()`¶

About DescribeOutboundConnections¶

Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Method Signature¶

METHODS /AWS1/IF_OSR~DESCRIBEOUTBOUNDCONNECTIONS
  IMPORTING
    !IT_FILTERS TYPE /AWS1/CL_OSRFILTER=>TT_FILTERLIST OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/OSRMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/OSRNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_osrdscoutboundcxnsrsp
  RAISING
    /AWS1/CX_OSRDISABLEDOPEX
    /AWS1/CX_OSRINVPAGINATIONTOKEX
    /AWS1/CX_OSRCLIENTEXC
    /AWS1/CX_OSRSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`it_filters` `TYPE /AWS1/CL_OSRFILTER=>TT_FILTERLIST` `TT_FILTERLIST`¶

List of filter names and values that you can use for requests.

`iv_maxresults` `TYPE /AWS1/OSRMAXRESULTS` `/AWS1/OSRMAXRESULTS`¶

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

`iv_nexttoken` `TYPE /AWS1/OSRNEXTTOKEN` `/AWS1/OSRNEXTTOKEN`¶

If your initial DescribeOutboundConnections operation returns a nextToken, you can include the returned nextToken in subsequent DescribeOutboundConnections operations, which returns results in the next page.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_osrdscoutboundcxnsrsp` `/AWS1/CL_OSRDSCOUTBOUNDCXNSRSP`¶

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->describeoutboundconnections(
  it_filters = VALUE /aws1/cl_osrfilter=>tt_filterlist(
    (
      new /aws1/cl_osrfilter(
        it_values = VALUE /aws1/cl_osrvaluestringlist_w=>tt_valuestringlist(
          ( new /aws1/cl_osrvaluestringlist_w( |string| ) )
        )
        iv_name = |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_connections( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lo_domaininformationcontai = lo_row_1->get_localdomaininfo( ).
      IF lo_domaininformationcontai IS NOT INITIAL.
        lo_awsdomaininformation = lo_domaininformationcontai->get_awsdomaininformation( ).
        IF lo_awsdomaininformation IS NOT INITIAL.
          lv_ownerid = lo_awsdomaininformation->get_ownerid( ).
          lv_domainname = lo_awsdomaininformation->get_domainname( ).
          lv_region = lo_awsdomaininformation->get_region( ).
        ENDIF.
      ENDIF.
      lo_domaininformationcontai = lo_row_1->get_remotedomaininfo( ).
      IF lo_domaininformationcontai IS NOT INITIAL.
        lo_awsdomaininformation = lo_domaininformationcontai->get_awsdomaininformation( ).
        IF lo_awsdomaininformation IS NOT INITIAL.
          lv_ownerid = lo_awsdomaininformation->get_ownerid( ).
          lv_domainname = lo_awsdomaininformation->get_domainname( ).
          lv_region = lo_awsdomaininformation->get_region( ).
        ENDIF.
      ENDIF.
      lv_connectionid = lo_row_1->get_connectionid( ).
      lv_connectionalias = lo_row_1->get_connectionalias( ).
      lo_outboundconnectionstatu = lo_row_1->get_connectionstatus( ).
      IF lo_outboundconnectionstatu IS NOT INITIAL.
        lv_outboundconnectionstatu_1 = lo_outboundconnectionstatu->get_statuscode( ).
        lv_connectionstatusmessage = lo_outboundconnectionstatu->get_message( ).
      ENDIF.
      lv_connectionmode = lo_row_1->get_connectionmode( ).
      lo_connectionproperties = lo_row_1->get_connectionproperties( ).
      IF lo_connectionproperties IS NOT INITIAL.
        lv_endpoint = lo_connectionproperties->get_endpoint( ).
        lo_crossclustersearchconne = lo_connectionproperties->get_crossclustersearch( ).
        IF lo_crossclustersearchconne IS NOT INITIAL.
          lv_skipunavailablestatus = lo_crossclustersearchconne->get_skipunavailable( ).
        ENDIF.
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_OSR=>DESCRIBEOUTBOUNDCONNECTIONS()¶