account_custom_permissions

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

Overview

Name	account_custom_permissions
Type	Resource
Id	aws.quicksight.account_custom_permissions

Fields

The following fields are returned by SELECT queries:

describe_account_custom_permission

Name	Datatype	Description
custom_permissions_name	string	The name of the custom permissions profile. (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_account_custom_permission	select	aws_account_id, region		Describes the custom permissions profile that is applied to an account.
update_account_custom_permission	update	aws_account_id, region, CustomPermissionsName		Applies a custom permissions profile to an account.
delete_account_custom_permission	delete	aws_account_id, region		Unapplies a custom permissions profile from an account.

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 from which you want to unapply the custom permissions profile.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_account_custom_permission

Describes the custom permissions profile that is applied to an account.

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

UPDATE examples

update_account_custom_permission

Applies a custom permissions profile to an account.

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

DELETE examples

delete_account_custom_permission

Unapplies a custom permissions profile from an account.

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