GENERATEEMBEDURLFORREGEDUSER()`¶

About GenerateEmbedUrlForRegisteredUser¶

Generates an embed URL that you can use to embed an Amazon Quick Suite experience in your website. This action can be used for any type of user registered in an Amazon Quick Suite account. Before you use this action, make sure that you have configured the relevant Amazon Quick Suite resource and permissions.

The following rules apply to the generated URL:

It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter.

The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.
You are charged only when the URL is used or there is interaction with Amazon Quick Suite.

For more information, see Embedded Analytics in the Amazon Quick Suite User Guide.

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon Quick Suite Developer Portal.

Method Signature¶

METHODS /AWS1/IF_QST~GENERATEEMBEDURLFORREGEDUSER
  IMPORTING
    !IV_AWSACCOUNTID TYPE /AWS1/QSTAWSACCOUNTID OPTIONAL
    !IV_SESSIONLIFETIMEINMINUTES TYPE /AWS1/QSTSESSLIFETIMEINMINUTES OPTIONAL
    !IV_USERARN TYPE /AWS1/QSTARN OPTIONAL
    !IO_EXPERIENCECONFIGURATION TYPE REF TO /AWS1/CL_QSTREGEDUSEREMBEDDI00 OPTIONAL
    !IT_ALLOWEDDOMAINS TYPE /AWS1/CL_QSTSTRINGLIST_W=>TT_STRINGLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qstgenerateembedurl03
  RAISING
    /AWS1/CX_QSTACCESSDENIEDEX
    /AWS1/CX_QSTINTERNALFAILUREEX
    /AWS1/CX_QSTINVPARAMVALUEEX
    /AWS1/CX_QSTQUICKSIGHTUSERNO00
    /AWS1/CX_QSTRESOURCENOTFOUNDEX
    /AWS1/CX_QSTSESSLIFETIMEINMI00
    /AWS1/CX_QSTTHROTTLINGEX
    /AWS1/CX_QSTUNSUPPEDPRICINGP00
    /AWS1/CX_QSTUNSUPPEDUSEREDIT00
    /AWS1/CX_QSTCLIENTEXC
    /AWS1/CX_QSTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_awsaccountid` `TYPE /AWS1/QSTAWSACCOUNTID` `/AWS1/QSTAWSACCOUNTID`¶

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

`iv_userarn` `TYPE /AWS1/QSTARN` `/AWS1/QSTARN`¶

The Amazon Resource Name for the registered user.

`io_experienceconfiguration` `TYPE REF TO /AWS1/CL_QSTREGEDUSEREMBEDDI00` `/AWS1/CL_QSTREGEDUSEREMBEDDI00`¶

The experience that you want to embed. For registered users, you can embed Quick Suite dashboards, Amazon Quick Sight visuals, the Amazon Quick Sight Q search bar, the Amazon Quick Sight Generative Q&A experience, or the entire Amazon Quick Sight console.

Optional arguments:¶

`iv_sessionlifetimeinminutes` `TYPE /AWS1/QSTSESSLIFETIMEINMINUTES` `/AWS1/QSTSESSLIFETIMEINMINUTES`¶

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

`it_alloweddomains` `TYPE /AWS1/CL_QSTSTRINGLIST_W=>TT_STRINGLIST` `TT_STRINGLIST`¶

The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage Quick Sight menu in the Amazon Quick Sight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

To include all subdomains under a specific domain to the allow list, use . For example, https://.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_qstgenerateembedurl03` `/AWS1/CL_QSTGENERATEEMBEDURL03`¶

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->generateembedurlforregeduser(
  io_experienceconfiguration = new /aws1/cl_qstregeduserembeddi00(
    io_dashboard = new /aws1/cl_qstregeduserdashboa00(
      io_featureconfigurations = new /aws1/cl_qstregeduserdashboa02(
        io_amazonqinquicksight = new /aws1/cl_qstamazonqinquicksi00( new /aws1/cl_qstexecutivesummconfs( ABAP_TRUE ) )
        io_bookmarks = new /aws1/cl_qstbookmarksconfs( ABAP_TRUE )
        io_recentsnapshots = new /aws1/cl_qstrecentsnapsconfs( ABAP_TRUE )
        io_schedules = new /aws1/cl_qstschedulesconfs( ABAP_TRUE )
        io_sharedview = new /aws1/cl_qstsharedviewconfs( ABAP_TRUE )
        io_statepersistence = new /aws1/cl_qststatepersistence00( ABAP_TRUE )
        io_thresholdalerts = new /aws1/cl_qstthreshalertsconfs( ABAP_TRUE )
      )
      iv_initialdashboardid = |string|
    )
    io_dashboardvisual = new /aws1/cl_qstregeduserdashboa01(
      io_initialdashboardvisualid = new /aws1/cl_qstdashboardvisualid(
        iv_dashboardid = |string|
        iv_sheetid = |string|
        iv_visualid = |string|
      )
    )
    io_generativeqna = new /aws1/cl_qstregedusergenerat00( |string| )
    io_qsearchbar = new /aws1/cl_qstregeduserqsrchba00( |string| )
    io_quicksightconsole = new /aws1/cl_qstregeduserquicksi00(
      io_featureconfigurations = new /aws1/cl_qstregeduserconsole00(
        io_amazonqinquicksight = new /aws1/cl_qstamazonqinquicksi01(
          io_dataqna = new /aws1/cl_qstdataqnaconfs( ABAP_TRUE )
          io_datastories = new /aws1/cl_qstdatastoriesconfs( ABAP_TRUE )
          io_executivesummary = new /aws1/cl_qstexecutivesummconfs( ABAP_TRUE )
          io_generativeauthoring = new /aws1/cl_qstgenerativeauthor00( ABAP_TRUE )
        )
        io_recentsnapshots = new /aws1/cl_qstrecentsnapsconfs( ABAP_TRUE )
        io_schedules = new /aws1/cl_qstschedulesconfs( ABAP_TRUE )
        io_sharedview = new /aws1/cl_qstsharedviewconfs( ABAP_TRUE )
        io_statepersistence = new /aws1/cl_qststatepersistence00( ABAP_TRUE )
        io_thresholdalerts = new /aws1/cl_qstthreshalertsconfs( ABAP_TRUE )
      )
      iv_initialpath = |string|
    )
  )
  it_alloweddomains = VALUE /aws1/cl_qststringlist_w=>tt_stringlist(
    ( new /aws1/cl_qststringlist_w( |string| ) )
  )
  iv_awsaccountid = |string|
  iv_sessionlifetimeinminutes = 123
  iv_userarn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_embeddingurl = lo_result->get_embedurl( ).
  lv_statuscode = lo_result->get_status( ).
  lv_string = lo_result->get_requestid( ).
ENDIF.

/AWS1/IF_QST=>GENERATEEMBEDURLFORREGEDUSER()¶