Skip to content

/AWS1/CL_QSTDASHBOARDVISUALID

A structure that contains the following elements:

  • The DashboardId of the dashboard that has the visual that you want to embed.

  • The SheetId of the sheet that has the visual that you want to embed.

  • The VisualId of the visual that you want to embed.

The DashboardId, SheetId, and VisualId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon Quick Sight console. You can also get the DashboardId with a ListDashboards API operation.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_dashboardid TYPE /AWS1/QSTSHORTRESTRICTIVERES00 /AWS1/QSTSHORTRESTRICTIVERES00

The ID of the dashboard that has the visual that you want to embed. The DashboardId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Quick Suite console. You can also get the DashboardId with a ListDashboards API operation.

iv_sheetid TYPE /AWS1/QSTSHORTRESTRICTIVERES00 /AWS1/QSTSHORTRESTRICTIVERES00

The ID of the sheet that the has visual that you want to embed. The SheetId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Quick Suite console.

iv_visualid TYPE /AWS1/QSTSHORTRESTRICTIVERES00 /AWS1/QSTSHORTRESTRICTIVERES00

The ID of the visual that you want to embed. The VisualID can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon Quick Sight console.

Queryable Attributes

DashboardId

The ID of the dashboard that has the visual that you want to embed. The DashboardId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Quick Suite console. You can also get the DashboardId with a ListDashboards API operation.

Accessible with the following methods

Method Description
GET_DASHBOARDID() Getter for DASHBOARDID, with configurable default
ASK_DASHBOARDID() Getter for DASHBOARDID w/ exceptions if field has no value
HAS_DASHBOARDID() Determine if DASHBOARDID has a value

SheetId

The ID of the sheet that the has visual that you want to embed. The SheetId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Quick Suite console.

Accessible with the following methods

Method Description
GET_SHEETID() Getter for SHEETID, with configurable default
ASK_SHEETID() Getter for SHEETID w/ exceptions if field has no value
HAS_SHEETID() Determine if SHEETID has a value

VisualId

The ID of the visual that you want to embed. The VisualID can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon Quick Sight console.

Accessible with the following methods

Method Description
GET_VISUALID() Getter for VISUALID, with configurable default
ASK_VISUALID() Getter for VISUALID w/ exceptions if field has no value
HAS_VISUALID() Determine if VISUALID has a value