LakeFormation / Client / get_rls_policy

get_rls_policy

LakeFormation.Client.get_rls_policy(**kwargs)

Returns the definition of a row-level security policy, including its attachment columns and filter expression.

See also: AWS API Documentation

Request Syntax

response = client.get_rls_policy(
    Name='string'
)
Parameters:

Name (string) –

[REQUIRED]

The name of the row-level security policy to retrieve.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • RLSPolicy (dict) –

      An RLSPolicy structure containing the definition of the requested row-level security policy.

      • 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.

Exceptions