dashboard_permissions

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

Overview

Name	dashboard_permissions
Type	Resource
Id	aws.quicksight.dashboard_permissions

Fields

The following fields are returned by SELECT queries:

describe_dashboard_permissions

Name	Datatype	Description
dashboard_arn	string	The Amazon Resource Name (ARN) of the dashboard.
dashboard_id	string	The ID for the dashboard. (pattern: <code>[\w-]+</code>)
link_sharing_configuration	object	A structure that contains the configuration of a shareable link to the dashboard.
permissions	array	A structure that contains the permissions for the dashboard.
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of the request.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_dashboard_permissions	select	aws_account_id, dashboard_id, region		Describes read and write permissions for a dashboard.
update_dashboard_permissions	update	aws_account_id, dashboard_id, region		Updates read and write permissions on a dashboard.

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 whose permissions you're updating.
dashboard_id	string	The ID for the dashboard.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_dashboard_permissions

Describes read and write permissions for a dashboard.

SELECT
dashboard_arn,
dashboard_id,
link_sharing_configuration,
permissions,
request_id,
status
FROM aws.quicksight.dashboard_permissions
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND dashboard_id = '{{ dashboard_id }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_dashboard_permissions

Updates read and write permissions on a dashboard.

UPDATE aws.quicksight.dashboard_permissions
SET 
GrantPermissions = '{{ GrantPermissions }}',
RevokePermissions = '{{ RevokePermissions }}',
GrantLinkPermissions = '{{ GrantLinkPermissions }}',
RevokeLinkPermissions = '{{ RevokeLinkPermissions }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND dashboard_id = '{{ dashboard_id }}' --required
AND region = '{{ region }}' --required
RETURNING
dashboard_arn,
dashboard_id,
link_sharing_configuration,
permissions,
request_id,
status;