/AWS1/CL_QSTREGEDUSEREMBEDDI00

The type of experience you want to embed. For registered users, you can embed Quick Suite 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.

CONSTRUCTOR

IMPORTING

Optional arguments:

io_dashboard TYPE REF TO /AWS1/CL_QSTREGEDUSERDASHBOA00 /AWS1/CL_QSTREGEDUSERDASHBOA00

The configuration details for providing a dashboard embedding experience.

io_quicksightconsole TYPE REF TO /AWS1/CL_QSTREGEDUSERQUICKSI00 /AWS1/CL_QSTREGEDUSERQUICKSI00

The configuration details for providing each Amazon Quick Sight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon Quick Sight Console in the Amazon Quick Suite User Guide.

Use GenerateEmbedUrlForRegisteredUser where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who accesses an embedded Amazon Quick Sight console needs to belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use the RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon Quick Suite User Guide:

• Embedding the Full Functionality of the Amazon Quick Sight Console for Authenticated Users

• Customizing Access to the Amazon Quick Suite Console

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.

io_qsearchbar TYPE REF TO /AWS1/CL_QSTREGEDUSERQSRCHBA00 /AWS1/CL_QSTREGEDUSERQSRCHBA00

The configuration details for embedding the Q search bar.

For more information about embedding the Q search bar, see Embedding Overview in the Amazon Quick Sight User Guide.

io_dashboardvisual TYPE REF TO /AWS1/CL_QSTREGEDUSERDASHBOA01 /AWS1/CL_QSTREGEDUSERDASHBOA01

The type of embedding experience. In this case, Amazon Quick Sight visuals.

io_generativeqna TYPE REF TO /AWS1/CL_QSTREGEDUSERGENERAT00 /AWS1/CL_QSTREGEDUSERGENERAT00

The configuration details for embedding the Generative Q&A experience.

For more information about embedding the Generative Q&A experience, see Embedding Overview in the Amazon Quick Sight User Guide.

---

Queryable Attributes

Dashboard

The configuration details for providing a dashboard embedding experience.

Accessible with the following methods

Method	Description
GET_DASHBOARD()	Getter for DASHBOARD

QuickSightConsole

The configuration details for providing each Amazon Quick Sight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon Quick Sight Console in the Amazon Quick Suite User Guide.

Use GenerateEmbedUrlForRegisteredUser where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who accesses an embedded Amazon Quick Sight console needs to belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use the RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon Quick Suite User Guide:

• Embedding the Full Functionality of the Amazon Quick Sight Console for Authenticated Users

• Customizing Access to the Amazon Quick Suite Console

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.

Accessible with the following methods

Method	Description
GET_QUICKSIGHTCONSOLE()	Getter for QUICKSIGHTCONSOLE

QSearchBar

The configuration details for embedding the Q search bar.

For more information about embedding the Q search bar, see Embedding Overview in the Amazon Quick Sight User Guide.

Accessible with the following methods

Method	Description
GET_QSEARCHBAR()	Getter for QSEARCHBAR

DashboardVisual

The type of embedding experience. In this case, Amazon Quick Sight visuals.

Accessible with the following methods

Method	Description
GET_DASHBOARDVISUAL()	Getter for DASHBOARDVISUAL

GenerativeQnA

The configuration details for embedding the Generative Q&A experience.

For more information about embedding the Generative Q&A experience, see Embedding Overview in the Amazon Quick Sight User Guide.

Accessible with the following methods

Method	Description
GET_GENERATIVEQNA()	Getter for GENERATIVEQNA