OPENTUNNEL()`¶

About OpenTunnel¶

Creates a new tunnel, and returns two client access tokens for clients to use to connect to the IoT Secure Tunneling proxy server.

Requires permission to access the OpenTunnel action.

Method Signature¶

METHODS /AWS1/IF_IOU~OPENTUNNEL
  IMPORTING
    !IV_DESCRIPTION TYPE /AWS1/IOUDESCRIPTION OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_IOUTAG=>TT_TAGLIST OPTIONAL
    !IO_DESTINATIONCONFIG TYPE REF TO /AWS1/CL_IOUDESTINATIONCONFIG OPTIONAL
    !IO_TIMEOUTCONFIG TYPE REF TO /AWS1/CL_IOUTIMEOUTCONFIG OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iouopentunnelresponse
  RAISING
    /AWS1/CX_IOULIMITEXCEEDEDEX
    /AWS1/CX_IOUCLIENTEXC
    /AWS1/CX_IOUSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_description` `TYPE /AWS1/IOUDESCRIPTION` `/AWS1/IOUDESCRIPTION`¶

A short text description of the tunnel.

`it_tags` `TYPE /AWS1/CL_IOUTAG=>TT_TAGLIST` `TT_TAGLIST`¶

A collection of tag metadata.

`io_destinationconfig` `TYPE REF TO /AWS1/CL_IOUDESTINATIONCONFIG` `/AWS1/CL_IOUDESTINATIONCONFIG`¶

The destination configuration for the OpenTunnel request.

`io_timeoutconfig` `TYPE REF TO /AWS1/CL_IOUTIMEOUTCONFIG` `/AWS1/CL_IOUTIMEOUTCONFIG`¶

Timeout configuration for a tunnel.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_iouopentunnelresponse` `/AWS1/CL_IOUOPENTUNNELRESPONSE`¶

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->opentunnel(
  io_destinationconfig = new /aws1/cl_ioudestinationconfig(
    it_services = VALUE /aws1/cl_iouservicelist_w=>tt_servicelist(
      ( new /aws1/cl_iouservicelist_w( |string| ) )
    )
    iv_thingname = |string|
  )
  io_timeoutconfig = new /aws1/cl_ioutimeoutconfig( 123 )
  it_tags = VALUE /aws1/cl_ioutag=>tt_taglist(
    (
      new /aws1/cl_ioutag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_description = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_tunnelid = lo_result->get_tunnelid( ).
  lv_tunnelarn = lo_result->get_tunnelarn( ).
  lv_clientaccesstoken = lo_result->get_sourceaccesstoken( ).
  lv_clientaccesstoken = lo_result->get_destinationaccesstoken( ).
ENDIF.

/AWS1/IF_IOU=>OPENTUNNEL()¶