folder_permissions

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

Overview

Name	folder_permissions
Type	Resource
Id	aws.quicksight.folder_permissions

Fields

The following fields are returned by SELECT queries:

describe_folder_permissions

Name	Datatype	Description
actions	array	The IAM action to grant or revoke permissions on.
principal	string	The Amazon Resource Name (ARN) of the principal. This can be one of the following: The ARN of an Quick Sight user or group associated with a data source or dataset. (This is common.) The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.) The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_folder_permissions	select	aws_account_id, folder_id, region	namespace, max-results, next-token	Describes permissions for a folder.
update_folder_permissions	update	aws_account_id, folder_id, region		Updates permissions of a folder.

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 for the Amazon Web Services account that contains the folder to update.
folder_id	string	The ID of the folder.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of results to be returned per request.
namespace	string	The namespace of the folder whose permissions you want described.
next-token	string	A pagination token for the next set of results.

SELECT examples

describe_folder_permissions

Describes permissions for a folder.

SELECT
actions,
principal
FROM aws.quicksight.folder_permissions
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND folder_id = '{{ folder_id }}' -- required
AND region = '{{ region }}' -- required
AND namespace = '{{ namespace }}'
AND `max-results` = '{{ max-results }}'
AND `next-token` = '{{ next-token }}'
;

UPDATE examples

update_folder_permissions

Updates permissions of a folder.

UPDATE aws.quicksight.folder_permissions
SET 
GrantPermissions = '{{ GrantPermissions }}',
RevokePermissions = '{{ RevokePermissions }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND folder_id = '{{ folder_id }}' --required
AND region = '{{ region }}' --required
RETURNING
arn,
folder_id,
permissions,
request_id,
status;