2023/09/26 - AWS Lake Formation - 3 new6 updated api methods
Changes This release adds three new API support "CreateLakeFormationOptIn", "DeleteLakeFormationOptIn" and "ListLakeFormationOptIns", and also updates the corresponding documentation.
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': {}
,
'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',
]
},
]
}
}
)
dict
[REQUIRED]
The Lake Formation principal. Supported principals are IAM users or IAM roles.
DataLakePrincipalIdentifier (string) --
An identifier for the Lake Formation principal.
dict
[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.
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 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) -- [REQUIRED]
A list of LF-tag conditions 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) --
dict
Response Syntax
{}
Response Structure
(dict) --
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': {}
,
'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',
]
},
]
}
},
MaxResults=123,
NextToken='string'
)
dict
The Lake Formation principal. Supported principals are IAM users or IAM roles.
DataLakePrincipalIdentifier (string) --
An identifier for the Lake Formation principal.
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.
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 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) -- [REQUIRED]
A list of LF-tag conditions 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) --
integer
The maximum number of results to return.
string
A continuation token, if this is not the first call to retrieve this list.
dict
Response Syntax
{
'LakeFormationOptInsInfoList': [
{
'Resource': {
'Catalog': {},
'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',
]
},
]
}
},
'Principal': {
'DataLakePrincipalIdentifier': '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.
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 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 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) --
Principal (dict) --
The Lake Formation principal. Supported principals are IAM users or IAM roles.
DataLakePrincipalIdentifier (string) --
An identifier for the Lake Formation principal.
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.
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': {}
,
'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',
]
},
]
}
}
)
dict
[REQUIRED]
The Lake Formation principal. Supported principals are IAM users or IAM roles.
DataLakePrincipalIdentifier (string) --
An identifier for the Lake Formation principal.
dict
[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.
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 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) -- [REQUIRED]
A list of LF-tag conditions 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) --
dict
Response Syntax
{}
Response Structure
(dict) --
{'ResourceInfo': {'HybridAccessEnabled': 'boolean'}}
Retrieves the current data access role for the given resource registered in Lake Formation.
See also: AWS API Documentation
Request Syntax
client.describe_resource(
ResourceArn='string'
)
string
[REQUIRED]
The resource ARN.
dict
Response Syntax
{
'ResourceInfo': {
'ResourceArn': 'string',
'RoleArn': 'string',
'LastModified': datetime(2015, 1, 1),
'WithFederation': True|False,
'HybridAccessEnabled': True|False
}
}
Response Structure
(dict) --
ResourceInfo (dict) --
A structure containing information about an Lake Formation resource.
ResourceArn (string) --
The Amazon Resource Name (ARN) of the resource.
RoleArn (string) --
The IAM role that registered a resource.
LastModified (datetime) --
The date and time the resource was last modified.
WithFederation (boolean) --
Whether or not the resource is a federated resource.
HybridAccessEnabled (boolean) --
Indicates whether the data access of tables pointing to the location can be managed by both Lake Formation permissions as well as Amazon S3 bucket policies.
{'Permissions': {'LastUpdated': 'timestamp', 'LastUpdatedBy': '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
)
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.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource for which you want to get permissions.
string
A continuation token, if this is not the first call to retrieve this list.
integer
The maximum number of results to return.
dict
Response Syntax
{
'Permissions': [
{
'Principal': {
'DataLakePrincipalIdentifier': 'string'
},
'Resource': {
'Catalog': {},
'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',
]
},
]
}
},
'Permissions': [
'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_LF_TAG'|'ASSOCIATE'|'GRANT_WITH_LF_TAG_EXPRESSION',
],
'PermissionsWithGrantOption': [
'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_LF_TAG'|'ASSOCIATE'|'GRANT_WITH_LF_TAG_EXPRESSION',
],
'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.
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 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 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) --
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.
{'PrincipalResourcePermissions': {'LastUpdated': 'timestamp',
'LastUpdatedBy': '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.
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',
Resource={
'Catalog': {}
,
'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',
]
},
]
}
},
NextToken='string',
MaxResults=123,
IncludeRelated='string'
)
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.
dict
Specifies a principal to filter the permissions returned.
DataLakePrincipalIdentifier (string) --
An identifier for the Lake Formation principal.
string
Specifies a resource type to filter the permissions returned.
dict
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.
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 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) -- [REQUIRED]
A list of LF-tag conditions 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) --
string
A continuation token, if this is not the first call to retrieve this list.
integer
The maximum number of results to return.
string
Indicates that related permissions should be included in the results.
dict
Response Syntax
{
'PrincipalResourcePermissions': [
{
'Principal': {
'DataLakePrincipalIdentifier': 'string'
},
'Resource': {
'Catalog': {},
'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',
]
},
]
}
},
'Permissions': [
'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_LF_TAG'|'ASSOCIATE'|'GRANT_WITH_LF_TAG_EXPRESSION',
],
'PermissionsWithGrantOption': [
'ALL'|'SELECT'|'ALTER'|'DROP'|'DELETE'|'INSERT'|'DESCRIBE'|'CREATE_DATABASE'|'CREATE_TABLE'|'DATA_LOCATION_ACCESS'|'CREATE_LF_TAG'|'ASSOCIATE'|'GRANT_WITH_LF_TAG_EXPRESSION',
],
'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.
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 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 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) --
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.
{'ResourceInfoList': {'HybridAccessEnabled': 'boolean'}}
Lists the resources registered to be managed by the Data Catalog.
See also: AWS API Documentation
Request Syntax
client.list_resources(
FilterConditionList=[
{
'Field': 'RESOURCE_ARN'|'ROLE_ARN'|'LAST_MODIFIED',
'ComparisonOperator': 'EQ'|'NE'|'LE'|'LT'|'GE'|'GT'|'CONTAINS'|'NOT_CONTAINS'|'BEGINS_WITH'|'IN'|'BETWEEN',
'StringValueList': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
list
Any applicable row-level and/or column-level filtering conditions for the resources.
(dict) --
This structure describes the filtering of columns in a table based on a filter condition.
Field (string) --
The field to filter in the filter condition.
ComparisonOperator (string) --
The comparison operator used in the filter condition.
StringValueList (list) --
A string with values used in evaluating the filter condition.
(string) --
integer
The maximum number of resource results.
string
A continuation token, if this is not the first call to retrieve these resources.
dict
Response Syntax
{
'ResourceInfoList': [
{
'ResourceArn': 'string',
'RoleArn': 'string',
'LastModified': datetime(2015, 1, 1),
'WithFederation': True|False,
'HybridAccessEnabled': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ResourceInfoList (list) --
A summary of the data lake resources.
(dict) --
A structure containing information about an Lake Formation resource.
ResourceArn (string) --
The Amazon Resource Name (ARN) of the resource.
RoleArn (string) --
The IAM role that registered a resource.
LastModified (datetime) --
The date and time the resource was last modified.
WithFederation (boolean) --
Whether or not the resource is a federated resource.
HybridAccessEnabled (boolean) --
Indicates whether the data access of tables pointing to the location can be managed by both Lake Formation permissions as well as Amazon S3 bucket policies.
NextToken (string) --
A continuation token, if this is not the first call to retrieve these resources.
{'HybridAccessEnabled': 'boolean'}
Registers the resource as managed by the Data Catalog.
To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.
The following request registers a new location and gives Lake Formation permission to use the service-linked role to access that location.
ResourceArn = arn:aws:s3:::my-bucket UseServiceLinkedRole = true
If UseServiceLinkedRole is not set to true, you must provide or set the RoleArn:
arn:aws:iam::12345:role/my-data-access-role
See also: AWS API Documentation
Request Syntax
client.register_resource(
ResourceArn='string',
UseServiceLinkedRole=True|False,
RoleArn='string',
WithFederation=True|False,
HybridAccessEnabled=True|False
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource that you want to register.
boolean
Designates an Identity and Access Management (IAM) service-linked role by registering this role with the Data Catalog. A service-linked role is a unique type of IAM role that is linked directly to Lake Formation.
For more information, see Using Service-Linked Roles for Lake Formation.
string
The identifier for the role that registers the resource.
boolean
Whether or not the resource is a federated resource.
boolean
Specifies whether the data access of tables pointing to the location can be managed by both Lake Formation permissions as well as Amazon S3 bucket policies.
dict
Response Syntax
{}
Response Structure
(dict) --
{'HybridAccessEnabled': 'boolean'}
Updates the data access role used for vending access to the given (registered) resource in Lake Formation.
See also: AWS API Documentation
Request Syntax
client.update_resource(
RoleArn='string',
ResourceArn='string',
WithFederation=True|False,
HybridAccessEnabled=True|False
)
string
[REQUIRED]
The new role to use for the given resource registered in Lake Formation.
string
[REQUIRED]
The resource ARN.
boolean
Whether or not the resource is a federated resource.
boolean
Specifies whether the data access of tables pointing to the location can be managed by both Lake Formation permissions as well as Amazon S3 bucket policies.
dict
Response Syntax
{}
Response Structure
(dict) --