/AWS1/CL_QSTROWLEVELPERMDS¶
Information about a dataset that contains permissions for row-level security (RLS). The permissions dataset maps fields to users or groups. For more information, see Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Amazon QuickSight User Guide.
The option to deny permissions by setting PermissionPolicy
to DENY_ACCESS
is
not supported for new RLS datasets.
CONSTRUCTOR
¶
IMPORTING¶
Required arguments:¶
IV_ARN
TYPE /AWS1/QSTARN
/AWS1/QSTARN
¶
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
IV_PERMISSIONPOLICY
TYPE /AWS1/QSTROWLEVELPERMPOLICY
/AWS1/QSTROWLEVELPERMPOLICY
¶
The type of permissions to use when interpreting the permissions for RLS.
DENY_ACCESS
is included for backward compatibility only.
Optional arguments:¶
IV_NAMESPACE
TYPE /AWS1/QSTNAMESPACE
/AWS1/QSTNAMESPACE
¶
The namespace associated with the dataset that contains permissions for RLS.
IV_FORMATVERSION
TYPE /AWS1/QSTROWLEVELPERMFORMATVRS
/AWS1/QSTROWLEVELPERMFORMATVRS
¶
The user or group rules associated with the dataset that contains permissions for RLS.
By default,
FormatVersion
isVERSION_1
. WhenFormatVersion
isVERSION_1
,UserName
andGroupName
are required. WhenFormatVersion
isVERSION_2
,UserARN
andGroupARN
are required, andNamespace
must not exist.
IV_STATUS
TYPE /AWS1/QSTSTATUS
/AWS1/QSTSTATUS
¶
The status of the row-level security permission dataset. If enabled, the status is
ENABLED
. If disabled, the status isDISABLED
.
Queryable Attributes¶
Namespace¶
The namespace associated with the dataset that contains permissions for RLS.
Accessible with the following methods¶
Method | Description |
---|---|
GET_NAMESPACE() |
Getter for NAMESPACE, with configurable default |
ASK_NAMESPACE() |
Getter for NAMESPACE w/ exceptions if field has no value |
HAS_NAMESPACE() |
Determine if NAMESPACE has a value |
Arn¶
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
Accessible with the following methods¶
Method | Description |
---|---|
GET_ARN() |
Getter for ARN, with configurable default |
ASK_ARN() |
Getter for ARN w/ exceptions if field has no value |
HAS_ARN() |
Determine if ARN has a value |
PermissionPolicy¶
The type of permissions to use when interpreting the permissions for RLS.
DENY_ACCESS
is included for backward compatibility only.
Accessible with the following methods¶
Method | Description |
---|---|
GET_PERMISSIONPOLICY() |
Getter for PERMISSIONPOLICY, with configurable default |
ASK_PERMISSIONPOLICY() |
Getter for PERMISSIONPOLICY w/ exceptions if field has no va |
HAS_PERMISSIONPOLICY() |
Determine if PERMISSIONPOLICY has a value |
FormatVersion¶
The user or group rules associated with the dataset that contains permissions for RLS.
By default,
FormatVersion
isVERSION_1
. WhenFormatVersion
isVERSION_1
,UserName
andGroupName
are required. WhenFormatVersion
isVERSION_2
,UserARN
andGroupARN
are required, andNamespace
must not exist.
Accessible with the following methods¶
Method | Description |
---|---|
GET_FORMATVERSION() |
Getter for FORMATVERSION, with configurable default |
ASK_FORMATVERSION() |
Getter for FORMATVERSION w/ exceptions if field has no value |
HAS_FORMATVERSION() |
Determine if FORMATVERSION has a value |
Status¶
The status of the row-level security permission dataset. If enabled, the status is
ENABLED
. If disabled, the status isDISABLED
.
Accessible with the following methods¶
Method | Description |
---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |