knowledge_base_permissions

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

Overview

Name	knowledge_base_permissions
Type	Resource
Id	aws.quicksight.knowledge_base_permissions

Fields

The following fields are returned by SELECT queries:

describe_knowledge_base_permissions

Name	Datatype	Description
knowledge_base_arn	string	The Amazon Resource Name (ARN) of the knowledge base. (pattern: <code>arn:[a-z0-9-.]{1,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[^/].{0,1023}</code>)
knowledge_base_id	string	The unique identifier for the knowledge base. (pattern: <code>[0-9a-zA-Z-_=.+]+</code>)
permissions	array	The resource permissions for the knowledge base.
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_knowledge_base_permissions	select	aws_account_id, knowledge_base_id, region		Describes the resource permissions for a knowledge base.
update_knowledge_base_permissions	update	aws_account_id, knowledge_base_id, region		Updates the resource permissions for a knowledge base.

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 knowledge base.
knowledge_base_id	string	The unique identifier for the knowledge base.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_knowledge_base_permissions

Describes the resource permissions for a knowledge base.

SELECT
knowledge_base_arn,
knowledge_base_id,
permissions,
request_id,
status
FROM aws.quicksight.knowledge_base_permissions
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND knowledge_base_id = '{{ knowledge_base_id }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_knowledge_base_permissions

Updates the resource permissions for a knowledge base.

UPDATE aws.quicksight.knowledge_base_permissions
SET 
GrantPermissions = '{{ GrantPermissions }}',
RevokePermissions = '{{ RevokePermissions }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND knowledge_base_id = '{{ knowledge_base_id }}' --required
AND region = '{{ region }}' --required
RETURNING
knowledge_base_arn,
knowledge_base_id,
permissions,
request_id,
status;