role_custom_permissions

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

Overview

Name	role_custom_permissions
Type	Resource
Id	aws.quicksight.role_custom_permissions

Fields

The following fields are returned by SELECT queries:

describe_role_custom_permission

Name	Datatype	Description
custom_permissions_name	string	The name of the custom permission that is described. (pattern: <code>^[a-zA-Z0-9+=,.@_-]+$</code>)
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_role_custom_permission	select	role, aws_account_id, namespace, region		Describes all custom permissions that are mapped to a role.
update_role_custom_permission	update	role, aws_account_id, namespace, region, CustomPermissionsName		Updates the custom permissions that are associated with a role.
delete_role_custom_permission	delete	role, aws_account_id, namespace, region		Removes custom permissions from the role.

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 for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.
namespace	string	The namespace that includes the role.
region	string	AWS region (default: us-east-1)
role	string	The role that you want to remove permissions from.

SELECT examples

describe_role_custom_permission

Describes all custom permissions that are mapped to a role.

SELECT
custom_permissions_name,
request_id,
status
FROM aws.quicksight.role_custom_permissions
WHERE role = '{{ role }}' -- required
AND aws_account_id = '{{ aws_account_id }}' -- required
AND namespace = '{{ namespace }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_role_custom_permission

Updates the custom permissions that are associated with a role.

UPDATE aws.quicksight.role_custom_permissions
SET 
CustomPermissionsName = '{{ CustomPermissionsName }}'
WHERE 
role = '{{ role }}' --required
AND aws_account_id = '{{ aws_account_id }}' --required
AND namespace = '{{ namespace }}' --required
AND region = '{{ region }}' --required
AND CustomPermissionsName = '{{ CustomPermissionsName }}' --required
RETURNING
request_id,
status;

DELETE examples

delete_role_custom_permission

Removes custom permissions from the role.

DELETE FROM aws.quicksight.role_custom_permissions
WHERE role = '{{ role }}' --required
AND aws_account_id = '{{ aws_account_id }}' --required
AND namespace = '{{ namespace }}' --required
AND region = '{{ region }}' --required
;