STARTQAPPSESSION()`¶

About StartQAppSession¶

Starts a new session for an Amazon Q App, allowing inputs to be provided and the app to be run.

Each Q App session will be condensed into a single conversation in the web experience.

Method Signature¶

METHODS /AWS1/IF_QQA~STARTQAPPSESSION
  IMPORTING
    !IV_INSTANCEID TYPE /AWS1/QQAINSTANCEID OPTIONAL
    !IV_APPID TYPE /AWS1/QQAUUID OPTIONAL
    !IV_APPVERSION TYPE /AWS1/QQAAPPVERSION OPTIONAL
    !IT_INITIALVALUES TYPE /AWS1/CL_QQACARDVALUE=>TT_CARDVALUELIST OPTIONAL
    !IV_SESSIONID TYPE /AWS1/QQASTRING OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_QQATAGMAP_W=>TT_TAGMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qqastartqappsessout
  RAISING
    /AWS1/CX_QQAACCESSDENIEDEX
    /AWS1/CX_QQAINTERNALSERVEREX
    /AWS1/CX_QQARESOURCENOTFOUNDEX
    /AWS1/CX_QQASERVICEQUOTAEXCDEX
    /AWS1/CX_QQATHROTTLINGEX
    /AWS1/CX_QQAUNAUTHORIZEDEX
    /AWS1/CX_QQAVALIDATIONEX
    /AWS1/CX_QQACLIENTEXC
    /AWS1/CX_QQASERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_instanceid` `TYPE /AWS1/QQAINSTANCEID` `/AWS1/QQAINSTANCEID`¶

The unique identifier of the Amazon Q Business application environment instance.

`iv_appid` `TYPE /AWS1/QQAUUID` `/AWS1/QQAUUID`¶

The unique identifier of the Q App to start a session for.

`iv_appversion` `TYPE /AWS1/QQAAPPVERSION` `/AWS1/QQAAPPVERSION`¶

The version of the Q App to use for the session.

Optional arguments:¶

`it_initialvalues` `TYPE /AWS1/CL_QQACARDVALUE=>TT_CARDVALUELIST` `TT_CARDVALUELIST`¶

Optional initial input values to provide for the Q App session.

`iv_sessionid` `TYPE /AWS1/QQASTRING` `/AWS1/QQASTRING`¶

The unique identifier of the a Q App session.

`it_tags` `TYPE /AWS1/CL_QQATAGMAP_W=>TT_TAGMAP` `TT_TAGMAP`¶

Optional tags to associate with the new Q App session.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_qqastartqappsessout` `/AWS1/CL_QQASTARTQAPPSESSOUT`¶

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->startqappsession(
  it_initialvalues = VALUE /aws1/cl_qqacardvalue=>tt_cardvaluelist(
    (
      new /aws1/cl_qqacardvalue(
        io_submissionmutation = new /aws1/cl_qqasubmissionmutation(
          iv_mutationtype = |string|
          iv_submissionid = |string|
        )
        iv_cardid = |string|
        iv_value = |string|
      )
    )
  )
  it_tags = VALUE /aws1/cl_qqatagmap_w=>tt_tagmap(
    (
      VALUE /aws1/cl_qqatagmap_w=>ts_tagmap_maprow(
        key = |string|
        value = new /aws1/cl_qqatagmap_w( |string| )
      )
    )
  )
  iv_appid = |string|
  iv_appversion = 123
  iv_instanceid = |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_string = lo_result->get_sessionid( ).
  lv_string = lo_result->get_sessionarn( ).
ENDIF.

Start a session for an Amazon Q App using version 1, passing in initial values for one card¶

Start a session for an Amazon Q App using version 1, passing in initial values for one card

DATA(lo_result) = lo_client->startqappsession(
  it_initialvalues = VALUE /aws1/cl_qqacardvalue=>tt_cardvaluelist(
    (
      new /aws1/cl_qqacardvalue(
        iv_cardid = |6fb5b404-3b7b-48a4-8a8b-56406922a606|
        iv_value = |What is the circumference of Earth?|
      )
    )
  )
  iv_appid = |65e7dce7-226a-47f9-b689-22850becef89|
  iv_appversion = 1
  iv_instanceid = |4cc5e4c2-d2a2-4188-a114-9ca125b4aedc|
).

/AWS1/IF_QQA=>STARTQAPPSESSION()¶