Skip to main content

dashboards

Creates, updates, deletes or gets a dashboard resource or lists dashboards in a region

Overview

Namedashboards
TypeResource
DescriptionDefinition of the AWS::QuickSight::Dashboard Resource Type.
Idawscc.quicksight.dashboards

Fields

NameDatatypeDescription
created_timestring<p>The time that this dashboard was created.</p>
parametersobject<p>A list of Amazon QuickSight parameters and the list's override values.</p>
version_descriptionstring
source_entityobject<p>Dashboard source entity.</p>
theme_arnstring
definitionobject
last_updated_timestring<p>The last time that this dashboard was updated.</p>
validation_strategyobject<p>The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to &#95;&#95;CODE&#95;BLOCK&#95;0&#95;&#95;, validation is skipped for specific errors.</p>
folder_arnsarray
dashboard_idstring
link_sharing_configurationobject
namestring
dashboard_publish_optionsobject<p>Dashboard publish options.</p>
last_published_timestring<p>The last time that this dashboard was published.</p>
versionobject<p>Dashboard version.</p>
aws_account_idstring
permissionsarray
link_entitiesarray
arnstring<p>The Amazon Resource Name (ARN) of the resource.</p>
tagsarray
regionstringAWS region.

For more information, see AWS::QuickSight::Dashboard.

Methods

NameAccessible byRequired Params
create_resourceINSERTAwsAccountId, DashboardId, Name, region
delete_resourceDELETEdata__Identifier, region
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
list_resourcesSELECTregion
get_resourceSELECTdata__Identifier, region

SELECT examples

Gets all properties from an individual dashboard.

SELECT
region,
created_time,
parameters,
version_description,
source_entity,
theme_arn,
definition,
last_updated_time,
validation_strategy,
folder_arns,
dashboard_id,
link_sharing_configuration,
name,
dashboard_publish_options,
last_published_time,
version,
aws_account_id,
permissions,
link_entities,
arn,
tags
FROM awscc.quicksight.dashboards
WHERE region = 'us-east-1' AND data__Identifier = '<AwsAccountId>|<DashboardId>';

INSERT example

Use the following StackQL query and manifest file to create a new dashboard resource, using stack-deploy.

/*+ create */
INSERT INTO awscc.quicksight.dashboards (
DashboardId,
Name,
AwsAccountId,
region
)
SELECT
'{{ DashboardId }}',
'{{ Name }}',
'{{ AwsAccountId }}',
'{{ region }}';

DELETE example

/*+ delete */
DELETE FROM awscc.quicksight.dashboards
WHERE data__Identifier = '<AwsAccountId|DashboardId>'
AND region = 'us-east-1';

Permissions

To operate on the dashboards resource, the following permissions are required:

Read

quicksight:DescribeDashboard,
quicksight:DescribeDashboardPermissions,
quicksight:ListTagsForResource

Create

quicksight:DescribeDashboard,
quicksight:DescribeDashboardPermissions,
quicksight:CreateDashboard,
quicksight:DescribeTemplate,
quicksight:DescribeTheme,
quicksight:PassDataSet,
quicksight:TagResource,
quicksight:UntagResource,
quicksight:ListTagsForResource,
quicksight:CreateFolderMembership,
quicksight:DeleteFolderMembership,
quicksight:ListFoldersForResource

Update

quicksight:DescribeDashboard,
quicksight:DescribeDashboardPermissions,
quicksight:UpdateDashboard,
quicksight:UpdateDashboardLinks,
quicksight:UpdateDashboardPermissions,
quicksight:UpdateDashboardPublishedVersion,
quicksight:DescribeTemplate,
quicksight:DescribeTheme,
quicksight:PassDataSet,
quicksight:CreateFolderMembership,
quicksight:DeleteFolderMembership,
quicksight:ListFoldersForResource,
quicksight:TagResource,
quicksight:UntagResource,
quicksight:ListTagsForResource

List

quicksight:ListDashboards

Delete

quicksight:DescribeDashboard,
quicksight:DeleteDashboard