theme_permissions

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

Overview

Name	theme_permissions
Type	Resource
Id	aws.quicksight.theme_permissions

Fields

The following fields are returned by SELECT queries:

describe_theme_permissions

Name	Datatype	Description
permissions	array	A list of resource permissions set on the theme.
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of the request.
theme_arn	string	The Amazon Resource Name (ARN) of the theme.
theme_id	string	The ID for the theme. (pattern: <code>[\w-]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_theme_permissions	select	aws_account_id, theme_id, region		Describes the read and write permissions for a theme.
update_theme_permissions	update	aws_account_id, theme_id, region		Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example "quicksight:DescribeTheme". Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions: User "quicksight:DescribeTheme" "quicksight:DescribeThemeAlias" "quicksight:ListThemeAliases" "quicksight:ListThemeVersions" Owner "quicksight:DescribeTheme" "quicksight:DescribeThemeAlias" "quicksight:ListThemeAliases" "quicksight:ListThemeVersions" "quicksight:DeleteTheme" "quicksight:UpdateTheme" "quicksight:CreateThemeAlias" "quicksight:DeleteThemeAlias" "quicksight:UpdateThemeAlias" "quicksight:UpdateThemePermissions" "quicksight:DescribeThemePermissions" To specify no permissions, omit the permissions list.

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 theme.
region	string	AWS region (default: us-east-1)
theme_id	string	The ID for the theme.

SELECT examples

describe_theme_permissions

Describes the read and write permissions for a theme.

SELECT
permissions,
request_id,
status,
theme_arn,
theme_id
FROM aws.quicksight.theme_permissions
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND theme_id = '{{ theme_id }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_theme_permissions

Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example "quicksight:DescribeTheme". Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions: User "quicksight:DescribeTheme" "quicksight:DescribeThemeAlias" "quicksight:ListThemeAliases" "quicksight:ListThemeVersions" Owner "quicksight:DescribeTheme" "quicksight:DescribeThemeAlias" "quicksight:ListThemeAliases" "quicksight:ListThemeVersions" "quicksight:DeleteTheme" "quicksight:UpdateTheme" "quicksight:CreateThemeAlias" "quicksight:DeleteThemeAlias" "quicksight:UpdateThemeAlias" "quicksight:UpdateThemePermissions" "quicksight:DescribeThemePermissions" To specify no permissions, omit the permissions list.

UPDATE aws.quicksight.theme_permissions
SET 
GrantPermissions = '{{ GrantPermissions }}',
RevokePermissions = '{{ RevokePermissions }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND theme_id = '{{ theme_id }}' --required
AND region = '{{ region }}' --required
RETURNING
permissions,
request_id,
status,
theme_arn,
theme_id;