Skip to content

/AWS1/CL_QSTDSCDASHBOARDDEFRSP

DescribeDashboardDefinitionResponse

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_dashboardid TYPE /AWS1/QSTSHORTRESTRICTIVERES00 /AWS1/QSTSHORTRESTRICTIVERES00

The ID of the dashboard described.

it_errors TYPE /AWS1/CL_QSTDASHBOARDERROR=>TT_DASHBOARDERRORLIST TT_DASHBOARDERRORLIST

Errors associated with this dashboard version.

iv_name TYPE /AWS1/QSTDASHBOARDNAME /AWS1/QSTDASHBOARDNAME

The display name of the dashboard.

iv_resourcestatus TYPE /AWS1/QSTRESOURCESTATUS /AWS1/QSTRESOURCESTATUS

Status associated with the dashboard version.

  • CREATION_IN_PROGRESS

  • CREATION_SUCCESSFUL

  • CREATION_FAILED

  • UPDATE_IN_PROGRESS

  • UPDATE_SUCCESSFUL

  • UPDATE_FAILED

  • DELETED

iv_themearn TYPE /AWS1/QSTARN /AWS1/QSTARN

The ARN of the theme of the dashboard.

io_definition TYPE REF TO /AWS1/CL_QSTDASHBOARDVRSDEFN /AWS1/CL_QSTDASHBOARDVRSDEFN

The definition of a dashboard.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

iv_status TYPE /AWS1/QSTSTATUSCODE /AWS1/QSTSTATUSCODE

The HTTP status of the request.

iv_requestid TYPE /AWS1/QSTSTRING /AWS1/QSTSTRING

The Amazon Web Services request ID for this operation.

io_dashboardpublishoptions TYPE REF TO /AWS1/CL_QSTDASHBOARDPUBOPTS /AWS1/CL_QSTDASHBOARDPUBOPTS

Options for publishing the dashboard:

  • AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, Amazon Quick Sight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

  • AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.

  • VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.

  • AvailabilityStatus for QuickSuiteActionsOption - This status can be either ENABLED or DISABLED. Features related to Actions in Amazon Quick Suite on dashboards are disabled when this is set to DISABLED. This option is DISABLED by default.

  • AvailabilityStatus for ExecutiveSummaryOption - This status can be either ENABLED or DISABLED. The option to build an executive summary is disabled when this is set to DISABLED. This option is ENABLED by default.

  • AvailabilityStatus for DataStoriesSharingOption - This status can be either ENABLED or DISABLED. The option to share a data story is disabled when this is set to DISABLED. This option is ENABLED by default.

Queryable Attributes

DashboardId

The ID of the dashboard described.

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

Errors

Errors associated with this dashboard version.

Accessible with the following methods

Method Description
GET_ERRORS() Getter for ERRORS, with configurable default
ASK_ERRORS() Getter for ERRORS w/ exceptions if field has no value
HAS_ERRORS() Determine if ERRORS has a value

Name

The display name of the dashboard.

Accessible with the following methods

Method Description
GET_NAME() Getter for NAME, with configurable default
ASK_NAME() Getter for NAME w/ exceptions if field has no value
HAS_NAME() Determine if NAME has a value

ResourceStatus

Status associated with the dashboard version.

  • CREATION_IN_PROGRESS

  • CREATION_SUCCESSFUL

  • CREATION_FAILED

  • UPDATE_IN_PROGRESS

  • UPDATE_SUCCESSFUL

  • UPDATE_FAILED

  • DELETED

Accessible with the following methods

Method Description
GET_RESOURCESTATUS() Getter for RESOURCESTATUS, with configurable default
ASK_RESOURCESTATUS() Getter for RESOURCESTATUS w/ exceptions if field has no valu
HAS_RESOURCESTATUS() Determine if RESOURCESTATUS has a value

ThemeArn

The ARN of the theme of the dashboard.

Accessible with the following methods

Method Description
GET_THEMEARN() Getter for THEMEARN, with configurable default
ASK_THEMEARN() Getter for THEMEARN w/ exceptions if field has no value
HAS_THEMEARN() Determine if THEMEARN has a value

Definition

The definition of a dashboard.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

Accessible with the following methods

Method Description
GET_DEFINITION() Getter for DEFINITION

Status

The HTTP status of the request.

Accessible with the following methods

Method Description
GET_STATUS() Getter for STATUS

RequestId

The Amazon Web Services request ID for this operation.

Accessible with the following methods

Method Description
GET_REQUESTID() Getter for REQUESTID, with configurable default
ASK_REQUESTID() Getter for REQUESTID w/ exceptions if field has no value
HAS_REQUESTID() Determine if REQUESTID has a value

DashboardPublishOptions

Options for publishing the dashboard:

  • AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, Amazon Quick Sight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

  • AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.

  • VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.

  • AvailabilityStatus for QuickSuiteActionsOption - This status can be either ENABLED or DISABLED. Features related to Actions in Amazon Quick Suite on dashboards are disabled when this is set to DISABLED. This option is DISABLED by default.

  • AvailabilityStatus for ExecutiveSummaryOption - This status can be either ENABLED or DISABLED. The option to build an executive summary is disabled when this is set to DISABLED. This option is ENABLED by default.

  • AvailabilityStatus for DataStoriesSharingOption - This status can be either ENABLED or DISABLED. The option to share a data story is disabled when this is set to DISABLED. This option is ENABLED by default.

Accessible with the following methods

Method Description
GET_DASHBOARDPUBLISHOPTIONS() Getter for DASHBOARDPUBLISHOPTIONS