/AWS1/CL_QST=>CREATEDASHBOARD()

About CreateDashboard

Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the CreateTemplate API operation.

A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.

Method Signature

IMPORTING

Required arguments:

IV_AWSACCOUNTID TYPE /AWS1/QSTAWSACCOUNTID /AWS1/QSTAWSACCOUNTID

The ID of the Amazon Web Services account where you want to create the dashboard.

IV_DASHBOARDID TYPE /AWS1/QSTSHORTRESTRICTIVERES00 /AWS1/QSTSHORTRESTRICTIVERES00

The ID for the dashboard, also added to the IAM policy.

IV_NAME TYPE /AWS1/QSTDASHBOARDNAME /AWS1/QSTDASHBOARDNAME

The display name of the dashboard.

Optional arguments:

IO_PARAMETERS TYPE REF TO /AWS1/CL_QSTPARAMETERS /AWS1/CL_QSTPARAMETERS

The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.

IT_PERMISSIONS TYPE /AWS1/CL_QSTRESOURCEPERMISSION=>TT_RESOURCEPERMISSIONLIST TT_RESOURCEPERMISSIONLIST

A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

To specify no permissions, omit the permissions list.

IO_SOURCEENTITY TYPE REF TO /AWS1/CL_QSTDASHBOARDSRCENTITY /AWS1/CL_QSTDASHBOARDSRCENTITY

The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplateARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

IT_TAGS TYPE /AWS1/CL_QSTTAG=>TT_TAGLIST TT_TAGLIST

Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

IV_VERSIONDESCRIPTION TYPE /AWS1/QSTVERSIONDESCRIPTION /AWS1/QSTVERSIONDESCRIPTION

A description for the first version of the dashboard being created.

IO_DASHBOARDPUBLISHOPTIONS TYPE REF TO /AWS1/CL_QSTDASHBOARDPUBOPTS /AWS1/CL_QSTDASHBOARDPUBOPTS

Options for publishing the dashboard when you create it:

• AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, Amazon QuickSight 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.

IV_THEMEARN TYPE /AWS1/QSTARN /AWS1/QSTARN

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create 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.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

IO_VALIDATIONSTRATEGY TYPE REF TO /AWS1/CL_QSTVALIDATIONSTRATEGY /AWS1/CL_QSTVALIDATIONSTRATEGY

The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.

IT_FOLDERARNS TYPE /AWS1/CL_QSTFOLDERARNLIST_W=>TT_FOLDERARNLIST TT_FOLDERARNLIST

When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.

IO_LINKSHARINGCONFIGURATION TYPE REF TO /AWS1/CL_QSTLINKSHARINGCONF /AWS1/CL_QSTLINKSHARINGCONF

A structure that contains the permissions of a shareable link to the dashboard.

IT_LINKENTITIES TYPE /AWS1/CL_QSTLINKENTARNLIST_W=>TT_LINKENTITYARNLIST TT_LINKENTITYARNLIST

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_QSTCREATEDASHBOARDRSP /AWS1/CL_QSTCREATEDASHBOARDRSP