AWS API Changes

2026/10/13 - AWS Lake Formation - 8 new 12 updated api methods

Changes Added new LakeFormation APIs and documentation updates for Simple Row-level Security (RLS).

DetachRLSPolicy (new)

Detaches a row-level security policy from a resource for a principal. After the policy is detached, its filter expression is no longer applied to the principal's queries on that resource.

See also: AWS API Documentation

Request Syntax

client.detach_rls_policy(
    Name='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'
        }
    },
    Principal={
        'DataLakePrincipalIdentifier': 'string'
    },
    Condition={
        'Expression': 'string'
    },
    RemoveDefault=True|False
)

type Name:

string

param Name:

[REQUIRED]

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

type Resource:

dict

param Resource:

[REQUIRED]

The resource from which the row-level security policy is detached.

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.

type Principal:

dict

param Principal:

The principal for which the row-level security policy is detached.

DataLakePrincipalIdentifier (string) --

An identifier for the Lake Formation principal.

type Condition:

dict

param Condition:

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.

type RemoveDefault:

boolean

param RemoveDefault:

Indicates whether to remove this policy as the default row-level security policy for the resource.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

CreateRLSPolicy (new)

Link ¶

Creates a row-level security (RLS) policy. A row-level security policy defines a filter expression that Lake Formation evaluates to determine which rows of a table a principal is allowed to see. The policy is created independently of any resource, and is later associated with a resource and principal using AttachRLSPolicy.

See also: AWS API Documentation

Request Syntax

client.create_rls_policy(
    Name='string',
    AttachmentColumns=[
        {
            'Name': 'string',
            'Type': 'string'
        },
    ],
    FilterExpression='string'
)

type Name:

string

param Name:

[REQUIRED]

A unique name for the row-level security policy within the Data Catalog.

type AttachmentColumns:

list

param AttachmentColumns:

[REQUIRED]

The list of columns that the filter expression references. These columns define the shape of the data that the policy can be attached to.

(dict) --

A column in a table that a row-level security policy's filter expression can reference.
- Name (string) -- [REQUIRED]
  
  The name of the column.
- Type (string) --
  
  The data type of the column.

type FilterExpression:

string

param FilterExpression:

[REQUIRED]

A filter predicate, written in a SQL-like syntax, that Lake Formation evaluates against each row. Only the rows for which the expression evaluates to true are returned to the principal.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

UpdateRLSPolicy (new)

Link ¶

Updates the filter expression of an existing row-level security policy. The change applies to all attachments of the policy.

See also: AWS API Documentation

Request Syntax

client.update_rls_policy(
    Name='string',
    FilterExpression='string'
)

type Name:

string

param Name:

[REQUIRED]

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

type FilterExpression:

string

param FilterExpression:

The new filter predicate, written in a SQL-like syntax, that replaces the policy's current filter expression.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

GetRLSPolicy (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.get_rls_policy(
    Name='string'
)

type Name:

string

param Name:

[REQUIRED]

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

rtype:

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.

DeleteRLSPolicy (new)

Link ¶

Deletes a row-level security policy. Any active attachments of the policy are automatically removed as part of the deletion, so you do not need to detach the policy first.

See also: AWS API Documentation

Request Syntax

client.delete_rls_policy(
    Name='string'
)

type Name:

string

param Name:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

ListRLSPolicies (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

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

type MaxResults:

integer

param MaxResults:

The maximum number of row-level security policies to return in a single response.

type NextToken:

string

param NextToken:

A continuation token, if this is a continuation call.

rtype:

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.

AttachRLSPolicy (new)

Link ¶

Attaches a row-level security policy to a resource for a principal. When the principal queries the resource, Lake Formation applies the policy's filter expression so that only the permitted rows are returned.

See also: AWS API Documentation

Request Syntax

client.attach_rls_policy(
    Name='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'
        }
    },
    Principal={
        'DataLakePrincipalIdentifier': 'string'
    },
    Condition={
        'Expression': 'string'
    },
    SetDefault=True|False
)

type Name:

string

param Name:

[REQUIRED]

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

type Resource:

dict

param Resource:

[REQUIRED]

The resource to which the row-level security 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) -- [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.

type Principal:

dict

param Principal:

The principal to which the row-level security policy applies.

DataLakePrincipalIdentifier (string) --

An identifier for the Lake Formation principal.

type Condition:

dict

param Condition:

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.

type SetDefault:

boolean

param SetDefault:

Indicates whether this policy becomes the default row-level security policy for the resource. The default policy applies to all principals by default.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

ListRLSPolicyAttachments (new)

Link ¶

Lists the row-level security policy attachments in the Data Catalog. You can filter the results by resource, principal, or policy name.

See also: AWS API Documentation

Request Syntax

client.list_rls_policy_attachments(
    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',
    MaxResults=123,
    NextToken='string'
)

type Resource:

dict

param Resource:

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.

type Principal:

dict

param Principal:

If specified, returns only the attachments for the given principal.

DataLakePrincipalIdentifier (string) --

An identifier for the Lake Formation principal.

type PolicyName:

string

param PolicyName:

If specified, returns only the attachments for the row-level security policy with this name.

type MaxResults:

integer

param MaxResults:

The maximum number of attachments to return in a single response.

type NextToken:

string

param NextToken:

A continuation token, if this is a continuation call.

rtype:

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
        },
    ],
    'NextToken': 'string'
}

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.
- NextToken (string) --
  
  A continuation token, if not all attachments have been returned.

AddLFTagsToResource (updated)

Link ¶
Changes (request)

{'Resource': {'RLSPolicy': {'CatalogId': 'string', 'Name': 'string'}}}

Attaches one or more LF-tags to an existing resource.

See also: AWS API Documentation

Request Syntax

client.add_lf_tags_to_resource(
    CatalogId='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'
        }
    },
    LFTags=[
        {
            'CatalogId': 'string',
            'TagKey': 'string',
            'TagValues': [
                'string',
            ]
        },
    ]
)

type CatalogId:

string

param CatalogId:

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.

type Resource:

dict

param Resource:

[REQUIRED]

The database, table, or column resource to which to attach an LF-tag.

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.

type LFTags:

list

param LFTags:

[REQUIRED]

The LF-tags to attach to the resource.

(dict) --

A structure containing an LF-tag key-value pair.
- 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) --

rtype:

dict

returns:

Response Syntax

{
    'Failures': [
        {
            'LFTag': {
                'CatalogId': 'string',
                'TagKey': 'string',
                'TagValues': [
                    'string',
                ]
            },
            'Error': {
                'ErrorCode': 'string',
                'ErrorMessage': 'string'
            }
        },
    ]
}

Response Structure

(dict) --
- Failures (list) --
  
  A list of failures to tag the resource.
  - (dict) --
    
    A structure containing an error related to a TagResource or UnTagResource operation.
    - LFTag (dict) --
      
      The key-name of the LF-tag.
      - 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) --
    - Error (dict) --
      
      An error that occurred with the attachment or detachment of the LF-tag.
      - ErrorCode (string) --
        
        The code associated with this error.
      - ErrorMessage (string) --
        
        A message describing the error.

BatchGrantPermissions (updated)

Link ¶
Changes (request, response)
Request

{'Entries': {'Resource': {'RLSPolicy': {'CatalogId': 'string',
                                        'Name': 'string'}}}}

Response

{'Failures': {'RequestEntry': {'Resource': {'RLSPolicy': {'CatalogId': 'string',
                                                          'Name': 'string'}}}}}

Batch operation to grant permissions to the principal.

See also: AWS API Documentation

Request Syntax

client.batch_grant_permissions(
    CatalogId='string',
    Entries=[
        {
            'Id': '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'
                }
            },
            'Permissions': [
                'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_LF_TAG'|'ASSOCIATE'|'GRANT_WITH_LF_TAG_EXPRESSION'|'CREATE_LF_TAG_EXPRESSION'|'CREATE_CATALOG'|'SUPER_USER',
            ],
            'Condition': {
                'Expression': 'string'
            },
            'PermissionsWithGrantOption': [
                'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_LF_TAG'|'ASSOCIATE'|'GRANT_WITH_LF_TAG_EXPRESSION'|'CREATE_LF_TAG_EXPRESSION'|'CREATE_CATALOG'|'SUPER_USER',
            ]
        },
    ]
)

type CatalogId:

string

param CatalogId:

type Entries:

list

param Entries:

[REQUIRED]

A list of up to 20 entries for resource permissions to be granted by batch operation to the principal.

(dict) --

A permission to a resource granted by batch operation to the principal.
- Id (string) -- [REQUIRED]
  
  A unique identifier for the batch permissions request entry.
- Principal (dict) --
  
  The principal to be granted a permission.
  - DataLakePrincipalIdentifier (string) --
    
    An identifier for the Lake Formation principal.
- Resource (dict) --
  
  The resource to which the principal is to be granted a permission.
  - 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.
- Permissions (list) --
  
  The permissions to be granted.
  - (string) --
- Condition (dict) --
  
  A Lake Formation condition, which applies to permissions and opt-ins that contain an expression.
  - Expression (string) --
    
    An expression written based on the Cedar Policy Language used to match the principal attributes.
- PermissionsWithGrantOption (list) --
  
  Indicates if the option to pass permissions is granted.
  - (string) --

rtype:

dict

returns:

Response Syntax

{
    'Failures': [
        {
            'RequestEntry': {
                'Id': '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'
                    }
                },
                'Permissions': [
                    'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_LF_TAG'|'ASSOCIATE'|'GRANT_WITH_LF_TAG_EXPRESSION'|'CREATE_LF_TAG_EXPRESSION'|'CREATE_CATALOG'|'SUPER_USER',
                ],
                'Condition': {
                    'Expression': 'string'
                },
                'PermissionsWithGrantOption': [
                    'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_LF_TAG'|'ASSOCIATE'|'GRANT_WITH_LF_TAG_EXPRESSION'|'CREATE_LF_TAG_EXPRESSION'|'CREATE_CATALOG'|'SUPER_USER',
                ]
            },
            'Error': {
                'ErrorCode': 'string',
                'ErrorMessage': 'string'
            }
        },
    ]
}

Response Structure

(dict) --
- Failures (list) --
  
  A list of failures to grant permissions to the resources.
  - (dict) --
    
    A list of failures when performing a batch grant or batch revoke operation.
    - RequestEntry (dict) --
      
      An identifier for an entry of the batch request.
      - Id (string) --
        
        A unique identifier for the batch permissions request entry.
      - Principal (dict) --
        
        The principal to be granted a permission.
        
        DataLakePrincipalIdentifier (string) --
        
        An identifier for the Lake Formation principal.
      - Resource (dict) --
        
        The resource to which the principal is to be granted a permission.
        
        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.
      - Permissions (list) --
        
        The permissions to be granted.
        
        (string) --
      - Condition (dict) --
        
        A Lake Formation condition, which applies to permissions and opt-ins that contain an expression.
        
        Expression (string) --
        
        An expression written based on the Cedar Policy Language used to match the principal attributes.
      - PermissionsWithGrantOption (list) --
        
        Indicates if the option to pass permissions is granted.
        
        (string) --
    - Error (dict) --
      
      An error message that applies to the failure of the entry.
      - ErrorCode (string) --
        
        The code associated with this error.
      - ErrorMessage (string) --
        
        A message describing the error.

BatchRevokePermissions (updated)

Link ¶
Changes (request, response)
Request

{'Entries': {'Resource': {'RLSPolicy': {'CatalogId': 'string',
                                        'Name': 'string'}}}}

Response

{'Failures': {'RequestEntry': {'Resource': {'RLSPolicy': {'CatalogId': 'string',
                                                          'Name': 'string'}}}}}

Batch operation to revoke permissions from the principal.

See also: AWS API Documentation

Request Syntax

client.batch_revoke_permissions(
    CatalogId='string',
    Entries=[
        {
            'Id': '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'
                }
            },
            'Permissions': [
                'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_LF_TAG'|'ASSOCIATE'|'GRANT_WITH_LF_TAG_EXPRESSION'|'CREATE_LF_TAG_EXPRESSION'|'CREATE_CATALOG'|'SUPER_USER',
            ],
            'Condition': {
                'Expression': 'string'
            },
            'PermissionsWithGrantOption': [
                'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_LF_TAG'|'ASSOCIATE'|'GRANT_WITH_LF_TAG_EXPRESSION'|'CREATE_LF_TAG_EXPRESSION'|'CREATE_CATALOG'|'SUPER_USER',
            ]
        },
    ]
)

type CatalogId:

string

param CatalogId:

type Entries:

list

param Entries:

[REQUIRED]

A list of up to 20 entries for resource permissions to be revoked by batch operation to the principal.

(dict) --

A permission to a resource granted by batch operation to the principal.
- Id (string) -- [REQUIRED]
  
  A unique identifier for the batch permissions request entry.
- Principal (dict) --
  
  The principal to be granted a permission.
  - DataLakePrincipalIdentifier (string) --
    
    An identifier for the Lake Formation principal.
- Resource (dict) --
  
  The resource to which the principal is to be granted a permission.
  - 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.
- Permissions (list) --
  
  The permissions to be granted.
  - (string) --
- Condition (dict) --
  
  A Lake Formation condition, which applies to permissions and opt-ins that contain an expression.
  - Expression (string) --
    
    An expression written based on the Cedar Policy Language used to match the principal attributes.
- PermissionsWithGrantOption (list) --
  
  Indicates if the option to pass permissions is granted.
  - (string) --

rtype:

dict

returns:

Response Syntax

{
    'Failures': [
        {
            'RequestEntry': {
                'Id': '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'
                    }
                },
                'Permissions': [
                    'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_LF_TAG'|'ASSOCIATE'|'GRANT_WITH_LF_TAG_EXPRESSION'|'CREATE_LF_TAG_EXPRESSION'|'CREATE_CATALOG'|'SUPER_USER',
                ],
                'Condition': {
                    'Expression': 'string'
                },
                'PermissionsWithGrantOption': [
                    'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_LF_TAG'|'ASSOCIATE'|'GRANT_WITH_LF_TAG_EXPRESSION'|'CREATE_LF_TAG_EXPRESSION'|'CREATE_CATALOG'|'SUPER_USER',
                ]
            },
            'Error': {
                'ErrorCode': 'string',
                'ErrorMessage': 'string'
            }
        },
    ]
}

Response Structure

(dict) --
- Failures (list) --
  
  A list of failures to revoke permissions to the resources.
  - (dict) --
    
    A list of failures when performing a batch grant or batch revoke operation.
    - RequestEntry (dict) --
      
      An identifier for an entry of the batch request.
      - Id (string) --
        
        A unique identifier for the batch permissions request entry.
      - Principal (dict) --
        
        The principal to be granted a permission.
        
        DataLakePrincipalIdentifier (string) --
        
        An identifier for the Lake Formation principal.
      - Resource (dict) --
        
        The resource to which the principal is to be granted a permission.
        
        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.
      - Permissions (list) --
        
        The permissions to be granted.
        
        (string) --
      - Condition (dict) --
        
        A Lake Formation condition, which applies to permissions and opt-ins that contain an expression.
        
        Expression (string) --
        
        An expression written based on the Cedar Policy Language used to match the principal attributes.
      - PermissionsWithGrantOption (list) --
        
        Indicates if the option to pass permissions is granted.
        
        (string) --
    - Error (dict) --
      
      An error message that applies to the failure of the entry.
      - ErrorCode (string) --
        
        The code associated with this error.
      - ErrorMessage (string) --
        
        A message describing the error.

CreateLakeFormationOptIn (updated)

Link ¶
Changes (request)

{'Resource': {'RLSPolicy': {'CatalogId': 'string', 'Name': 'string'}}}

Enforce Lake Formation permissions for the given databases, tables, and principals.

See also: AWS API Documentation

Request Syntax

client.create_lake_formation_opt_in(
    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'
    }
)

type Principal:

dict

param Principal:

[REQUIRED]

The Lake Formation principal. Supported principals are IAM users or IAM roles.

DataLakePrincipalIdentifier (string) --

An identifier for the Lake Formation principal.

type Resource:

dict

param Resource:

[REQUIRED]

A structure for the 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.

type Condition:

dict

param Condition:

A Lake Formation condition, which applies to permissions and opt-ins that contain an expression.

Expression (string) --

An expression written based on the Cedar Policy Language used to match the principal attributes.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

DeleteLakeFormationOptIn (updated)

Link ¶
Changes (request)

{'Resource': {'RLSPolicy': {'CatalogId': 'string', 'Name': 'string'}}}

Remove the Lake Formation permissions enforcement of the given databases, tables, and principals.

See also: AWS API Documentation

Request Syntax

client.delete_lake_formation_opt_in(
    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'
    }
)

type Principal:

dict

param Principal:

[REQUIRED]

The Lake Formation principal. Supported principals are IAM users or IAM roles.

DataLakePrincipalIdentifier (string) --

An identifier for the Lake Formation principal.

type Resource:

dict

param Resource:

[REQUIRED]

A structure for the 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.

type Condition:

dict

param Condition:

A Lake Formation condition, which applies to permissions and opt-ins that contain an expression.

Expression (string) --

An expression written based on the Cedar Policy Language used to match the principal attributes.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

GetEffectivePermissionsForPath (updated)

Link ¶
Changes (response)

{'Permissions': {'Resource': {'RLSPolicy': {'CatalogId': 'string',
                                            'Name': 'string'}}}}

Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3. GetEffectivePermissionsForPath will not return databases and tables if the catalog is encrypted.

See also: AWS API Documentation

Request Syntax

client.get_effective_permissions_for_path(
    CatalogId='string',
    ResourceArn='string',
    NextToken='string',
    MaxResults=123
)

type CatalogId:

string

param CatalogId:

type ResourceArn:

string

param ResourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the resource for which you want to get permissions.

type NextToken:

string

param NextToken:

A continuation token, if this is not the first call to retrieve this list.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return.

rtype:

dict

returns:

Response Syntax

{
    'Permissions': [
        {
            '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'
            },
            'Permissions': [
                'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_LF_TAG'|'ASSOCIATE'|'GRANT_WITH_LF_TAG_EXPRESSION'|'CREATE_LF_TAG_EXPRESSION'|'CREATE_CATALOG'|'SUPER_USER',
            ],
            'PermissionsWithGrantOption': [
                'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_LF_TAG'|'ASSOCIATE'|'GRANT_WITH_LF_TAG_EXPRESSION'|'CREATE_LF_TAG_EXPRESSION'|'CREATE_CATALOG'|'SUPER_USER',
            ],
            'AdditionalDetails': {
                'ResourceShare': [
                    'string',
                ]
            },
            'LastUpdated': datetime(2015, 1, 1),
            'LastUpdatedBy': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Permissions (list) --
  
  A list of the permissions for the specified table or database resource located at the path in Amazon S3.
  - (dict) --
    
    The permissions granted or revoked on a resource.
    - Principal (dict) --
      
      The Data Lake principal to be granted or revoked permissions.
      - DataLakePrincipalIdentifier (string) --
        
        An identifier for the Lake Formation principal.
    - Resource (dict) --
      
      The resource where permissions are to be granted or revoked.
      - 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 permissions and opt-ins that contain an expression.
      - Expression (string) --
        
        An expression written based on the Cedar Policy Language used to match the principal attributes.
    - Permissions (list) --
      
      The permissions to be granted or revoked on the resource.
      - (string) --
    - PermissionsWithGrantOption (list) --
      
      Indicates whether to grant the ability to grant permissions (as a subset of permissions granted).
      - (string) --
    - AdditionalDetails (dict) --
      
      This attribute can be used to return any additional details of PrincipalResourcePermissions. Currently returns only as a RAM resource share ARN.
      - ResourceShare (list) --
        
        A resource share ARN for a catalog resource shared through RAM.
        
        (string) --
    - LastUpdated (datetime) --
      
      The date and time when the resource was last updated.
    - LastUpdatedBy (string) --
      
      The user who updated the record.
- NextToken (string) --
  
  A continuation token, if this is not the first call to retrieve this list.

GetResourceLFTags (updated)

Link ¶
Changes (request)

{'Resource': {'RLSPolicy': {'CatalogId': 'string', 'Name': 'string'}}}

Returns the LF-tags applied to a resource.

See also: AWS API Documentation

Request Syntax

client.get_resource_lf_tags(
    CatalogId='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'
        }
    },
    ShowAssignedLFTags=True|False
)

type CatalogId:

string

param CatalogId:

type Resource:

dict

param Resource:

[REQUIRED]

The database, table, or column resource for which you want to return LF-tags.

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.

type ShowAssignedLFTags:

boolean

param ShowAssignedLFTags:

Indicates whether to show the assigned LF-tags.

rtype:

dict

returns:

Response Syntax

{
    'LFTagOnDatabase': [
        {
            'CatalogId': 'string',
            'TagKey': 'string',
            'TagValues': [
                'string',
            ]
        },
    ],
    'LFTagsOnTable': [
        {
            'CatalogId': 'string',
            'TagKey': 'string',
            'TagValues': [
                'string',
            ]
        },
    ],
    'LFTagsOnColumns': [
        {
            'Name': 'string',
            'LFTags': [
                {
                    'CatalogId': 'string',
                    'TagKey': 'string',
                    'TagValues': [
                        'string',
                    ]
                },
            ]
        },
    ]
}

Response Structure

(dict) --
- LFTagOnDatabase (list) --
  
  A list of LF-tags applied to a database resource.
  - (dict) --
    
    A structure containing an LF-tag key-value pair.
    - 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) --
- LFTagsOnTable (list) --
  
  A list of LF-tags applied to a table resource.
  - (dict) --
    
    A structure containing an LF-tag key-value pair.
    - 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) --
- LFTagsOnColumns (list) --
  
  A list of LF-tags applied to a column resource.
  - (dict) --
    
    A structure containing the name of a column resource and the LF-tags attached to it.
    - Name (string) --
      
      The name of a column resource.
    - LFTags (list) --
      
      The LF-tags attached to a column resource.
      - (dict) --
        
        A structure containing an LF-tag key-value pair.
        
        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) --

GrantPermissions (updated)

Link ¶
Changes (request)

{'Resource': {'RLSPolicy': {'CatalogId': 'string', 'Name': 'string'}}}

Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.

For information about permissions, see Security and Access Control to Metadata and Data.

See also: AWS API Documentation

Request Syntax

client.grant_permissions(
    CatalogId='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'
        }
    },
    Permissions=[
        'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_LF_TAG'|'ASSOCIATE'|'GRANT_WITH_LF_TAG_EXPRESSION'|'CREATE_LF_TAG_EXPRESSION'|'CREATE_CATALOG'|'SUPER_USER',
    ],
    Condition={
        'Expression': 'string'
    },
    PermissionsWithGrantOption=[
        'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_LF_TAG'|'ASSOCIATE'|'GRANT_WITH_LF_TAG_EXPRESSION'|'CREATE_LF_TAG_EXPRESSION'|'CREATE_CATALOG'|'SUPER_USER',
    ]
)

type CatalogId:

string

param CatalogId:

type Principal:

dict

param Principal:

[REQUIRED]

The principal to be granted the permissions on the resource. Supported principals are IAM users or IAM roles, and they are defined by their principal type and their ARN.

Note that if you define a resource with a particular ARN, then later delete, and recreate a resource with that same ARN, the resource maintains the permissions already granted.

DataLakePrincipalIdentifier (string) --

An identifier for the Lake Formation principal.

type Resource:

dict

param Resource:

[REQUIRED]

The resource to which permissions are to be granted. Resources in Lake Formation are the Data Catalog, databases, and tables.

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.

type Permissions:

list

param Permissions:

[REQUIRED]

The permissions granted to the principal on the resource. Lake Formation defines privileges to grant and revoke access to metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. Lake Formation requires that each principal be authorized to perform a specific task on Lake Formation resources.

(string) --

type Condition:

dict

param Condition:

A Lake Formation condition, which applies to permissions and opt-ins that contain an expression.

Expression (string) --

An expression written based on the Cedar Policy Language used to match the principal attributes.

type PermissionsWithGrantOption:

list

param PermissionsWithGrantOption:

Indicates a list of the granted permissions that the principal may pass to other users. These permissions may only be a subset of the permissions granted in the Privileges.

(string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

ListLakeFormationOptIns (updated)

Link ¶
Changes (request, response)
Request

{'Resource': {'RLSPolicy': {'CatalogId': 'string', 'Name': 'string'}}}

Response

{'LakeFormationOptInsInfoList': {'Resource': {'RLSPolicy': {'CatalogId': 'string',
                                                            'Name': 'string'}}}}

Retrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions.

See also: AWS API Documentation

Request Syntax

client.list_lake_formation_opt_ins(
    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'
        }
    },
    MaxResults=123,
    NextToken='string'
)

type Principal:

dict

param Principal:

The Lake Formation principal. Supported principals are IAM users or IAM roles.

DataLakePrincipalIdentifier (string) --

An identifier for the Lake Formation principal.

type Resource:

dict

param Resource:

A structure for the 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.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return.

type NextToken:

string

param NextToken:

A continuation token, if this is not the first call to retrieve this list.

rtype:

dict

returns:

Response Syntax

{
    'LakeFormationOptInsInfoList': [
        {
            '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'
            },
            'Condition': {
                'Expression': 'string'
            },
            'LastModified': datetime(2015, 1, 1),
            'LastUpdatedBy': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- LakeFormationOptInsInfoList (list) --
  
  A list of principal-resource pairs that have Lake Formation permissins enforced.
  - (dict) --
    
    A single principal-resource pair that has Lake Formation permissins enforced.
    - Resource (dict) --
      
      A structure for the 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) --
        
        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.
    - Principal (dict) --
      
      The Lake Formation principal. Supported principals are IAM users or IAM roles.
      - DataLakePrincipalIdentifier (string) --
        
        An identifier for the Lake Formation principal.
    - Condition (dict) --
      
      A Lake Formation condition, which applies to permissions and opt-ins that contain an expression.
      - Expression (string) --
        
        An expression written based on the Cedar Policy Language used to match the principal attributes.
    - LastModified (datetime) --
      
      The last modified date and time of the record.
    - LastUpdatedBy (string) --
      
      The user who updated the record.
- NextToken (string) --
  
  A continuation token, if this is not the first call to retrieve this list.

ListPermissions (updated)

Link ¶
Changes (request, response)
Request

{'Resource': {'RLSPolicy': {'CatalogId': 'string', 'Name': 'string'}}}

Response

{'PrincipalResourcePermissions': {'Resource': {'RLSPolicy': {'CatalogId': 'string',
                                                             'Name': 'string'}}}}

Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.

This operation returns only those permissions that have been explicitly granted. If both Principal and Resource parameters are provided, the response returns effective permissions rather than the explicitly granted permissions.

For information about permissions, see Security and Access Control to Metadata and Data.

See also: AWS API Documentation

Request Syntax

client.list_permissions(
    CatalogId='string',
    Principal={
        'DataLakePrincipalIdentifier': 'string'
    },
    ResourceType='CATALOG'|'DATABASE'|'TABLE'|'DATA_LOCATION'|'LF_TAG'|'LF_TAG_POLICY'|'LF_TAG_POLICY_DATABASE'|'LF_TAG_POLICY_TABLE'|'LF_NAMED_TAG_EXPRESSION',
    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'
        }
    },
    NextToken='string',
    MaxResults=123,
    IncludeRelated='string'
)

type CatalogId:

string

param CatalogId:

type Principal:

dict

param Principal:

Specifies a principal to filter the permissions returned.

DataLakePrincipalIdentifier (string) --

An identifier for the Lake Formation principal.

type ResourceType:

string

param ResourceType:

Specifies a resource type to filter the permissions returned.

type Resource:

dict

param Resource:

A resource where you will get a list of the principal permissions.

This operation does not support getting privileges on a table with columns. Instead, call this operation on the table, and the operation returns the table and the table w columns.

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.

type NextToken:

string

param NextToken:

A continuation token, if this is not the first call to retrieve this list.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return.

type IncludeRelated:

string

param IncludeRelated:

Indicates that related permissions should be included in the results when listing permissions on a table resource.

Set the field to TRUE to show the cell filters on a table resource. Default is FALSE. The Principal parameter must not be specified when requesting cell filter information.

rtype:

dict

returns:

Response Syntax

{
    'PrincipalResourcePermissions': [
        {
            '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'
            },
            'Permissions': [
                'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_LF_TAG'|'ASSOCIATE'|'GRANT_WITH_LF_TAG_EXPRESSION'|'CREATE_LF_TAG_EXPRESSION'|'CREATE_CATALOG'|'SUPER_USER',
            ],
            'PermissionsWithGrantOption': [
                'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_LF_TAG'|'ASSOCIATE'|'GRANT_WITH_LF_TAG_EXPRESSION'|'CREATE_LF_TAG_EXPRESSION'|'CREATE_CATALOG'|'SUPER_USER',
            ],
            'AdditionalDetails': {
                'ResourceShare': [
                    'string',
                ]
            },
            'LastUpdated': datetime(2015, 1, 1),
            'LastUpdatedBy': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- PrincipalResourcePermissions (list) --
  
  A list of principals and their permissions on the resource for the specified principal and resource types.
  - (dict) --
    
    The permissions granted or revoked on a resource.
    - Principal (dict) --
      
      The Data Lake principal to be granted or revoked permissions.
      - DataLakePrincipalIdentifier (string) --
        
        An identifier for the Lake Formation principal.
    - Resource (dict) --
      
      The resource where permissions are to be granted or revoked.
      - 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 permissions and opt-ins that contain an expression.
      - Expression (string) --
        
        An expression written based on the Cedar Policy Language used to match the principal attributes.
    - Permissions (list) --
      
      The permissions to be granted or revoked on the resource.
      - (string) --
    - PermissionsWithGrantOption (list) --
      
      Indicates whether to grant the ability to grant permissions (as a subset of permissions granted).
      - (string) --
    - AdditionalDetails (dict) --
      
      This attribute can be used to return any additional details of PrincipalResourcePermissions. Currently returns only as a RAM resource share ARN.
      - ResourceShare (list) --
        
        A resource share ARN for a catalog resource shared through RAM.
        
        (string) --
    - LastUpdated (datetime) --
      
      The date and time when the resource was last updated.
    - LastUpdatedBy (string) --
      
      The user who updated the record.
- NextToken (string) --
  
  A continuation token, if this is not the first call to retrieve this list.

RemoveLFTagsFromResource (updated)

Link ¶
Changes (request)

{'Resource': {'RLSPolicy': {'CatalogId': 'string', 'Name': 'string'}}}

Removes an LF-tag from the resource. Only database, table, or tableWithColumns resource are allowed. To tag columns, use the column inclusion list in tableWithColumns to specify column input.

See also: AWS API Documentation

Request Syntax

client.remove_lf_tags_from_resource(
    CatalogId='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'
        }
    },
    LFTags=[
        {
            'CatalogId': 'string',
            'TagKey': 'string',
            'TagValues': [
                'string',
            ]
        },
    ]
)

type CatalogId:

string

param CatalogId:

type Resource:

dict

param Resource:

[REQUIRED]

The database, table, or column resource where you want to remove an LF-tag.

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.

type LFTags:

list

param LFTags:

[REQUIRED]

The LF-tags to be removed from the resource.

(dict) --

A structure containing an LF-tag key-value pair.
- 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) --

rtype:

dict

returns:

Response Syntax

{
    'Failures': [
        {
            'LFTag': {
                'CatalogId': 'string',
                'TagKey': 'string',
                'TagValues': [
                    'string',
                ]
            },
            'Error': {
                'ErrorCode': 'string',
                'ErrorMessage': 'string'
            }
        },
    ]
}

Response Structure

(dict) --
- Failures (list) --
  
  A list of failures to untag a resource.
  - (dict) --
    
    A structure containing an error related to a TagResource or UnTagResource operation.
    - LFTag (dict) --
      
      The key-name of the LF-tag.
      - 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) --
    - Error (dict) --
      
      An error that occurred with the attachment or detachment of the LF-tag.
      - ErrorCode (string) --
        
        The code associated with this error.
      - ErrorMessage (string) --
        
        A message describing the error.

RevokePermissions (updated)

Link ¶
Changes (request)

{'Resource': {'RLSPolicy': {'CatalogId': 'string', 'Name': 'string'}}}

Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.

See also: AWS API Documentation

Request Syntax

client.revoke_permissions(
    CatalogId='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'
        }
    },
    Permissions=[
        'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_LF_TAG'|'ASSOCIATE'|'GRANT_WITH_LF_TAG_EXPRESSION'|'CREATE_LF_TAG_EXPRESSION'|'CREATE_CATALOG'|'SUPER_USER',
    ],
    Condition={
        'Expression': 'string'
    },
    PermissionsWithGrantOption=[
        'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_LF_TAG'|'ASSOCIATE'|'GRANT_WITH_LF_TAG_EXPRESSION'|'CREATE_LF_TAG_EXPRESSION'|'CREATE_CATALOG'|'SUPER_USER',
    ]
)

type CatalogId:

string

param CatalogId:

type Principal:

dict

param Principal:

[REQUIRED]

The principal to be revoked permissions on the resource.

DataLakePrincipalIdentifier (string) --

An identifier for the Lake Formation principal.

type Resource:

dict

param Resource:

[REQUIRED]

The resource to which permissions are to be revoked.

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.

type Permissions:

list

param Permissions:

[REQUIRED]

The permissions revoked to the principal on the resource. For information about permissions, see Security and Access Control to Metadata and Data.

(string) --

type Condition:

dict

param Condition:

A Lake Formation condition, which applies to permissions and opt-ins that contain an expression.

Expression (string) --

An expression written based on the Cedar Policy Language used to match the principal attributes.

type PermissionsWithGrantOption:

list

param PermissionsWithGrantOption:

Indicates a list of permissions for which to revoke the grant option allowing the principal to pass permissions to other principals.

(string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --