LakeFormation / Paginator / ListRLSPolicyAttachments

ListRLSPolicyAttachments¶

class LakeFormation.Paginator.ListRLSPolicyAttachments¶

paginator = client.get_paginator('list_rls_policy_attachments')

paginate(**kwargs)¶

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

Request Syntax

response_iterator = paginator.paginate(
    Resource={
        'Catalog': {
            'Id': 'string'
        },
        'Database': {
            'CatalogId': 'string',
            'Name': 'string'
        },
        'Table': {
            'CatalogId': 'string',
            'DatabaseName': 'string',
            'Name': 'string',
            'TableWildcard': {}

        },
        'TableWithColumns': {
            'CatalogId': 'string',
            'DatabaseName': 'string',
            'Name': 'string',
            'ColumnNames': [
                'string',
            ],
            'ColumnWildcard': {
                'ExcludedColumnNames': [
                    'string',
                ]
            }
        },
        'DataLocation': {
            'CatalogId': 'string',
            'ResourceArn': 'string'
        },
        'DataCellsFilter': {
            'TableCatalogId': 'string',
            'DatabaseName': 'string',
            'TableName': 'string',
            'Name': 'string'
        },
        'LFTag': {
            'CatalogId': 'string',
            'TagKey': 'string',
            'TagValues': [
                'string',
            ]
        },
        'LFTagPolicy': {
            'CatalogId': 'string',
            'ResourceType': 'DATABASE'|'TABLE',
            'Expression': [
                {
                    'TagKey': 'string',
                    'TagValues': [
                        'string',
                    ]
                },
            ],
            'ExpressionName': 'string'
        },
        'LFTagExpression': {
            'CatalogId': 'string',
            'Name': 'string'
        },
        'RLSPolicy': {
            'CatalogId': 'string',
            'Name': 'string'
        }
    },
    Principal={
        'DataLakePrincipalIdentifier': 'string'
    },
    PolicyName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

Resource (dict) –
If specified, returns only the attachments for the given resource.
- Catalog (dict) –
  
  The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
  - Id (string) –
    
    An identifier for the catalog resource.
- Database (dict) –
  
  The database for the resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database permissions to a principal.
  - CatalogId (string) –
    
    The identifier for the Data Catalog. By default, it is the account ID of the caller.
  - Name (string) – [REQUIRED]
    
    The name of the database resource. Unique to the Data Catalog.
- Table (dict) –
  
  The table for the resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.
  - CatalogId (string) –
    
    The identifier for the Data Catalog. By default, it is the account ID of the caller.
  - DatabaseName (string) – [REQUIRED]
    
    The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.
  - Name (string) –
    
    The name of the table.
  - TableWildcard (dict) –
    
    A wildcard object representing every table under a database.
    
    At least one of TableResource$Name or TableResource$TableWildcard is required.
- TableWithColumns (dict) –
  
  The table with columns for the resource. A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3.
  - CatalogId (string) –
    
    The identifier for the Data Catalog. By default, it is the account ID of the caller.
  - DatabaseName (string) – [REQUIRED]
    
    The name of the database for the table with columns resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.
  - Name (string) – [REQUIRED]
    
    The name of the table resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.
  - ColumnNames (list) –
    
    The list of column names for the table. At least one of ColumnNames or ColumnWildcard is required.
    - (string) –
  - ColumnWildcard (dict) –
    
    A wildcard specified by a ColumnWildcard object. At least one of ColumnNames or ColumnWildcard is required.
    - ExcludedColumnNames (list) –
      
      Excludes column names. Any column with this name will be excluded.
      - (string) –
- DataLocation (dict) –
  
  The location of an Amazon S3 path where permissions are granted or revoked.
  - CatalogId (string) –
    
    The identifier for the Data Catalog where the location is registered with Lake Formation. By default, it is the account ID of the caller.
  - ResourceArn (string) – [REQUIRED]
    
    The Amazon Resource Name (ARN) that uniquely identifies the data location resource.
- DataCellsFilter (dict) –
  
  A data cell filter.
  - TableCatalogId (string) –
    
    The ID of the catalog to which the table belongs.
  - DatabaseName (string) –
    
    A database in the Glue Data Catalog.
  - TableName (string) –
    
    The name of the table.
  - Name (string) –
    
    The name of the data cells filter.
- LFTag (dict) –
  
  The LF-Tag key and values attached to a resource.
  - CatalogId (string) –
    
    The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
  - TagKey (string) – [REQUIRED]
    
    The key-name for the LF-tag.
  - TagValues (list) – [REQUIRED]
    
    A list of possible values an attribute can take.
    - (string) –
- LFTagPolicy (dict) –
  
  A list of LF-tag conditions or saved LF-Tag expressions that define a resource’s LF-tag policy.
  - CatalogId (string) –
    
    The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
  - ResourceType (string) – [REQUIRED]
    
    The resource type for which the LF-tag policy applies.
  - Expression (list) –
    
    A list of LF-tag conditions or a saved expression that apply to the resource’s LF-tag policy.
    - (dict) –
      
      A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns that do not have the LF-tag ‘PII’ in tables that have the LF-tag ‘Prod’.
      - TagKey (string) – [REQUIRED]
        
        The key-name for the LF-tag.
      - TagValues (list) – [REQUIRED]
        
        A list of possible values an attribute can take.
        
        The maximum number of values that can be defined for a LF-Tag is 1000. A single API call supports 50 values. You can use multiple API calls to add more values.
        
        (string) –
  - ExpressionName (string) –
    
    If provided, permissions are granted to the Data Catalog resources whose assigned LF-Tags match the expression body of the saved expression under the provided ExpressionName.
- LFTagExpression (dict) –
  
  LF-Tag expression resource. A logical expression composed of one or more LF-Tag key:value pairs.
  - CatalogId (string) –
    
    The identifier for the Data Catalog. By default, the account ID.
  - Name (string) – [REQUIRED]
    
    The name of the LF-Tag expression to grant permissions on.
- RLSPolicy (dict) –
  
  A row-level security policy resource. Specify this when granting or revoking permissions on a row-level security policy.
  - CatalogId (string) –
    
    The identifier for the Data Catalog that contains the policy. By default, the account ID.
  - Name (string) – [REQUIRED]
    
    The name of the row-level security policy.
Principal (dict) –
If specified, returns only the attachments for the given principal.
- DataLakePrincipalIdentifier (string) –
  
  An identifier for the Lake Formation principal.
PolicyName (string) – If specified, returns only the attachments for the row-level security policy with this name.
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

{
    'RLSPolicyAttachments': [
        {
            'CatalogId': 'string',
            'PolicyName': 'string',
            'Principal': {
                'DataLakePrincipalIdentifier': 'string'
            },
            'Resource': {
                'Catalog': {
                    'Id': 'string'
                },
                'Database': {
                    'CatalogId': 'string',
                    'Name': 'string'
                },
                'Table': {
                    'CatalogId': 'string',
                    'DatabaseName': 'string',
                    'Name': 'string',
                    'TableWildcard': {}
                },
                'TableWithColumns': {
                    'CatalogId': 'string',
                    'DatabaseName': 'string',
                    'Name': 'string',
                    'ColumnNames': [
                        'string',
                    ],
                    'ColumnWildcard': {
                        'ExcludedColumnNames': [
                            'string',
                        ]
                    }
                },
                'DataLocation': {
                    'CatalogId': 'string',
                    'ResourceArn': 'string'
                },
                'DataCellsFilter': {
                    'TableCatalogId': 'string',
                    'DatabaseName': 'string',
                    'TableName': 'string',
                    'Name': 'string'
                },
                'LFTag': {
                    'CatalogId': 'string',
                    'TagKey': 'string',
                    'TagValues': [
                        'string',
                    ]
                },
                'LFTagPolicy': {
                    'CatalogId': 'string',
                    'ResourceType': 'DATABASE'|'TABLE',
                    'Expression': [
                        {
                            'TagKey': 'string',
                            'TagValues': [
                                'string',
                            ]
                        },
                    ],
                    'ExpressionName': 'string'
                },
                'LFTagExpression': {
                    'CatalogId': 'string',
                    'Name': 'string'
                },
                'RLSPolicy': {
                    'CatalogId': 'string',
                    'Name': 'string'
                }
            },
            'Condition': {
                'Expression': 'string'
            },
            'DefaultRLSPolicy': True|False
        },
    ],

}

Response Structure

(dict) –
- RLSPolicyAttachments (list) –
  
  A list of RLSPolicyAttachment structures.
  - (dict) –
    
    A structure that describes the attachment of a row-level security policy to a resource for a principal.
    - CatalogId (string) –
      
      The identifier for the Data Catalog that contains the attachment. By default, the account ID.
    - PolicyName (string) –
      
      The name of the attached row-level security policy.
    - Principal (dict) –
      
      The principal to which the attached policy applies.
      - DataLakePrincipalIdentifier (string) –
        
        An identifier for the Lake Formation principal.
    - Resource (dict) –
      
      The resource to which the policy is attached.
      - Catalog (dict) –
        
        The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
        
        Id (string) –
        
        An identifier for the catalog resource.
      - Database (dict) –
        
        The database for the resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database permissions to a principal.
        
        CatalogId (string) –
        
        The identifier for the Data Catalog. By default, it is the account ID of the caller.
        
        Name (string) –
        
        The name of the database resource. Unique to the Data Catalog.
      - Table (dict) –
        
        The table for the resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.
        
        CatalogId (string) –
        
        The identifier for the Data Catalog. By default, it is the account ID of the caller.
        
        DatabaseName (string) –
        
        The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.
        
        Name (string) –
        
        The name of the table.
        
        TableWildcard (dict) –
        
        A wildcard object representing every table under a database.
        
        At least one of TableResource$Name or TableResource$TableWildcard is required.
      - TableWithColumns (dict) –
        
        The table with columns for the resource. A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3.
        
        CatalogId (string) –
        
        The identifier for the Data Catalog. By default, it is the account ID of the caller.
        
        DatabaseName (string) –
        
        The name of the database for the table with columns resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.
        
        Name (string) –
        
        The name of the table resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.
        
        ColumnNames (list) –
        
        The list of column names for the table. At least one of ColumnNames or ColumnWildcard is required.
        
        (string) –
        
        ColumnWildcard (dict) –
        
        A wildcard specified by a ColumnWildcard object. At least one of ColumnNames or ColumnWildcard is required.
        
        ExcludedColumnNames (list) –
        
        Excludes column names. Any column with this name will be excluded.
        
        (string) –
      - DataLocation (dict) –
        
        The location of an Amazon S3 path where permissions are granted or revoked.
        
        CatalogId (string) –
        
        The identifier for the Data Catalog where the location is registered with Lake Formation. By default, it is the account ID of the caller.
        
        ResourceArn (string) –
        
        The Amazon Resource Name (ARN) that uniquely identifies the data location resource.
      - DataCellsFilter (dict) –
        
        A data cell filter.
        
        TableCatalogId (string) –
        
        The ID of the catalog to which the table belongs.
        
        DatabaseName (string) –
        
        A database in the Glue Data Catalog.
        
        TableName (string) –
        
        The name of the table.
        
        Name (string) –
        
        The name of the data cells filter.
      - LFTag (dict) –
        
        The LF-Tag key and values attached to a resource.
        
        CatalogId (string) –
        
        The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
        
        TagKey (string) –
        
        The key-name for the LF-tag.
        
        TagValues (list) –
        
        A list of possible values an attribute can take.
        
        (string) –
      - LFTagPolicy (dict) –
        
        A list of LF-tag conditions or saved LF-Tag expressions that define a resource’s LF-tag policy.
        
        CatalogId (string) –
        
        The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.
        
        ResourceType (string) –
        
        The resource type for which the LF-tag policy applies.
        
        Expression (list) –
        
        A list of LF-tag conditions or a saved expression that apply to the resource’s LF-tag policy.
        
        (dict) –
        
        A structure that allows an admin to grant user permissions on certain conditions. For example, granting a role access to all columns that do not have the LF-tag ‘PII’ in tables that have the LF-tag ‘Prod’.
        
        TagKey (string) –
        
        The key-name for the LF-tag.
        
        TagValues (list) –
        
        A list of possible values an attribute can take.
        
        The maximum number of values that can be defined for a LF-Tag is 1000. A single API call supports 50 values. You can use multiple API calls to add more values.
        
        (string) –
        
        ExpressionName (string) –
        
        If provided, permissions are granted to the Data Catalog resources whose assigned LF-Tags match the expression body of the saved expression under the provided ExpressionName.
      - LFTagExpression (dict) –
        
        LF-Tag expression resource. A logical expression composed of one or more LF-Tag key:value pairs.
        
        CatalogId (string) –
        
        The identifier for the Data Catalog. By default, the account ID.
        
        Name (string) –
        
        The name of the LF-Tag expression to grant permissions on.
      - RLSPolicy (dict) –
        
        A row-level security policy resource. Specify this when granting or revoking permissions on a 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.
    - Condition (dict) –
      
      A Lake Formation condition, which applies to the row-level security policy attachment and contains an expression.
      - Expression (string) –
        
        An expression written based on the Cedar Policy Language used to match the principal attributes.
    - DefaultRLSPolicy (boolean) –
      
      Indicates whether this attachment is the default row-level security policy for the resource.