dashboard_definitions

Creates, updates, deletes, gets or lists a dashboard_definitions resource.

Overview

Name	dashboard_definitions
Type	Resource
Id	aws.quicksight.dashboard_definitions

Fields

The following fields are returned by SELECT queries:

describe_dashboard_definition

Name	Datatype	Description
dashboard_id	string	The ID of the dashboard described. (pattern: <code>[\w-]+</code>)
dashboard_publish_options	object	Dashboard publish options.
definition	object	The contents of a dashboard.
errors	array	Errors associated with this dashboard version.
name	string	The display name of the dashboard.
request_id	string	The Amazon Web Services request ID for this operation.
resource_status	string	Status associated with the dashboard version. CREATION_IN_PROGRESS CREATION_SUCCESSFUL CREATION_FAILED UPDATE_IN_PROGRESS UPDATE_SUCCESSFUL UPDATE_FAILED DELETED (CREATION_IN_PROGRESS, CREATION_SUCCESSFUL, CREATION_FAILED, UPDATE_IN_PROGRESS, UPDATE_SUCCESSFUL, UPDATE_FAILED, DELETED)
status	integer	The HTTP status of the request.
theme_arn	string	The ARN of the theme of the dashboard.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_dashboard_definition	select	aws_account_id, dashboard_id, region	version-number, alias-name	Provides a detailed description of the definition of a dashboard. If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the DescribeDashboard instead.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
aws_account_id	string	The ID of the Amazon Web Services account that contains the dashboard that you're describing.
dashboard_id	string	The ID for the dashboard.
region	string	AWS region (default: us-east-1)
alias-name	string	The alias name.
version-number	integer (int64)	The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.

SELECT examples

describe_dashboard_definition

Provides a detailed description of the definition of a dashboard. If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the DescribeDashboard instead.

SELECT
dashboard_id,
dashboard_publish_options,
definition,
errors,
name,
request_id,
resource_status,
status,
theme_arn
FROM aws.quicksight.dashboard_definitions
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND dashboard_id = '{{ dashboard_id }}' -- required
AND region = '{{ region }}' -- required
AND `version-number` = '{{ version-number }}'
AND `alias-name` = '{{ alias-name }}'
;