LakeFormation / Client / list_rls_policies

list_rls_policies

LakeFormation.Client.list_rls_policies(**kwargs)

Lists the row-level security policies in the Data Catalog.

See also: AWS API Documentation

Request Syntax

response = client.list_rls_policies(
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • MaxResults (integer) – The maximum number of row-level security policies to return in a single response.

  • NextToken (string) – A continuation token, if this is a continuation call.

Return type:

dict

Returns:

Response Syntax

{
    'RLSPolicies': [
        {
            'CatalogId': 'string',
            'Name': 'string',
            'AttachmentColumns': [
                {
                    'Name': 'string',
                    'Type': 'string'
                },
            ],
            'FilterExpression': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • RLSPolicies (list) –

      A list of RLSPolicy structures.

      • (dict) –

        A structure that describes a row-level security policy, including the columns its filter expression references and the filter expression itself.

        • CatalogId (string) –

          The identifier for the Data Catalog that contains the policy. By default, the account ID.

        • Name (string) –

          The name of the row-level security policy.

        • AttachmentColumns (list) –

          The list of columns that the filter expression references.

          • (dict) –

            A column in a table that a row-level security policy’s filter expression can reference.

            • Name (string) –

              The name of the column.

            • Type (string) –

              The data type of the column.

        • FilterExpression (string) –

          The filter predicate, written in a SQL-like syntax, that determines which rows are returned to the principal.

    • NextToken (string) –

      A continuation token, if not all row-level security policies have been returned.

Exceptions