LakeFormation / Paginator / ListRLSPolicies

ListRLSPolicies

class LakeFormation.Paginator.ListRLSPolicies

paginator = client.get_paginator('list_rls_policies')

paginate(**kwargs)

Creates an iterator that will paginate through responses from LakeFormation.Client.list_rls_policies().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

• MaxItems (integer) –

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• PageSize (integer) –

  The size of each page.

• StartingToken (string) –

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'RLSPolicies': [
        {
            'CatalogId': 'string',
            'Name': 'string',
            'AttachmentColumns': [
                {
                    'Name': 'string',
                    'Type': 'string'
                },
            ],
            'FilterExpression': '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.