topic_permissions

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

Overview

Name	topic_permissions
Type	Resource
Id	aws.quicksight.topic_permissions

Fields

The following fields are returned by SELECT queries:

describe_topic_permissions

Name	Datatype	Description
permissions	array	A list of resource permissions that are configured to the topic.
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of the request.
topic_arn	string	The Amazon Resource Name (ARN) of the topic.
topic_id	string	The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. (pattern: <code>^[A-Za-z0-9-_.\+]*$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_topic_permissions	select	aws_account_id, topic_id, region		Describes the permissions of a topic.
update_topic_permissions	update	aws_account_id, topic_id, region		Updates the permissions of a topic.

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

SELECT examples

describe_topic_permissions

Describes the permissions of a topic.

SELECT
permissions,
request_id,
status,
topic_arn,
topic_id
FROM aws.quicksight.topic_permissions
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND topic_id = '{{ topic_id }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_topic_permissions

Updates the permissions of a topic.

UPDATE aws.quicksight.topic_permissions
SET 
GrantPermissions = '{{ GrantPermissions }}',
RevokePermissions = '{{ RevokePermissions }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND topic_id = '{{ topic_id }}' --required
AND region = '{{ region }}' --required
RETURNING
permissions,
request_id,
status,
topic_arn,
topic_id;