GENERATEEMBEDURLFORREGEDUS00()`¶

About GenerateEmbedUrlForRegisteredUserWithIdentity¶

Generates an embed URL that you can use to embed an Amazon Quick Sight experience in your website. This action can be used for any type of user that is registered in an Amazon Quick Sight account that uses IAM Identity Center for authentication. This API requires identity-enhanced IAM Role sessions for the authenticated user that the API call is being made for.

This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for Amazon Quick Sight with the scope value set to quicksight:read. Before you use this action, make sure that you have configured the relevant Amazon Quick Sight resource and permissions.

Method Signature¶

METHODS /AWS1/IF_QST~GENERATEEMBEDURLFORREGEDUS00
  IMPORTING
    !IV_AWSACCOUNTID TYPE /AWS1/QSTAWSACCOUNTID OPTIONAL
    !IV_SESSIONLIFETIMEINMINUTES TYPE /AWS1/QSTSESSLIFETIMEINMINUTES 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_qstgenerateembedurl05
  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 of the Amazon Web Services registered user.

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

The type of experience you want to embed. For registered users, you can embed Quick dashboards or the Amazon Quick Sight console.

Exactly one of the experience configurations is required. You can choose Dashboard or QuickSightConsole. You cannot choose more than one experience configuration.

Optional arguments:¶

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

The validity of the session in minutes.

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

A list of domains to be allowed to generate the embed URL.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_qstgenerateembedurl05` `/AWS1/CL_QSTGENERATEEMBEDURL05`¶

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->generateembedurlforregedus00(
  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_quickchat = new /aws1/cl_qstreguserquickchat00( )
    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
).

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=>GENERATEEMBEDURLFORREGEDUS00()¶