analysis_permissions

Creates, updates, deletes, gets or lists an analysis_permissions resource.

Overview

Name	analysis_permissions
Type	Resource
Id	aws.quicksight.analysis_permissions

Fields

The following fields are returned by SELECT queries:

describe_analysis_permissions

Name	Datatype	Description
analysis_arn	string	The Amazon Resource Name (ARN) of the analysis whose permissions you're describing.
analysis_id	string	The ID of the analysis whose permissions you're describing. (pattern: <code>[\w-]+</code>)
permissions	array	A structure that describes the principals and the resource-level permissions on an analysis.
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_analysis_permissions	select	aws_account_id, analysis_id, region		Provides the read and write permissions for an analysis.
update_analysis_permissions	update	aws_account_id, analysis_id, region		Updates the read and write permissions for an analysis.

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
analysis_id	string	The ID of the analysis whose permissions you're updating. The ID is part of the analysis URL.
aws_account_id	string	The ID of the Amazon Web Services account that contains the analysis whose permissions you're updating. You must be using the Amazon Web Services account that the analysis is in.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_analysis_permissions

Provides the read and write permissions for an analysis.

SELECT
analysis_arn,
analysis_id,
permissions,
request_id,
status
FROM aws.quicksight.analysis_permissions
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND analysis_id = '{{ analysis_id }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_analysis_permissions

Updates the read and write permissions for an analysis.

UPDATE aws.quicksight.analysis_permissions
SET 
GrantPermissions = '{{ GrantPermissions }}',
RevokePermissions = '{{ RevokePermissions }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND analysis_id = '{{ analysis_id }}' --required
AND region = '{{ region }}' --required
RETURNING
analysis_arn,
analysis_id,
permissions,
request_id,
status;