Skip to main content

custom_permissions

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

Overview

Namecustom_permissions
TypeResource
Idaws.quicksight.custom_permissions

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
custom_permissionsobjectThe custom permissions profile.
request_idstringThe Amazon Web Services request ID for this operation.
statusintegerThe HTTP status of the request.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_custom_permissionsselectaws_account_id, custom_permissions_name, regionDescribes a custom permissions profile.
list_custom_permissionsselectaws_account_id, regionmax-results, next-tokenReturns a list of all the custom permissions profiles.
create_custom_permissionsinsertaws_account_id, region, CustomPermissionsNameCreates a custom permissions profile.
update_user_custom_permissionupdateuser_name, aws_account_id, namespace, region, CustomPermissionsNameUpdates a custom permissions profile for a user.
update_custom_permissionsupdateaws_account_id, custom_permissions_name, regionUpdates a custom permissions profile.
delete_user_custom_permissiondeleteuser_name, aws_account_id, namespace, regionDeletes a custom permissions profile from a user.
delete_custom_permissionsdeleteaws_account_id, custom_permissions_name, regionDeletes a custom permissions profile.

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.

NameDatatypeDescription
aws_account_idstringThe ID of the Amazon Web Services account that contains the custom permissions profile that you want to delete.
custom_permissions_namestringThe name of the custom permissions profile that you want to delete.
namespacestringThe namespace that the user belongs to.
regionstringAWS region (default: us-east-1)
user_namestringThe username of the user that you want to remove custom permissions from.
max-resultsintegerThe maximum number of results to return.
next-tokenstringThe token for the next set of results, or null if there are no more results.

SELECT examples

Describes a custom permissions profile.

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

INSERT examples

Creates a custom permissions profile.

INSERT INTO aws.quicksight.custom_permissions (
CustomPermissionsName,
Capabilities,
Governance,
Tags,
aws_account_id,
region
)
SELECT
'{{ CustomPermissionsName }}' /* required */,
'{{ Capabilities }}',
'{{ Governance }}',
'{{ Tags }}',
'{{ aws_account_id }}',
'{{ region }}'
RETURNING
arn,
request_id,
status
;

UPDATE examples

Updates a custom permissions profile for a user.

UPDATE aws.quicksight.custom_permissions
SET
CustomPermissionsName = '{{ CustomPermissionsName }}'
WHERE
user_name = '{{ user_name }}' --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

Deletes a custom permissions profile from a user.

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