PUTSESSION()`¶

About PutSession¶

Creates a new session or modifies an existing session with an Amazon Lex V2 bot. Use this operation to enable your application to set the state of the bot.

Method Signature¶

METHODS /AWS1/IF_LR2~PUTSESSION
  IMPORTING
    !IV_BOTID TYPE /AWS1/LR2BOTIDENTIFIER OPTIONAL
    !IV_BOTALIASID TYPE /AWS1/LR2BOTALIASIDENTIFIER OPTIONAL
    !IV_LOCALEID TYPE /AWS1/LR2LOCALEID OPTIONAL
    !IV_SESSIONID TYPE /AWS1/LR2SESSIONID OPTIONAL
    !IT_MESSAGES TYPE /AWS1/CL_LR2MESSAGE=>TT_MESSAGES OPTIONAL
    !IO_SESSIONSTATE TYPE REF TO /AWS1/CL_LR2SESSIONSTATE OPTIONAL
    !IT_REQUESTATTRIBUTES TYPE /AWS1/CL_LR2STRINGMAP_W=>TT_STRINGMAP OPTIONAL
    !IV_RESPONSECONTENTTYPE TYPE /AWS1/LR2NONEMPTYSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lr2putsessionresponse
  RAISING
    /AWS1/CX_LR2ACCESSDENIEDEX
    /AWS1/CX_LR2BADGATEWAYEX
    /AWS1/CX_LR2CONFLICTEXCEPTION
    /AWS1/CX_LR2DEPENDENCYFAILEDEX
    /AWS1/CX_LR2INTERNALSERVEREX
    /AWS1/CX_LR2RESOURCENOTFOUNDEX
    /AWS1/CX_LR2THROTTLINGEX
    /AWS1/CX_LR2VALIDATIONEX
    /AWS1/CX_LR2CLIENTEXC
    /AWS1/CX_LR2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_botid` `TYPE /AWS1/LR2BOTIDENTIFIER` `/AWS1/LR2BOTIDENTIFIER`¶

The identifier of the bot that receives the session data.

`iv_botaliasid` `TYPE /AWS1/LR2BOTALIASIDENTIFIER` `/AWS1/LR2BOTALIASIDENTIFIER`¶

The alias identifier of the bot that receives the session data.

`iv_localeid` `TYPE /AWS1/LR2LOCALEID` `/AWS1/LR2LOCALEID`¶

The locale where the session is in use.

`iv_sessionid` `TYPE /AWS1/LR2SESSIONID` `/AWS1/LR2SESSIONID`¶

The identifier of the session that receives the session data.

`io_sessionstate` `TYPE REF TO /AWS1/CL_LR2SESSIONSTATE` `/AWS1/CL_LR2SESSIONSTATE`¶

Sets the state of the session with the user. You can use this to set the current intent, attributes, context, and dialog action. Use the dialog action to determine the next step that Amazon Lex V2 should use in the conversation with the user.

Optional arguments:¶

`it_messages` `TYPE /AWS1/CL_LR2MESSAGE=>TT_MESSAGES` `TT_MESSAGES`¶

A list of messages to send to the user. Messages are sent in the order that they are defined in the list.

`it_requestattributes` `TYPE /AWS1/CL_LR2STRINGMAP_W=>TT_STRINGMAP` `TT_STRINGMAP`¶

Request-specific information passed between Amazon Lex V2 and the client application.

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.

`iv_responsecontenttype` `TYPE /AWS1/LR2NONEMPTYSTRING` `/AWS1/LR2NONEMPTYSTRING`¶

The message that Amazon Lex V2 returns in the response can be either text or speech depending on the value of this parameter.

If the value is text/plain; charset=utf-8, Amazon Lex V2 returns text in the response.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_lr2putsessionresponse` `/AWS1/CL_LR2PUTSESSIONRESPONSE`¶

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->putsession(
  io_sessionstate = new /aws1/cl_lr2sessionstate(
    io_dialogaction = new /aws1/cl_lr2dialogaction(
      io_subslottoelicit = new /aws1/cl_lr2elicitsubslot(
        io_subslottoelicit = new /aws1/cl_lr2elicitsubslot( iv_name = |string| )
        iv_name = |string|
      )
      iv_slotelicitationstyle = |string|
      iv_slottoelicit = |string|
      iv_type = |string|
    )
    io_intent = new /aws1/cl_lr2intent(
      it_slots = VALUE /aws1/cl_lr2slot=>tt_slots(
        (
          VALUE /aws1/cl_lr2slot=>ts_slots_maprow(
            key = |string|
            value = new /aws1/cl_lr2slot(
              io_value = new /aws1/cl_lr2value(
                it_resolvedvalues = VALUE /aws1/cl_lr2stringlist_w=>tt_stringlist(
                  ( new /aws1/cl_lr2stringlist_w( |string| ) )
                )
                iv_interpretedvalue = |string|
                iv_originalvalue = |string|
              )
              it_subslots = VALUE /aws1/cl_lr2slot=>tt_slots(
              )
              it_values = VALUE /aws1/cl_lr2slot=>tt_values(
                (
                  new /aws1/cl_lr2slot(
                    io_value = new /aws1/cl_lr2value(
                      it_resolvedvalues = VALUE /aws1/cl_lr2stringlist_w=>tt_stringlist(
                        ( new /aws1/cl_lr2stringlist_w( |string| ) )
                      )
                      iv_interpretedvalue = |string|
                      iv_originalvalue = |string|
                    )
                    it_subslots = VALUE /aws1/cl_lr2slot=>tt_slots(
                    )
                    iv_shape = |string|
                  )
                )
              )
              iv_shape = |string|
            )
          )
        )
      )
      iv_confirmationstate = |string|
      iv_name = |string|
      iv_state = |string|
    )
    io_runtimehints = new /aws1/cl_lr2runtimehints(
      it_slothints = VALUE /aws1/cl_lr2runtimehintdetails=>tt_slothintsintentmap(
        (
          VALUE /aws1/cl_lr2runtimehintdetails=>ts_slothintsintentmap_maprow(
            key = |string|
            value = VALUE /aws1/cl_lr2runtimehintdetails=>tt_slothintsslotmap(
              (
                VALUE /aws1/cl_lr2runtimehintdetails=>ts_slothintsslotmap_maprow(
                  key = |string|
                  value = new /aws1/cl_lr2runtimehintdetails(
                    it_runtimehintvalues = VALUE /aws1/cl_lr2runtimehintvalue=>tt_runtimehintvalueslist(
                      ( new /aws1/cl_lr2runtimehintvalue( |string| ) )
                    )
                    it_subslothints = VALUE /aws1/cl_lr2runtimehintdetails=>tt_slothintsslotmap(
                    )
                  )
                )
              )
            )
          )
        )
      )
    )
    it_activecontexts = VALUE /aws1/cl_lr2activecontext=>tt_activecontextslist(
      (
        new /aws1/cl_lr2activecontext(
          io_timetolive = new /aws1/cl_lr2actctxtimetolive(
            iv_timetoliveinseconds = 123
            iv_turnstolive = 123
          )
          it_contextattributes = VALUE /aws1/cl_lr2actctxparamsmap_w=>tt_activecontextparametersmap(
            (
              VALUE /aws1/cl_lr2actctxparamsmap_w=>ts_activectxparamsmap_maprow(
                key = |string|
                value = new /aws1/cl_lr2actctxparamsmap_w( |string| )
              )
            )
          )
          iv_name = |string|
        )
      )
    )
    it_sessionattributes = VALUE /aws1/cl_lr2stringmap_w=>tt_stringmap(
      (
        VALUE /aws1/cl_lr2stringmap_w=>ts_stringmap_maprow(
          key = |string|
          value = new /aws1/cl_lr2stringmap_w( |string| )
        )
      )
    )
    iv_originatingrequestid = |string|
  )
  it_messages = VALUE /aws1/cl_lr2message=>tt_messages(
    (
      new /aws1/cl_lr2message(
        io_imageresponsecard = new /aws1/cl_lr2imageresponsecard(
          it_buttons = VALUE /aws1/cl_lr2button=>tt_buttonslist(
            (
              new /aws1/cl_lr2button(
                iv_text = |string|
                iv_value = |string|
              )
            )
          )
          iv_imageurl = |string|
          iv_subtitle = |string|
          iv_title = |string|
        )
        iv_content = |string|
        iv_contenttype = |string|
      )
    )
  )
  it_requestattributes = VALUE /aws1/cl_lr2stringmap_w=>tt_stringmap(
    (
      VALUE /aws1/cl_lr2stringmap_w=>ts_stringmap_maprow(
        key = |string|
        value = new /aws1/cl_lr2stringmap_w( |string| )
      )
    )
  )
  iv_botaliasid = |string|
  iv_botid = |string|
  iv_localeid = |string|
  iv_responsecontenttype = |string|
  iv_sessionid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_nonemptystring = lo_result->get_contenttype( ).
  lv_nonemptystring = lo_result->get_messages( ).
  lv_nonemptystring = lo_result->get_sessionstate( ).
  lv_nonemptystring = lo_result->get_requestattributes( ).
  lv_sessionid = lo_result->get_sessionid( ).
  lv_blobstream = lo_result->get_audiostream( ).
ENDIF.

/AWS1/IF_LR2=>PUTSESSION()¶

About PutSession¶

Method Signature¶

IMPORTING¶

Required arguments:¶

iv_botid TYPE /AWS1/LR2BOTIDENTIFIER /AWS1/LR2BOTIDENTIFIER¶

iv_botaliasid TYPE /AWS1/LR2BOTALIASIDENTIFIER /AWS1/LR2BOTALIASIDENTIFIER¶

iv_localeid TYPE /AWS1/LR2LOCALEID /AWS1/LR2LOCALEID¶

iv_sessionid TYPE /AWS1/LR2SESSIONID /AWS1/LR2SESSIONID¶

io_sessionstate TYPE REF TO /AWS1/CL_LR2SESSIONSTATE /AWS1/CL_LR2SESSIONSTATE¶