data_set_permissions

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

Overview

Name	data_set_permissions
Type	Resource
Id	aws.quicksight.data_set_permissions

Fields

The following fields are returned by SELECT queries:

describe_data_set_permissions

Name	Datatype	Description
data_set_arn	string	The Amazon Resource Name (ARN) of the dataset.
data_set_id	string	The ID for the dataset that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
permissions	array	A list of resource permissions on the dataset.
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_data_set_permissions	select	aws_account_id, data_set_id, region		Describes the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
update_data_set_permissions	update	aws_account_id, data_set_id, region		Updates the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

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 Amazon Web Services account ID.
data_set_id	string	The ID for the dataset whose permissions you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_data_set_permissions

Describes the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

SELECT
data_set_arn,
data_set_id,
permissions,
request_id,
status
FROM aws.quicksight.data_set_permissions
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND data_set_id = '{{ data_set_id }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_data_set_permissions

Updates the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

UPDATE aws.quicksight.data_set_permissions
SET 
GrantPermissions = '{{ GrantPermissions }}',
RevokePermissions = '{{ RevokePermissions }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND data_set_id = '{{ data_set_id }}' --required
AND region = '{{ region }}' --required
RETURNING
data_set_arn,
data_set_id,
request_id,
status;