RowLevelPermissionDataSet -

RowLevelPermissionDataSet

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.

Contents

Note

In the following list, the required parameters are described first.

Arn

The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

Type: String

Required: Yes

PermissionPolicy

The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.

Type: String

Valid Values: GRANT_ACCESS | DENY_ACCESS

Required: Yes

FormatVersion

The user or group rules associated with the dataset that contains permissions for RLS.

By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.

Type: String

Valid Values: VERSION_1 | VERSION_2

Required: No

Namespace

The namespace associated with the dataset that contains permissions for RLS.

Type: String

Length Constraints: Maximum length of 64.

Pattern: ^[a-zA-Z0-9._-]*$

Required: No

Status

The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: