LakeFormation ************* Client ====== class LakeFormation.Client A low-level client representing AWS Lake Formation Defines the public endpoint for the Lake Formation service. import boto3 client = boto3.client('lakeformation') These are the available methods: * add_lf_tags_to_resource * assume_decorated_role_with_saml * batch_grant_permissions * batch_revoke_permissions * can_paginate * cancel_transaction * close * commit_transaction * create_data_cells_filter * create_lake_formation_identity_center_configuration * create_lake_formation_opt_in * create_lf_tag * create_lf_tag_expression * delete_data_cells_filter * delete_lake_formation_identity_center_configuration * delete_lake_formation_opt_in * delete_lf_tag * delete_lf_tag_expression * delete_objects_on_cancel * deregister_resource * describe_lake_formation_identity_center_configuration * describe_resource * describe_transaction * extend_transaction * get_data_cells_filter * get_data_lake_principal * get_data_lake_settings * get_effective_permissions_for_path * get_lf_tag * get_lf_tag_expression * get_paginator * get_query_state * get_query_statistics * get_resource_lf_tags * get_table_objects * get_temporary_glue_partition_credentials * get_temporary_glue_table_credentials * get_waiter * get_work_unit_results * get_work_units * grant_permissions * list_data_cells_filter * list_lake_formation_opt_ins * list_lf_tag_expressions * list_lf_tags * list_permissions * list_resources * list_table_storage_optimizers * list_transactions * put_data_lake_settings * register_resource * remove_lf_tags_from_resource * revoke_permissions * search_databases_by_lf_tags * search_tables_by_lf_tags * start_query_planning * start_transaction * update_data_cells_filter * update_lake_formation_identity_center_configuration * update_lf_tag * update_lf_tag_expression * update_resource * update_table_objects * update_table_storage_optimizer Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * GetWorkUnits * ListDataCellsFilter * ListLFTagExpressions * ListLFTags * SearchDatabasesByLFTags * SearchTablesByLFTags LakeFormation / Paginator / ListLFTags ListLFTags ********** class LakeFormation.Paginator.ListLFTags paginator = client.get_paginator('list_lf_tags') paginate(**kwargs) Creates an iterator that will paginate through responses from "LakeFormation.Client.list_lf_tags()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( CatalogId='string', ResourceShareType='FOREIGN'|'ALL', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **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. * **ResourceShareType** (*string*) -- If resource share type is "ALL", returns both in-account LF-tags and shared LF- tags that the requester has permission to view. If resource share type is "FOREIGN", returns all share LF-tags that the requester can view. If no resource share type is passed, lists LF-tags in the given catalog ID that the requester has permission to view. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'LFTags': [ { 'CatalogId': 'string', 'TagKey': 'string', 'TagValues': [ 'string', ] }, ], } **Response Structure** * *(dict) --* * **LFTags** *(list) --* A list of LF-tags that the requested has permission to view. * *(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) --* LakeFormation / Paginator / SearchDatabasesByLFTags SearchDatabasesByLFTags *********************** class LakeFormation.Paginator.SearchDatabasesByLFTags paginator = client.get_paginator('search_databases_by_lf_tags') paginate(**kwargs) Creates an iterator that will paginate through responses from "LakeFormation.Client.search_databases_by_lf_tags()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( CatalogId='string', Expression=[ { 'TagKey': 'string', 'TagValues': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **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. * **Expression** (*list*) -- **[REQUIRED]** A list of conditions ( "LFTag" structures) to search for in database resources. * *(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) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'DatabaseList': [ { 'Database': { 'CatalogId': 'string', 'Name': 'string' }, 'LFTags': [ { 'CatalogId': 'string', 'TagKey': 'string', 'TagValues': [ 'string', ] }, ] }, ] } **Response Structure** * *(dict) --* * **DatabaseList** *(list) --* A list of databases that meet the LF-tag conditions. * *(dict) --* A structure describing a database resource with LF- tags. * **Database** *(dict) --* A database that has LF-tags attached to it. * **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. * **LFTags** *(list) --* A list of LF-tags attached to the database. * *(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) --* LakeFormation / Paginator / GetWorkUnits GetWorkUnits ************ class LakeFormation.Paginator.GetWorkUnits paginator = client.get_paginator('get_work_units') paginate(**kwargs) Creates an iterator that will paginate through responses from "LakeFormation.Client.get_work_units()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( QueryId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **QueryId** (*string*) -- **[REQUIRED]** The ID of the plan query operation. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'QueryId': 'string', 'WorkUnitRanges': [ { 'WorkUnitIdMax': 123, 'WorkUnitIdMin': 123, 'WorkUnitToken': 'string' }, ] } **Response Structure** * *(dict) --* A structure for the output. * **QueryId** *(string) --* The ID of the plan query operation. * **WorkUnitRanges** *(list) --* A "WorkUnitRangeList" object that specifies the valid range of work unit IDs for querying the execution service. * *(dict) --* Defines the valid range of work unit IDs for querying the execution service. * **WorkUnitIdMax** *(integer) --* Defines the maximum work unit ID in the range. The maximum value is inclusive. * **WorkUnitIdMin** *(integer) --* Defines the minimum work unit ID in the range. * **WorkUnitToken** *(string) --* A work token used to query the execution service. LakeFormation / Paginator / ListDataCellsFilter ListDataCellsFilter ******************* class LakeFormation.Paginator.ListDataCellsFilter paginator = client.get_paginator('list_data_cells_filter') paginate(**kwargs) Creates an iterator that will paginate through responses from "LakeFormation.Client.list_data_cells_filter()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Table={ 'CatalogId': 'string', 'DatabaseName': 'string', 'Name': 'string', 'TableWildcard': {} }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Table** (*dict*) -- A table in the Glue Data Catalog. * **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. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'DataCellsFilters': [ { 'TableCatalogId': 'string', 'DatabaseName': 'string', 'TableName': 'string', 'Name': 'string', 'RowFilter': { 'FilterExpression': 'string', 'AllRowsWildcard': {} }, 'ColumnNames': [ 'string', ], 'ColumnWildcard': { 'ExcludedColumnNames': [ 'string', ] }, 'VersionId': 'string' }, ], } **Response Structure** * *(dict) --* * **DataCellsFilters** *(list) --* A list of "DataCellFilter" structures. * *(dict) --* A structure that describes certain columns on certain rows. * **TableCatalogId** *(string) --* The ID of the catalog to which the table belongs. * **DatabaseName** *(string) --* A database in the Glue Data Catalog. * **TableName** *(string) --* A table in the database. * **Name** *(string) --* The name given by the user to the data filter cell. * **RowFilter** *(dict) --* A PartiQL predicate. * **FilterExpression** *(string) --* A filter expression. * **AllRowsWildcard** *(dict) --* A wildcard for all rows. * **ColumnNames** *(list) --* A list of column names and/or nested column attributes. When specifying nested attributes, use a qualified dot (.) delimited format such as "address"."zip". Nested attributes within this list may not exceed a depth of 5. * *(string) --* * **ColumnWildcard** *(dict) --* A wildcard with exclusions. You must specify either a "ColumnNames" list or the "ColumnWildCard". * **ExcludedColumnNames** *(list) --* Excludes column names. Any column with this name will be excluded. * *(string) --* * **VersionId** *(string) --* The ID of the data cells filter version. LakeFormation / Paginator / ListLFTagExpressions ListLFTagExpressions ******************** class LakeFormation.Paginator.ListLFTagExpressions paginator = client.get_paginator('list_lf_tag_expressions') paginate(**kwargs) Creates an iterator that will paginate through responses from "LakeFormation.Client.list_lf_tag_expressions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( CatalogId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **CatalogId** (*string*) -- The identifier for the Data Catalog. By default, the account ID. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'LFTagExpressions': [ { 'Name': 'string', 'Description': 'string', 'CatalogId': 'string', 'Expression': [ { 'TagKey': 'string', 'TagValues': [ 'string', ] }, ] }, ], } **Response Structure** * *(dict) --* * **LFTagExpressions** *(list) --* Logical expressions composed of one more LF-Tag key-value pairs. * *(dict) --* A structure consists LF-Tag expression name and catalog ID. * **Name** *(string) --* The name for saved the LF-Tag expression. * **Description** *(string) --* A structure that contains information about the LF- Tag expression. * **CatalogId** *(string) --* The identifier for the Data Catalog. By default, the account ID. * **Expression** *(list) --* A logical expression composed of one or more LF-Tags. * *(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) --* LakeFormation / Paginator / SearchTablesByLFTags SearchTablesByLFTags ******************** class LakeFormation.Paginator.SearchTablesByLFTags paginator = client.get_paginator('search_tables_by_lf_tags') paginate(**kwargs) Creates an iterator that will paginate through responses from "LakeFormation.Client.search_tables_by_lf_tags()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( CatalogId='string', Expression=[ { 'TagKey': 'string', 'TagValues': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **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. * **Expression** (*list*) -- **[REQUIRED]** A list of conditions ( "LFTag" structures) to search for in table resources. * *(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) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TableList': [ { 'Table': { 'CatalogId': 'string', 'DatabaseName': 'string', 'Name': 'string', 'TableWildcard': {} }, '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) --* * **TableList** *(list) --* A list of tables that meet the LF-tag conditions. * *(dict) --* A structure describing a table resource with LF-tags. * **Table** *(dict) --* A table that has LF-tags attached to it. * **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. * **LFTagOnDatabase** *(list) --* A list of LF-tags attached to the database where the table resides. * *(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 attached to the table. * *(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 attached to columns in the table. * *(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) --* LakeFormation / Client / update_table_storage_optimizer update_table_storage_optimizer ****************************** LakeFormation.Client.update_table_storage_optimizer(**kwargs) Updates the configuration of the storage optimizers for a table. See also: AWS API Documentation **Request Syntax** response = client.update_table_storage_optimizer( CatalogId='string', DatabaseName='string', TableName='string', StorageOptimizerConfig={ 'string': { 'string': 'string' } } ) Parameters: * **CatalogId** (*string*) -- The Catalog ID of the table. * **DatabaseName** (*string*) -- **[REQUIRED]** Name of the database where the table is present. * **TableName** (*string*) -- **[REQUIRED]** Name of the table for which to enable the storage optimizer. * **StorageOptimizerConfig** (*dict*) -- **[REQUIRED]** Name of the configuration for the storage optimizer. * *(string) --* * *(dict) --* * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'Result': 'string' } **Response Structure** * *(dict) --* * **Result** *(string) --* A response indicating the success of failure of the operation. **Exceptions** * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.AccessDeniedException" * "LakeFormation.Client.exceptions.InternalServiceException" LakeFormation / Client / create_lake_formation_identity_center_configuration create_lake_formation_identity_center_configuration *************************************************** LakeFormation.Client.create_lake_formation_identity_center_configuration(**kwargs) Creates an IAM Identity Center connection with Lake Formation to allow IAM Identity Center users and groups to access Data Catalog resources. See also: AWS API Documentation **Request Syntax** response = client.create_lake_formation_identity_center_configuration( CatalogId='string', InstanceArn='string', ExternalFiltering={ 'Status': 'ENABLED'|'DISABLED', 'AuthorizedTargets': [ 'string', ] }, ShareRecipients=[ { 'DataLakePrincipalIdentifier': 'string' }, ] ) Parameters: * **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, view definitions, and other control information to manage your Lake Formation environment. * **InstanceArn** (*string*) -- The ARN of the IAM Identity Center instance for which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference. * **ExternalFiltering** (*dict*) -- A list of the account IDs of Amazon Web Services accounts of third-party applications that are allowed to access data managed by Lake Formation. * **Status** *(string) --* **[REQUIRED]** Allows to enable or disable the third-party applications that are allowed to access data managed by Lake Formation. * **AuthorizedTargets** *(list) --* **[REQUIRED]** List of third-party application "ARNs" integrated with Lake Formation. * *(string) --* * **ShareRecipients** (*list*) -- A list of Amazon Web Services account IDs and/or Amazon Web Services organization/organizational unit ARNs that are allowed to access data managed by Lake Formation. If the "ShareRecipients" list includes valid values, a resource share is created with the principals you want to have access to the resources. If the "ShareRecipients" value is null or the list is empty, no resource share is created. * *(dict) --* The Lake Formation principal. Supported principals are IAM users or IAM roles. * **DataLakePrincipalIdentifier** *(string) --* An identifier for the Lake Formation principal. Return type: dict Returns: **Response Syntax** { 'ApplicationArn': 'string' } **Response Structure** * *(dict) --* * **ApplicationArn** *(string) --* The Amazon Resource Name (ARN) of the Lake Formation application integrated with IAM Identity Center. **Exceptions** * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.AlreadyExistsException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.AccessDeniedException" * "LakeFormation.Client.exceptions.ConcurrentModificationException" LakeFormation / Client / update_lf_tag_expression update_lf_tag_expression ************************ LakeFormation.Client.update_lf_tag_expression(**kwargs) Updates the name of the LF-Tag expression to the new description and expression body provided. Updating a LF-Tag expression immediately changes the permission boundaries of all existing "LFTagPolicy" permission grants that reference the given LF-Tag expression. See also: AWS API Documentation **Request Syntax** response = client.update_lf_tag_expression( Name='string', Description='string', CatalogId='string', Expression=[ { 'TagKey': 'string', 'TagValues': [ 'string', ] }, ] ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name for the LF-Tag expression. * **Description** (*string*) -- The description with information about the saved LF-Tag expression. * **CatalogId** (*string*) -- The identifier for the Data Catalog. By default, the account ID. * **Expression** (*list*) -- **[REQUIRED]** The LF-Tag expression body composed of one more LF-Tag key- value pairs. * *(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) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.ResourceNumberLimitExceededExce ption" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.AccessDeniedException" LakeFormation / Client / describe_lake_formation_identity_center_configuration describe_lake_formation_identity_center_configuration ***************************************************** LakeFormation.Client.describe_lake_formation_identity_center_configuration(**kwargs) Retrieves the instance ARN and application ARN for the connection. See also: AWS API Documentation **Request Syntax** response = client.describe_lake_formation_identity_center_configuration( CatalogId='string' ) Parameters: **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. Return type: dict Returns: **Response Syntax** { 'CatalogId': 'string', 'InstanceArn': 'string', 'ApplicationArn': 'string', 'ExternalFiltering': { 'Status': 'ENABLED'|'DISABLED', 'AuthorizedTargets': [ 'string', ] }, 'ShareRecipients': [ { 'DataLakePrincipalIdentifier': 'string' }, ], 'ResourceShare': 'string' } **Response Structure** * *(dict) --* * **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. * **InstanceArn** *(string) --* The Amazon Resource Name (ARN) of the connection. * **ApplicationArn** *(string) --* The Amazon Resource Name (ARN) of the Lake Formation application integrated with IAM Identity Center. * **ExternalFiltering** *(dict) --* Indicates if external filtering is enabled. * **Status** *(string) --* Allows to enable or disable the third-party applications that are allowed to access data managed by Lake Formation. * **AuthorizedTargets** *(list) --* List of third-party application "ARNs" integrated with Lake Formation. * *(string) --* * **ShareRecipients** *(list) --* A list of Amazon Web Services account IDs or Amazon Web Services organization/organizational unit ARNs that are allowed to access data managed by Lake Formation. If the "ShareRecipients" list includes valid values, a resource share is created with the principals you want to have access to the resources as the "ShareRecipients". If the "ShareRecipients" value is null or the list is empty, no resource share is created. * *(dict) --* The Lake Formation principal. Supported principals are IAM users or IAM roles. * **DataLakePrincipalIdentifier** *(string) --* An identifier for the Lake Formation principal. * **ResourceShare** *(string) --* The Amazon Resource Name (ARN) of the RAM share. **Exceptions** * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.AccessDeniedException" LakeFormation / Client / commit_transaction commit_transaction ****************** LakeFormation.Client.commit_transaction(**kwargs) Attempts to commit the specified transaction. Returns an exception if the transaction was previously aborted. This API action is idempotent if called multiple times for the same transaction. See also: AWS API Documentation **Request Syntax** response = client.commit_transaction( TransactionId='string' ) Parameters: **TransactionId** (*string*) -- **[REQUIRED]** The transaction to commit. Return type: dict Returns: **Response Syntax** { 'TransactionStatus': 'ACTIVE'|'COMMITTED'|'ABORTED'|'COMMIT_IN_PROGRESS' } **Response Structure** * *(dict) --* * **TransactionStatus** *(string) --* The status of the transaction. **Exceptions** * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.TransactionCanceledException" * "LakeFormation.Client.exceptions.ConcurrentModificationException" LakeFormation / Client / get_paginator get_paginator ************* LakeFormation.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. LakeFormation / Client / deregister_resource deregister_resource ******************* LakeFormation.Client.deregister_resource(**kwargs) Deregisters the resource as managed by the Data Catalog. When you deregister a path, Lake Formation removes the path from the inline policy attached to your service-linked role. See also: AWS API Documentation **Request Syntax** response = client.deregister_resource( ResourceArn='string' ) Parameters: **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource that you want to deregister. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.EntityNotFoundException" LakeFormation / Client / get_effective_permissions_for_path get_effective_permissions_for_path ********************************** LakeFormation.Client.get_effective_permissions_for_path(**kwargs) 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** response = client.get_effective_permissions_for_path( CatalogId='string', ResourceArn='string', NextToken='string', MaxResults=123 ) Parameters: * **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. * **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource for which you want to get permissions. * **NextToken** (*string*) -- A continuation token, if this is not the first call to retrieve this list. * **MaxResults** (*integer*) -- The maximum number of results to return. Return type: 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' } }, '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. * **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. **Exceptions** * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.InternalServiceException" LakeFormation / Client / update_data_cells_filter update_data_cells_filter ************************ LakeFormation.Client.update_data_cells_filter(**kwargs) Updates a data cell filter. See also: AWS API Documentation **Request Syntax** response = client.update_data_cells_filter( TableData={ 'TableCatalogId': 'string', 'DatabaseName': 'string', 'TableName': 'string', 'Name': 'string', 'RowFilter': { 'FilterExpression': 'string', 'AllRowsWildcard': {} }, 'ColumnNames': [ 'string', ], 'ColumnWildcard': { 'ExcludedColumnNames': [ 'string', ] }, 'VersionId': 'string' } ) Parameters: **TableData** (*dict*) -- **[REQUIRED]** A "DataCellsFilter" structure containing information about the data cells filter. * **TableCatalogId** *(string) --* **[REQUIRED]** The ID of the catalog to which the table belongs. * **DatabaseName** *(string) --* **[REQUIRED]** A database in the Glue Data Catalog. * **TableName** *(string) --* **[REQUIRED]** A table in the database. * **Name** *(string) --* **[REQUIRED]** The name given by the user to the data filter cell. * **RowFilter** *(dict) --* A PartiQL predicate. * **FilterExpression** *(string) --* A filter expression. * **AllRowsWildcard** *(dict) --* A wildcard for all rows. * **ColumnNames** *(list) --* A list of column names and/or nested column attributes. When specifying nested attributes, use a qualified dot (.) delimited format such as "address"."zip". Nested attributes within this list may not exceed a depth of 5. * *(string) --* * **ColumnWildcard** *(dict) --* A wildcard with exclusions. You must specify either a "ColumnNames" list or the "ColumnWildCard". * **ExcludedColumnNames** *(list) --* Excludes column names. Any column with this name will be excluded. * *(string) --* * **VersionId** *(string) --* The ID of the data cells filter version. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "LakeFormation.Client.exceptions.ConcurrentModificationException" * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.AccessDeniedException" LakeFormation / Client / put_data_lake_settings put_data_lake_settings ********************** LakeFormation.Client.put_data_lake_settings(**kwargs) Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation. For more information on admin privileges, see Granting Lake Formation Permissions. This API replaces the current list of data lake admins with the new list being passed. To add an admin, fetch the current list and add the new admin to that list and pass that list in this API. See also: AWS API Documentation **Request Syntax** response = client.put_data_lake_settings( CatalogId='string', DataLakeSettings={ 'DataLakeAdmins': [ { 'DataLakePrincipalIdentifier': 'string' }, ], 'ReadOnlyAdmins': [ { 'DataLakePrincipalIdentifier': 'string' }, ], 'CreateDatabaseDefaultPermissions': [ { 'Principal': { 'DataLakePrincipalIdentifier': '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', ] }, ], 'CreateTableDefaultPermissions': [ { 'Principal': { 'DataLakePrincipalIdentifier': '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', ] }, ], 'Parameters': { 'string': 'string' }, 'TrustedResourceOwners': [ 'string', ], 'AllowExternalDataFiltering': True|False, 'AllowFullTableExternalDataAccess': True|False, 'ExternalDataFilteringAllowList': [ { 'DataLakePrincipalIdentifier': 'string' }, ], 'AuthorizedSessionTagValueList': [ 'string', ] } ) Parameters: * **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. * **DataLakeSettings** (*dict*) -- **[REQUIRED]** A structure representing a list of Lake Formation principals designated as data lake administrators. * **DataLakeAdmins** *(list) --* A list of Lake Formation principals. Supported principals are IAM users or IAM roles. * *(dict) --* The Lake Formation principal. Supported principals are IAM users or IAM roles. * **DataLakePrincipalIdentifier** *(string) --* An identifier for the Lake Formation principal. * **ReadOnlyAdmins** *(list) --* A list of Lake Formation principals with only view access to the resources, without the ability to make changes. Supported principals are IAM users or IAM roles. * *(dict) --* The Lake Formation principal. Supported principals are IAM users or IAM roles. * **DataLakePrincipalIdentifier** *(string) --* An identifier for the Lake Formation principal. * **CreateDatabaseDefaultPermissions** *(list) --* Specifies whether access control on newly created database is managed by Lake Formation permissions or exclusively by IAM permissions. A null value indicates access control by Lake Formation permissions. A value that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM permissions. This is referred to as the setting "Use only IAM access control," and is for backward compatibility with the Glue permission model implemented by IAM permissions. The only permitted values are an empty array or an array that contains a single JSON object that grants ALL to IAM_ALLOWED_PRINCIPALS. For more information, see Changing the Default Security Settings for Your Data Lake. * *(dict) --* Permissions granted to a principal. * **Principal** *(dict) --* The principal who is granted permissions. * **DataLakePrincipalIdentifier** *(string) --* An identifier for the Lake Formation principal. * **Permissions** *(list) --* The permissions that are granted to the principal. * *(string) --* * **CreateTableDefaultPermissions** *(list) --* Specifies whether access control on newly created table is managed by Lake Formation permissions or exclusively by IAM permissions. A null value indicates access control by Lake Formation permissions. A value that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM permissions. This is referred to as the setting "Use only IAM access control," and is for backward compatibility with the Glue permission model implemented by IAM permissions. The only permitted values are an empty array or an array that contains a single JSON object that grants ALL to IAM_ALLOWED_PRINCIPALS. For more information, see Changing the Default Security Settings for Your Data Lake. * *(dict) --* Permissions granted to a principal. * **Principal** *(dict) --* The principal who is granted permissions. * **DataLakePrincipalIdentifier** *(string) --* An identifier for the Lake Formation principal. * **Permissions** *(list) --* The permissions that are granted to the principal. * *(string) --* * **Parameters** *(dict) --* A key-value map that provides an additional configuration on your data lake. CROSS_ACCOUNT_VERSION is the key you can configure in the Parameters field. Accepted values for the CrossAccountVersion key are 1, 2, 3, and 4. * *(string) --* * *(string) --* * **TrustedResourceOwners** *(list) --* A list of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs). The user ARNs can be logged in the resource owner's CloudTrail log. You may want to specify this property when you are in a high-trust boundary, such as the same team or company. * *(string) --* * **AllowExternalDataFiltering** *(boolean) --* Whether to allow Amazon EMR clusters to access data managed by Lake Formation. If true, you allow Amazon EMR clusters to access data in Amazon S3 locations that are registered with Lake Formation. If false or null, no Amazon EMR clusters will be able to access data in Amazon S3 locations that are registered with Lake Formation. For more information, see (Optional) Allow external data filtering. * **AllowFullTableExternalDataAccess** *(boolean) --* Whether to allow a third-party query engine to get data access credentials without session tags when a caller has full data access permissions. * **ExternalDataFilteringAllowList** *(list) --* A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.> * *(dict) --* The Lake Formation principal. Supported principals are IAM users or IAM roles. * **DataLakePrincipalIdentifier** *(string) --* An identifier for the Lake Formation principal. * **AuthorizedSessionTagValueList** *(list) --* Lake Formation relies on a privileged process secured by Amazon EMR or the third party integrator to tag the user's role while assuming it. Lake Formation will publish the acceptable key-value pair, for example key = "LakeFormationTrustedCaller" and value = "TRUE" and the third party integrator must properly tag the temporary security credentials that will be used to call Lake Formation's administrative APIs. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.InvalidInputException" LakeFormation / Client / update_lake_formation_identity_center_configuration update_lake_formation_identity_center_configuration *************************************************** LakeFormation.Client.update_lake_formation_identity_center_configuration(**kwargs) Updates the IAM Identity Center connection parameters. See also: AWS API Documentation **Request Syntax** response = client.update_lake_formation_identity_center_configuration( CatalogId='string', ShareRecipients=[ { 'DataLakePrincipalIdentifier': 'string' }, ], ApplicationStatus='ENABLED'|'DISABLED', ExternalFiltering={ 'Status': 'ENABLED'|'DISABLED', 'AuthorizedTargets': [ 'string', ] } ) Parameters: * **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, view definitions, and other control information to manage your Lake Formation environment. * **ShareRecipients** (*list*) -- A list of Amazon Web Services account IDs or Amazon Web Services organization/organizational unit ARNs that are allowed to access to access data managed by Lake Formation. If the "ShareRecipients" list includes valid values, then the resource share is updated with the principals you want to have access to the resources. If the "ShareRecipients" value is null, both the list of share recipients and the resource share remain unchanged. If the "ShareRecipients" value is an empty list, then the existing share recipients list will be cleared, and the resource share will be deleted. * *(dict) --* The Lake Formation principal. Supported principals are IAM users or IAM roles. * **DataLakePrincipalIdentifier** *(string) --* An identifier for the Lake Formation principal. * **ApplicationStatus** (*string*) -- Allows to enable or disable the IAM Identity Center connection. * **ExternalFiltering** (*dict*) -- A list of the account IDs of Amazon Web Services accounts of third-party applications that are allowed to access data managed by Lake Formation. * **Status** *(string) --* **[REQUIRED]** Allows to enable or disable the third-party applications that are allowed to access data managed by Lake Formation. * **AuthorizedTargets** *(list) --* **[REQUIRED]** List of third-party application "ARNs" integrated with Lake Formation. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.AccessDeniedException" * "LakeFormation.Client.exceptions.ConcurrentModificationException" LakeFormation / Client / list_data_cells_filter list_data_cells_filter ********************** LakeFormation.Client.list_data_cells_filter(**kwargs) Lists all the data cell filters on a table. See also: AWS API Documentation **Request Syntax** response = client.list_data_cells_filter( Table={ 'CatalogId': 'string', 'DatabaseName': 'string', 'Name': 'string', 'TableWildcard': {} }, NextToken='string', MaxResults=123 ) Parameters: * **Table** (*dict*) -- A table in the Glue Data Catalog. * **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. * **NextToken** (*string*) -- A continuation token, if this is a continuation call. * **MaxResults** (*integer*) -- The maximum size of the response. Return type: dict Returns: **Response Syntax** { 'DataCellsFilters': [ { 'TableCatalogId': 'string', 'DatabaseName': 'string', 'TableName': 'string', 'Name': 'string', 'RowFilter': { 'FilterExpression': 'string', 'AllRowsWildcard': {} }, 'ColumnNames': [ 'string', ], 'ColumnWildcard': { 'ExcludedColumnNames': [ 'string', ] }, 'VersionId': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **DataCellsFilters** *(list) --* A list of "DataCellFilter" structures. * *(dict) --* A structure that describes certain columns on certain rows. * **TableCatalogId** *(string) --* The ID of the catalog to which the table belongs. * **DatabaseName** *(string) --* A database in the Glue Data Catalog. * **TableName** *(string) --* A table in the database. * **Name** *(string) --* The name given by the user to the data filter cell. * **RowFilter** *(dict) --* A PartiQL predicate. * **FilterExpression** *(string) --* A filter expression. * **AllRowsWildcard** *(dict) --* A wildcard for all rows. * **ColumnNames** *(list) --* A list of column names and/or nested column attributes. When specifying nested attributes, use a qualified dot (.) delimited format such as "address"."zip". Nested attributes within this list may not exceed a depth of 5. * *(string) --* * **ColumnWildcard** *(dict) --* A wildcard with exclusions. You must specify either a "ColumnNames" list or the "ColumnWildCard". * **ExcludedColumnNames** *(list) --* Excludes column names. Any column with this name will be excluded. * *(string) --* * **VersionId** *(string) --* The ID of the data cells filter version. * **NextToken** *(string) --* A continuation token, if not all requested data cell filters have been returned. **Exceptions** * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.AccessDeniedException" LakeFormation / Client / start_transaction start_transaction ***************** LakeFormation.Client.start_transaction(**kwargs) Starts a new transaction and returns its transaction ID. Transaction IDs are opaque objects that you can use to identify a transaction. See also: AWS API Documentation **Request Syntax** response = client.start_transaction( TransactionType='READ_AND_WRITE'|'READ_ONLY' ) Parameters: **TransactionType** (*string*) -- Indicates whether this transaction should be read only or read and write. Writes made using a read-only transaction ID will be rejected. Read-only transactions do not need to be committed. Return type: dict Returns: **Response Syntax** { 'TransactionId': 'string' } **Response Structure** * *(dict) --* * **TransactionId** *(string) --* An opaque identifier for the transaction. **Exceptions** * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" LakeFormation / Client / get_data_lake_settings get_data_lake_settings ********************** LakeFormation.Client.get_data_lake_settings(**kwargs) Retrieves the list of the data lake administrators of a Lake Formation-managed data lake. See also: AWS API Documentation **Request Syntax** response = client.get_data_lake_settings( CatalogId='string' ) Parameters: **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. Return type: dict Returns: **Response Syntax** { 'DataLakeSettings': { 'DataLakeAdmins': [ { 'DataLakePrincipalIdentifier': 'string' }, ], 'ReadOnlyAdmins': [ { 'DataLakePrincipalIdentifier': 'string' }, ], 'CreateDatabaseDefaultPermissions': [ { 'Principal': { 'DataLakePrincipalIdentifier': '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', ] }, ], 'CreateTableDefaultPermissions': [ { 'Principal': { 'DataLakePrincipalIdentifier': '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', ] }, ], 'Parameters': { 'string': 'string' }, 'TrustedResourceOwners': [ 'string', ], 'AllowExternalDataFiltering': True|False, 'AllowFullTableExternalDataAccess': True|False, 'ExternalDataFilteringAllowList': [ { 'DataLakePrincipalIdentifier': 'string' }, ], 'AuthorizedSessionTagValueList': [ 'string', ] } } **Response Structure** * *(dict) --* * **DataLakeSettings** *(dict) --* A structure representing a list of Lake Formation principals designated as data lake administrators. * **DataLakeAdmins** *(list) --* A list of Lake Formation principals. Supported principals are IAM users or IAM roles. * *(dict) --* The Lake Formation principal. Supported principals are IAM users or IAM roles. * **DataLakePrincipalIdentifier** *(string) --* An identifier for the Lake Formation principal. * **ReadOnlyAdmins** *(list) --* A list of Lake Formation principals with only view access to the resources, without the ability to make changes. Supported principals are IAM users or IAM roles. * *(dict) --* The Lake Formation principal. Supported principals are IAM users or IAM roles. * **DataLakePrincipalIdentifier** *(string) --* An identifier for the Lake Formation principal. * **CreateDatabaseDefaultPermissions** *(list) --* Specifies whether access control on newly created database is managed by Lake Formation permissions or exclusively by IAM permissions. A null value indicates access control by Lake Formation permissions. A value that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM permissions. This is referred to as the setting "Use only IAM access control," and is for backward compatibility with the Glue permission model implemented by IAM permissions. The only permitted values are an empty array or an array that contains a single JSON object that grants ALL to IAM_ALLOWED_PRINCIPALS. For more information, see Changing the Default Security Settings for Your Data Lake. * *(dict) --* Permissions granted to a principal. * **Principal** *(dict) --* The principal who is granted permissions. * **DataLakePrincipalIdentifier** *(string) --* An identifier for the Lake Formation principal. * **Permissions** *(list) --* The permissions that are granted to the principal. * *(string) --* * **CreateTableDefaultPermissions** *(list) --* Specifies whether access control on newly created table is managed by Lake Formation permissions or exclusively by IAM permissions. A null value indicates access control by Lake Formation permissions. A value that assigns ALL to IAM_ALLOWED_PRINCIPALS indicates access control by IAM permissions. This is referred to as the setting "Use only IAM access control," and is for backward compatibility with the Glue permission model implemented by IAM permissions. The only permitted values are an empty array or an array that contains a single JSON object that grants ALL to IAM_ALLOWED_PRINCIPALS. For more information, see Changing the Default Security Settings for Your Data Lake. * *(dict) --* Permissions granted to a principal. * **Principal** *(dict) --* The principal who is granted permissions. * **DataLakePrincipalIdentifier** *(string) --* An identifier for the Lake Formation principal. * **Permissions** *(list) --* The permissions that are granted to the principal. * *(string) --* * **Parameters** *(dict) --* A key-value map that provides an additional configuration on your data lake. CROSS_ACCOUNT_VERSION is the key you can configure in the Parameters field. Accepted values for the CrossAccountVersion key are 1, 2, 3, and 4. * *(string) --* * *(string) --* * **TrustedResourceOwners** *(list) --* A list of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs). The user ARNs can be logged in the resource owner's CloudTrail log. You may want to specify this property when you are in a high-trust boundary, such as the same team or company. * *(string) --* * **AllowExternalDataFiltering** *(boolean) --* Whether to allow Amazon EMR clusters to access data managed by Lake Formation. If true, you allow Amazon EMR clusters to access data in Amazon S3 locations that are registered with Lake Formation. If false or null, no Amazon EMR clusters will be able to access data in Amazon S3 locations that are registered with Lake Formation. For more information, see (Optional) Allow external data filtering. * **AllowFullTableExternalDataAccess** *(boolean) --* Whether to allow a third-party query engine to get data access credentials without session tags when a caller has full data access permissions. * **ExternalDataFilteringAllowList** *(list) --* A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.> * *(dict) --* The Lake Formation principal. Supported principals are IAM users or IAM roles. * **DataLakePrincipalIdentifier** *(string) --* An identifier for the Lake Formation principal. * **AuthorizedSessionTagValueList** *(list) --* Lake Formation relies on a privileged process secured by Amazon EMR or the third party integrator to tag the user's role while assuming it. Lake Formation will publish the acceptable key-value pair, for example key = "LakeFormationTrustedCaller" and value = "TRUE" and the third party integrator must properly tag the temporary security credentials that will be used to call Lake Formation's administrative APIs. * *(string) --* **Exceptions** * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.EntityNotFoundException" LakeFormation / Client / can_paginate can_paginate ************ LakeFormation.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. LakeFormation / Client / delete_lake_formation_identity_center_configuration delete_lake_formation_identity_center_configuration *************************************************** LakeFormation.Client.delete_lake_formation_identity_center_configuration(**kwargs) Deletes an IAM Identity Center connection with Lake Formation. See also: AWS API Documentation **Request Syntax** response = client.delete_lake_formation_identity_center_configuration( CatalogId='string' ) Parameters: **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, view definition, and other control information to manage your Lake Formation environment. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.AccessDeniedException" * "LakeFormation.Client.exceptions.ConcurrentModificationException" LakeFormation / Client / list_lf_tag_expressions list_lf_tag_expressions *********************** LakeFormation.Client.list_lf_tag_expressions(**kwargs) Returns the LF-Tag expressions in caller’s account filtered based on caller's permissions. Data Lake and read only admins implicitly can see all tag expressions in their account, else caller needs DESCRIBE permissions on tag expression. See also: AWS API Documentation **Request Syntax** response = client.list_lf_tag_expressions( CatalogId='string', MaxResults=123, NextToken='string' ) Parameters: * **CatalogId** (*string*) -- The identifier for the Data Catalog. By default, the account ID. * **MaxResults** (*integer*) -- The maximum number of results to return. * **NextToken** (*string*) -- A continuation token, if this is not the first call to retrieve this list. Return type: dict Returns: **Response Syntax** { 'LFTagExpressions': [ { 'Name': 'string', 'Description': 'string', 'CatalogId': 'string', 'Expression': [ { 'TagKey': 'string', 'TagValues': [ 'string', ] }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **LFTagExpressions** *(list) --* Logical expressions composed of one more LF-Tag key-value pairs. * *(dict) --* A structure consists LF-Tag expression name and catalog ID. * **Name** *(string) --* The name for saved the LF-Tag expression. * **Description** *(string) --* A structure that contains information about the LF-Tag expression. * **CatalogId** *(string) --* The identifier for the Data Catalog. By default, the account ID. * **Expression** *(list) --* A logical expression composed of one or more LF-Tags. * *(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) --* * **NextToken** *(string) --* A continuation token, if this is not the first call to retrieve this list. **Exceptions** * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.AccessDeniedException" LakeFormation / Client / list_lake_formation_opt_ins list_lake_formation_opt_ins *************************** LakeFormation.Client.list_lake_formation_opt_ins(**kwargs) Retrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions. See also: AWS API Documentation **Request Syntax** response = 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' } }, MaxResults=123, NextToken='string' ) Parameters: * **Principal** (*dict*) -- The Lake Formation principal. Supported principals are IAM users or IAM roles. * **DataLakePrincipalIdentifier** *(string) --* An identifier for the Lake Formation principal. * **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) --* **[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. * **MaxResults** (*integer*) -- The maximum number of results to return. * **NextToken** (*string*) -- A continuation token, if this is not the first call to retrieve this list. Return type: 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' } }, '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. * **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. **Exceptions** * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.AccessDeniedException" LakeFormation / Client / get_query_statistics get_query_statistics ******************** LakeFormation.Client.get_query_statistics(**kwargs) Retrieves statistics on the planning and execution of a query. See also: AWS API Documentation **Request Syntax** response = client.get_query_statistics( QueryId='string' ) Parameters: **QueryId** (*string*) -- **[REQUIRED]** The ID of the plan query operation. Return type: dict Returns: **Response Syntax** { 'ExecutionStatistics': { 'AverageExecutionTimeMillis': 123, 'DataScannedBytes': 123, 'WorkUnitsExecutedCount': 123 }, 'PlanningStatistics': { 'EstimatedDataToScanBytes': 123, 'PlanningTimeMillis': 123, 'QueueTimeMillis': 123, 'WorkUnitsGeneratedCount': 123 }, 'QuerySubmissionTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **ExecutionStatistics** *(dict) --* An "ExecutionStatistics" structure containing execution statistics. * **AverageExecutionTimeMillis** *(integer) --* The average time the request took to be executed. * **DataScannedBytes** *(integer) --* The amount of data that was scanned in bytes. * **WorkUnitsExecutedCount** *(integer) --* The number of work units executed. * **PlanningStatistics** *(dict) --* A "PlanningStatistics" structure containing query planning statistics. * **EstimatedDataToScanBytes** *(integer) --* An estimate of the data that was scanned in bytes. * **PlanningTimeMillis** *(integer) --* The time that it took to process the request. * **QueueTimeMillis** *(integer) --* The time the request was in queue to be processed. * **WorkUnitsGeneratedCount** *(integer) --* The number of work units generated. * **QuerySubmissionTime** *(datetime) --* The time that the query was submitted. **Exceptions** * "LakeFormation.Client.exceptions.StatisticsNotReadyYetException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.AccessDeniedException" * "LakeFormation.Client.exceptions.ExpiredException" * "LakeFormation.Client.exceptions.ThrottledException" LakeFormation / Client / extend_transaction extend_transaction ****************** LakeFormation.Client.extend_transaction(**kwargs) Indicates to the service that the specified transaction is still active and should not be treated as idle and aborted. Write transactions that remain idle for a long period are automatically aborted unless explicitly extended. See also: AWS API Documentation **Request Syntax** response = client.extend_transaction( TransactionId='string' ) Parameters: **TransactionId** (*string*) -- The transaction to extend. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.TransactionCommittedException" * "LakeFormation.Client.exceptions.TransactionCanceledException" * "LakeFormation.Client.exceptions.TransactionCommitInProgressExce ption" LakeFormation / Client / batch_revoke_permissions batch_revoke_permissions ************************ LakeFormation.Client.batch_revoke_permissions(**kwargs) Batch operation to revoke permissions from the principal. See also: AWS API Documentation **Request Syntax** response = 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' } }, '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', ] }, ] ) Parameters: * **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. * **Entries** (*list*) -- **[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. * **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) --* Return type: 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' } }, '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. * **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. **Exceptions** * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.OperationTimeoutException" LakeFormation / Client / remove_lf_tags_from_resource remove_lf_tags_from_resource **************************** LakeFormation.Client.remove_lf_tags_from_resource(**kwargs) 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** response = 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' } }, LFTags=[ { 'CatalogId': 'string', 'TagKey': 'string', 'TagValues': [ 'string', ] }, ] ) Parameters: * **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. * **Resource** (*dict*) -- **[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. * **LFTags** (*list*) -- **[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) --* Return type: 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. **Exceptions** * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.GlueEncryptionException" * "LakeFormation.Client.exceptions.AccessDeniedException" * "LakeFormation.Client.exceptions.ConcurrentModificationException" LakeFormation / Client / get_resource_lf_tags get_resource_lf_tags ******************** LakeFormation.Client.get_resource_lf_tags(**kwargs) Returns the LF-tags applied to a resource. See also: AWS API Documentation **Request Syntax** response = 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' } }, ShowAssignedLFTags=True|False ) Parameters: * **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. * **Resource** (*dict*) -- **[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. * **ShowAssignedLFTags** (*boolean*) -- Indicates whether to show the assigned LF-tags. Return type: 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) --* **Exceptions** * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.GlueEncryptionException" * "LakeFormation.Client.exceptions.AccessDeniedException" LakeFormation / Client / get_work_units get_work_units ************** LakeFormation.Client.get_work_units(**kwargs) Retrieves the work units generated by the "StartQueryPlanning" operation. See also: AWS API Documentation **Request Syntax** response = client.get_work_units( NextToken='string', PageSize=123, QueryId='string' ) Parameters: * **NextToken** (*string*) -- A continuation token, if this is a continuation call. * **PageSize** (*integer*) -- The size of each page to get in the Amazon Web Services service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the Amazon Web Services service, retrieving fewer items in each call. This can help prevent the Amazon Web Services service calls from timing out. * **QueryId** (*string*) -- **[REQUIRED]** The ID of the plan query operation. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'QueryId': 'string', 'WorkUnitRanges': [ { 'WorkUnitIdMax': 123, 'WorkUnitIdMin': 123, 'WorkUnitToken': 'string' }, ] } **Response Structure** * *(dict) --* A structure for the output. * **NextToken** *(string) --* A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last. * **QueryId** *(string) --* The ID of the plan query operation. * **WorkUnitRanges** *(list) --* A "WorkUnitRangeList" object that specifies the valid range of work unit IDs for querying the execution service. * *(dict) --* Defines the valid range of work unit IDs for querying the execution service. * **WorkUnitIdMax** *(integer) --* Defines the maximum work unit ID in the range. The maximum value is inclusive. * **WorkUnitIdMin** *(integer) --* Defines the minimum work unit ID in the range. * **WorkUnitToken** *(string) --* A work token used to query the execution service. **Exceptions** * "LakeFormation.Client.exceptions.WorkUnitsNotReadyYetException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.AccessDeniedException" * "LakeFormation.Client.exceptions.ExpiredException" LakeFormation / Client / update_lf_tag update_lf_tag ************* LakeFormation.Client.update_lf_tag(**kwargs) Updates the list of possible values for the specified LF-tag key. If the LF-tag does not exist, the operation throws an EntityNotFoundException. The values in the delete key values will be deleted from list of possible values. If any value in the delete key values is attached to a resource, then API errors out with a 400 Exception - "Update not allowed". Untag the attribute before deleting the LF-tag key's value. See also: AWS API Documentation **Request Syntax** response = client.update_lf_tag( CatalogId='string', TagKey='string', TagValuesToDelete=[ 'string', ], TagValuesToAdd=[ 'string', ] ) Parameters: * **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 for which to add or delete values. * **TagValuesToDelete** (*list*) -- A list of LF-tag values to delete from the LF-tag. * *(string) --* * **TagValuesToAdd** (*list*) -- A list of LF-tag values to add from the LF-tag. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.ConcurrentModificationException" * "LakeFormation.Client.exceptions.AccessDeniedException" LakeFormation / Client / create_lf_tag_expression create_lf_tag_expression ************************ LakeFormation.Client.create_lf_tag_expression(**kwargs) Creates a new LF-Tag expression with the provided name, description, catalog ID, and expression body. This call fails if a LF-Tag expression with the same name already exists in the caller’s account or if the underlying LF-Tags don't exist. To call this API operation, caller needs the following Lake Formation permissions: "CREATE_LF_TAG_EXPRESSION" on the root catalog resource. "GRANT_WITH_LF_TAG_EXPRESSION" on all underlying LF-Tag key:value pairs included in the expression. See also: AWS API Documentation **Request Syntax** response = client.create_lf_tag_expression( Name='string', Description='string', CatalogId='string', Expression=[ { 'TagKey': 'string', 'TagValues': [ 'string', ] }, ] ) Parameters: * **Name** (*string*) -- **[REQUIRED]** A name for the expression. * **Description** (*string*) -- A description with information about the LF-Tag expression. * **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. * **Expression** (*list*) -- **[REQUIRED]** A list of LF-Tag conditions (key-value pairs). * *(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) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.ResourceNumberLimitExceededExce ption" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.AccessDeniedException" * "LakeFormation.Client.exceptions.EntityNotFoundException" LakeFormation / Client / create_data_cells_filter create_data_cells_filter ************************ LakeFormation.Client.create_data_cells_filter(**kwargs) Creates a data cell filter to allow one to grant access to certain columns on certain rows. See also: AWS API Documentation **Request Syntax** response = client.create_data_cells_filter( TableData={ 'TableCatalogId': 'string', 'DatabaseName': 'string', 'TableName': 'string', 'Name': 'string', 'RowFilter': { 'FilterExpression': 'string', 'AllRowsWildcard': {} }, 'ColumnNames': [ 'string', ], 'ColumnWildcard': { 'ExcludedColumnNames': [ 'string', ] }, 'VersionId': 'string' } ) Parameters: **TableData** (*dict*) -- **[REQUIRED]** A "DataCellsFilter" structure containing information about the data cells filter. * **TableCatalogId** *(string) --* **[REQUIRED]** The ID of the catalog to which the table belongs. * **DatabaseName** *(string) --* **[REQUIRED]** A database in the Glue Data Catalog. * **TableName** *(string) --* **[REQUIRED]** A table in the database. * **Name** *(string) --* **[REQUIRED]** The name given by the user to the data filter cell. * **RowFilter** *(dict) --* A PartiQL predicate. * **FilterExpression** *(string) --* A filter expression. * **AllRowsWildcard** *(dict) --* A wildcard for all rows. * **ColumnNames** *(list) --* A list of column names and/or nested column attributes. When specifying nested attributes, use a qualified dot (.) delimited format such as "address"."zip". Nested attributes within this list may not exceed a depth of 5. * *(string) --* * **ColumnWildcard** *(dict) --* A wildcard with exclusions. You must specify either a "ColumnNames" list or the "ColumnWildCard". * **ExcludedColumnNames** *(list) --* Excludes column names. Any column with this name will be excluded. * *(string) --* * **VersionId** *(string) --* The ID of the data cells filter version. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "LakeFormation.Client.exceptions.AlreadyExistsException" * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.ResourceNumberLimitExceededExce ption" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.AccessDeniedException" LakeFormation / Client / search_databases_by_lf_tags search_databases_by_lf_tags *************************** LakeFormation.Client.search_databases_by_lf_tags(**kwargs) This operation allows a search on "DATABASE" resources by "TagCondition". This operation is used by admins who want to grant user permissions on certain "TagConditions". Before making a grant, the admin can use "SearchDatabasesByTags" to find all resources where the given "TagConditions" are valid to verify whether the returned resources can be shared. See also: AWS API Documentation **Request Syntax** response = client.search_databases_by_lf_tags( NextToken='string', MaxResults=123, CatalogId='string', Expression=[ { 'TagKey': 'string', 'TagValues': [ 'string', ] }, ] ) Parameters: * **NextToken** (*string*) -- A continuation token, if this is not the first call to retrieve this list. * **MaxResults** (*integer*) -- The maximum number of results to return. * **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. * **Expression** (*list*) -- **[REQUIRED]** A list of conditions ( "LFTag" structures) to search for in database resources. * *(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) --* Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'DatabaseList': [ { 'Database': { 'CatalogId': 'string', 'Name': 'string' }, 'LFTags': [ { 'CatalogId': 'string', 'TagKey': 'string', 'TagValues': [ 'string', ] }, ] }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* A continuation token, present if the current list segment is not the last. * **DatabaseList** *(list) --* A list of databases that meet the LF-tag conditions. * *(dict) --* A structure describing a database resource with LF-tags. * **Database** *(dict) --* A database that has LF-tags attached to it. * **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. * **LFTags** *(list) --* A list of LF-tags attached to the database. * *(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) --* **Exceptions** * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.GlueEncryptionException" * "LakeFormation.Client.exceptions.AccessDeniedException" LakeFormation / Client / assume_decorated_role_with_saml assume_decorated_role_with_saml ******************************* LakeFormation.Client.assume_decorated_role_with_saml(**kwargs) Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML assertion included in the request. This decoration allows Lake Formation to enforce access policies against the SAML users and groups. This API operation requires SAML federation setup in the caller’s account as it can only be called with valid SAML assertions. Lake Formation does not scope down the permission of the assumed role. All permissions attached to the role via the SAML federation setup will be included in the role session. This decorated role is expected to access data in Amazon S3 by getting temporary access from Lake Formation which is authorized via the virtual API "GetDataAccess". Therefore, all SAML roles that can be assumed via "AssumeDecoratedRoleWithSAML" must at a minimum include "lakeformation:GetDataAccess" in their role policies. A typical IAM policy attached to such a role would look as follows: See also: AWS API Documentation **Request Syntax** response = client.assume_decorated_role_with_saml( SAMLAssertion='string', RoleArn='string', PrincipalArn='string', DurationSeconds=123 ) Parameters: * **SAMLAssertion** (*string*) -- **[REQUIRED]** A SAML assertion consisting of an assertion statement for the user who needs temporary credentials. This must match the SAML assertion that was issued to IAM. This must be Base64 encoded. * **RoleArn** (*string*) -- **[REQUIRED]** The role that represents an IAM principal whose scope down policy allows it to call credential vending APIs such as "GetTemporaryTableCredentials". The caller must also have iam:PassRole permission on this role. * **PrincipalArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP. * **DurationSeconds** (*integer*) -- The time period, between 900 and 43,200 seconds, for the timeout of the temporary credentials. Return type: dict Returns: **Response Syntax** { 'AccessKeyId': 'string', 'SecretAccessKey': 'string', 'SessionToken': 'string', 'Expiration': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **AccessKeyId** *(string) --* The access key ID for the temporary credentials. (The access key consists of an access key ID and a secret key). * **SecretAccessKey** *(string) --* The secret key for the temporary credentials. (The access key consists of an access key ID and a secret key). * **SessionToken** *(string) --* The session token for the temporary credentials. * **Expiration** *(datetime) --* The date and time when the temporary credentials expire. **Exceptions** * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.AccessDeniedException" LakeFormation / Client / register_resource register_resource ***************** LakeFormation.Client.register_resource(**kwargs) Registers the resource as managed by the Data Catalog. To add or update data, Lake Formation needs read/write access to the chosen data location. 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** response = client.register_resource( ResourceArn='string', UseServiceLinkedRole=True|False, RoleArn='string', WithFederation=True|False, HybridAccessEnabled=True|False, WithPrivilegedAccess=True|False ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource that you want to register. * **UseServiceLinkedRole** (*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. * **RoleArn** (*string*) -- The identifier for the role that registers the resource. * **WithFederation** (*boolean*) -- Whether or not the resource is a federated resource. * **HybridAccessEnabled** (*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. * **WithPrivilegedAccess** (*boolean*) -- Grants the calling principal the permissions to perform all supported Lake Formation operations on the registered data location. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.AlreadyExistsException" * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.ResourceNumberLimitExceededExce ption" * "LakeFormation.Client.exceptions.AccessDeniedException" LakeFormation / Client / create_lf_tag create_lf_tag ************* LakeFormation.Client.create_lf_tag(**kwargs) Creates an LF-tag with the specified name and values. See also: AWS API Documentation **Request Syntax** response = client.create_lf_tag( CatalogId='string', TagKey='string', TagValues=[ 'string', ] ) Parameters: * **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) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.ResourceNumberLimitExceededExce ption" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.AccessDeniedException" LakeFormation / Client / get_waiter get_waiter ********** LakeFormation.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" LakeFormation / Client / list_resources list_resources ************** LakeFormation.Client.list_resources(**kwargs) Lists the resources registered to be managed by the Data Catalog. See also: AWS API Documentation **Request Syntax** response = 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' ) Parameters: * **FilterConditionList** (*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) --* * **MaxResults** (*integer*) -- The maximum number of resource results. * **NextToken** (*string*) -- A continuation token, if this is not the first call to retrieve these resources. Return type: dict Returns: **Response Syntax** { 'ResourceInfoList': [ { 'ResourceArn': 'string', 'RoleArn': 'string', 'LastModified': datetime(2015, 1, 1), 'WithFederation': True|False, 'HybridAccessEnabled': True|False, 'WithPrivilegedAccess': 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. * **WithPrivilegedAccess** *(boolean) --* Grants the calling principal the permissions to perform all supported Lake Formation operations on the registered data location. * **NextToken** *(string) --* A continuation token, if this is not the first call to retrieve these resources. **Exceptions** * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" LakeFormation / Client / delete_lf_tag delete_lf_tag ************* LakeFormation.Client.delete_lf_tag(**kwargs) Deletes the specified LF-tag given a key name. If the input parameter tag key was not found, then the operation will throw an exception. When you delete an LF-tag, the "LFTagPolicy" attached to the LF-tag becomes invalid. If the deleted LF-tag was still assigned to any resource, the tag policy attach to the deleted LF- tag will no longer be applied to the resource. See also: AWS API Documentation **Request Syntax** response = client.delete_lf_tag( CatalogId='string', TagKey='string' ) Parameters: * **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 to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.AccessDeniedException" LakeFormation / Client / get_temporary_glue_table_credentials get_temporary_glue_table_credentials ************************************ LakeFormation.Client.get_temporary_glue_table_credentials(**kwargs) Allows a caller in a secure environment to assume a role with permission to access Amazon S3. In order to vend such credentials, Lake Formation assumes the role associated with a registered location, for example an Amazon S3 bucket, with a scope down policy which restricts the access to a single prefix. To call this API, the role that the service assumes must have "lakeformation:GetDataAccess" permission on the resource. See also: AWS API Documentation **Request Syntax** response = client.get_temporary_glue_table_credentials( TableArn='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', ], DurationSeconds=123, AuditContext={ 'AdditionalAuditContext': 'string' }, SupportedPermissionTypes=[ 'COLUMN_PERMISSION'|'CELL_FILTER_PERMISSION'|'NESTED_PERMISSION'|'NESTED_CELL_PERMISSION', ], S3Path='string', QuerySessionContext={ 'QueryId': 'string', 'QueryStartTime': datetime(2015, 1, 1), 'ClusterId': 'string', 'QueryAuthorizationId': 'string', 'AdditionalContext': { 'string': 'string' } } ) Parameters: * **TableArn** (*string*) -- **[REQUIRED]** The ARN identifying a table in the Data Catalog for the temporary credentials request. * **Permissions** (*list*) -- Filters the request based on the user having been granted a list of specified permissions on the requested resource(s). * *(string) --* * **DurationSeconds** (*integer*) -- The time period, between 900 and 21,600 seconds, for the timeout of the temporary credentials. * **AuditContext** (*dict*) -- A structure representing context to access a resource (column names, query ID, etc). * **AdditionalAuditContext** *(string) --* The filter engine can populate the 'AdditionalAuditContext' information with the request ID for you to track. This information will be displayed in CloudTrail log in your account. * **SupportedPermissionTypes** (*list*) -- A list of supported permission types for the table. Valid values are "COLUMN_PERMISSION" and "CELL_FILTER_PERMISSION". * *(string) --* * **S3Path** (*string*) -- The Amazon S3 path for the table. * **QuerySessionContext** (*dict*) -- A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request's authorization context. * **QueryId** *(string) --* A unique identifier generated by the query engine for the query. * **QueryStartTime** *(datetime) --* A timestamp provided by the query engine for when the query started. * **ClusterId** *(string) --* An identifier string for the consumer cluster. * **QueryAuthorizationId** *(string) --* A cryptographically generated query identifier generated by Glue or Lake Formation. * **AdditionalContext** *(dict) --* An opaque string-string map passed by the query engine. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'AccessKeyId': 'string', 'SecretAccessKey': 'string', 'SessionToken': 'string', 'Expiration': datetime(2015, 1, 1), 'VendedS3Path': [ 'string', ] } **Response Structure** * *(dict) --* * **AccessKeyId** *(string) --* The access key ID for the temporary credentials. * **SecretAccessKey** *(string) --* The secret key for the temporary credentials. * **SessionToken** *(string) --* The session token for the temporary credentials. * **Expiration** *(datetime) --* The date and time when the temporary credentials expire. * **VendedS3Path** *(list) --* The Amazon S3 path for the temporary credentials. * *(string) --* **Exceptions** * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.AccessDeniedException" * "LakeFormation.Client.exceptions.PermissionTypeMismatchException" LakeFormation / Client / update_resource update_resource *************** LakeFormation.Client.update_resource(**kwargs) Updates the data access role used for vending access to the given (registered) resource in Lake Formation. See also: AWS API Documentation **Request Syntax** response = client.update_resource( RoleArn='string', ResourceArn='string', WithFederation=True|False, HybridAccessEnabled=True|False ) Parameters: * **RoleArn** (*string*) -- **[REQUIRED]** The new role to use for the given resource registered in Lake Formation. * **ResourceArn** (*string*) -- **[REQUIRED]** The resource ARN. * **WithFederation** (*boolean*) -- Whether or not the resource is a federated resource. * **HybridAccessEnabled** (*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. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.EntityNotFoundException" LakeFormation / Client / describe_resource describe_resource ***************** LakeFormation.Client.describe_resource(**kwargs) Retrieves the current data access role for the given resource registered in Lake Formation. See also: AWS API Documentation **Request Syntax** response = client.describe_resource( ResourceArn='string' ) Parameters: **ResourceArn** (*string*) -- **[REQUIRED]** The resource ARN. Return type: dict Returns: **Response Syntax** { 'ResourceInfo': { 'ResourceArn': 'string', 'RoleArn': 'string', 'LastModified': datetime(2015, 1, 1), 'WithFederation': True|False, 'HybridAccessEnabled': True|False, 'WithPrivilegedAccess': 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. * **WithPrivilegedAccess** *(boolean) --* Grants the calling principal the permissions to perform all supported Lake Formation operations on the registered data location. **Exceptions** * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.EntityNotFoundException" LakeFormation / Client / get_temporary_glue_partition_credentials get_temporary_glue_partition_credentials **************************************** LakeFormation.Client.get_temporary_glue_partition_credentials(**kwargs) This API is identical to "GetTemporaryTableCredentials" except that this is used when the target Data Catalog resource is of type Partition. Lake Formation restricts the permission of the vended credentials with the same scope down policy which restricts access to a single Amazon S3 prefix. See also: AWS API Documentation **Request Syntax** response = client.get_temporary_glue_partition_credentials( TableArn='string', Partition={ 'Values': [ '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', ], DurationSeconds=123, AuditContext={ 'AdditionalAuditContext': 'string' }, SupportedPermissionTypes=[ 'COLUMN_PERMISSION'|'CELL_FILTER_PERMISSION'|'NESTED_PERMISSION'|'NESTED_CELL_PERMISSION', ] ) Parameters: * **TableArn** (*string*) -- **[REQUIRED]** The ARN of the partitions' table. * **Partition** (*dict*) -- **[REQUIRED]** A list of partition values identifying a single partition. * **Values** *(list) --* **[REQUIRED]** The list of partition values. * *(string) --* * **Permissions** (*list*) -- Filters the request based on the user having been granted a list of specified permissions on the requested resource(s). * *(string) --* * **DurationSeconds** (*integer*) -- The time period, between 900 and 21,600 seconds, for the timeout of the temporary credentials. * **AuditContext** (*dict*) -- A structure representing context to access a resource (column names, query ID, etc). * **AdditionalAuditContext** *(string) --* The filter engine can populate the 'AdditionalAuditContext' information with the request ID for you to track. This information will be displayed in CloudTrail log in your account. * **SupportedPermissionTypes** (*list*) -- A list of supported permission types for the partition. Valid values are "COLUMN_PERMISSION" and "CELL_FILTER_PERMISSION". * *(string) --* Return type: dict Returns: **Response Syntax** { 'AccessKeyId': 'string', 'SecretAccessKey': 'string', 'SessionToken': 'string', 'Expiration': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **AccessKeyId** *(string) --* The access key ID for the temporary credentials. * **SecretAccessKey** *(string) --* The secret key for the temporary credentials. * **SessionToken** *(string) --* The session token for the temporary credentials. * **Expiration** *(datetime) --* The date and time when the temporary credentials expire. **Exceptions** * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.AccessDeniedException" * "LakeFormation.Client.exceptions.PermissionTypeMismatchException" LakeFormation / Client / revoke_permissions revoke_permissions ****************** LakeFormation.Client.revoke_permissions(**kwargs) 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** response = 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' } }, 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', ] ) Parameters: * **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. * **Principal** (*dict*) -- **[REQUIRED]** The principal to be revoked permissions on the resource. * **DataLakePrincipalIdentifier** *(string) --* An identifier for the Lake Formation principal. * **Resource** (*dict*) -- **[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. * **Permissions** (*list*) -- **[REQUIRED]** The permissions revoked to the principal on the resource. For information about permissions, see Security and Access Control to Metadata and Data. * *(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 a list of permissions for which to revoke the grant option allowing the principal to pass permissions to other principals. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "LakeFormation.Client.exceptions.ConcurrentModificationException" * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.InvalidInputException" LakeFormation / Client / batch_grant_permissions batch_grant_permissions *********************** LakeFormation.Client.batch_grant_permissions(**kwargs) Batch operation to grant permissions to the principal. See also: AWS API Documentation **Request Syntax** response = 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' } }, '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', ] }, ] ) Parameters: * **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. * **Entries** (*list*) -- **[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. * **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) --* Return type: 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' } }, '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. * **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. **Exceptions** * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.OperationTimeoutException" LakeFormation / Client / get_data_lake_principal get_data_lake_principal *********************** LakeFormation.Client.get_data_lake_principal() Returns the identity of the invoking principal. See also: AWS API Documentation **Request Syntax** response = client.get_data_lake_principal() Return type: dict Returns: **Response Syntax** { 'Identity': 'string' } **Response Structure** * *(dict) --* * **Identity** *(string) --* A unique identifier of the invoking principal. **Exceptions** * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.AccessDeniedException" LakeFormation / Client / update_table_objects update_table_objects ******************** LakeFormation.Client.update_table_objects(**kwargs) Updates the manifest of Amazon S3 objects that make up the specified governed table. See also: AWS API Documentation **Request Syntax** response = client.update_table_objects( CatalogId='string', DatabaseName='string', TableName='string', TransactionId='string', WriteOperations=[ { 'AddObject': { 'Uri': 'string', 'ETag': 'string', 'Size': 123, 'PartitionValues': [ 'string', ] }, 'DeleteObject': { 'Uri': 'string', 'ETag': 'string', 'PartitionValues': [ 'string', ] } }, ] ) Parameters: * **CatalogId** (*string*) -- The catalog containing the governed table to update. Defaults to the caller’s account ID. * **DatabaseName** (*string*) -- **[REQUIRED]** The database containing the governed table to update. * **TableName** (*string*) -- **[REQUIRED]** The governed table to update. * **TransactionId** (*string*) -- The transaction at which to do the write. * **WriteOperations** (*list*) -- **[REQUIRED]** A list of "WriteOperation" objects that define an object to add to or delete from the manifest for a governed table. * *(dict) --* Defines an object to add to or delete from a governed table. * **AddObject** *(dict) --* A new object to add to the governed table. * **Uri** *(string) --* **[REQUIRED]** The Amazon S3 location of the object. * **ETag** *(string) --* **[REQUIRED]** The Amazon S3 ETag of the object. Returned by "GetTableObjects" for validation and used to identify changes to the underlying data. * **Size** *(integer) --* **[REQUIRED]** The size of the Amazon S3 object in bytes. * **PartitionValues** *(list) --* A list of partition values for the object. A value must be specified for each partition key associated with the table. The supported data types are integer, long, date(yyyy- MM-dd), timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd HH:mm:ss"), string and decimal. * *(string) --* * **DeleteObject** *(dict) --* An object to delete from the governed table. * **Uri** *(string) --* **[REQUIRED]** The Amazon S3 location of the object to delete. * **ETag** *(string) --* The Amazon S3 ETag of the object. Returned by "GetTableObjects" for validation and used to identify changes to the underlying data. * **PartitionValues** *(list) --* A list of partition values for the object. A value must be specified for each partition key associated with the governed table. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.TransactionCommittedException" * "LakeFormation.Client.exceptions.TransactionCanceledException" * "LakeFormation.Client.exceptions.TransactionCommitInProgressExce ption" * "LakeFormation.Client.exceptions.ResourceNotReadyException" * "LakeFormation.Client.exceptions.ConcurrentModificationException" LakeFormation / Client / start_query_planning start_query_planning ******************** LakeFormation.Client.start_query_planning(**kwargs) Submits a request to process a query statement. This operation generates work units that can be retrieved with the "GetWorkUnits" operation as soon as the query state is WORKUNITS_AVAILABLE or FINISHED. See also: AWS API Documentation **Request Syntax** response = client.start_query_planning( QueryPlanningContext={ 'CatalogId': 'string', 'DatabaseName': 'string', 'QueryAsOfTime': datetime(2015, 1, 1), 'QueryParameters': { 'string': 'string' }, 'TransactionId': 'string' }, QueryString='string' ) Parameters: * **QueryPlanningContext** (*dict*) -- **[REQUIRED]** A structure containing information about the query plan. * **CatalogId** *(string) --* The ID of the Data Catalog where the partition in question resides. If none is provided, the Amazon Web Services account ID is used by default. * **DatabaseName** *(string) --* **[REQUIRED]** The database containing the table. * **QueryAsOfTime** *(datetime) --* The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with "TransactionId". * **QueryParameters** *(dict) --* A map consisting of key-value pairs. * *(string) --* * *(string) --* * **TransactionId** *(string) --* The transaction ID at which to read the table contents. If this transaction is not committed, the read will be treated as part of that transaction and will see its writes. If this transaction has aborted, an error will be returned. If not set, defaults to the most recent committed transaction. Cannot be specified along with "QueryAsOfTime". * **QueryString** (*string*) -- **[REQUIRED]** A PartiQL query statement used as an input to the planner service. Return type: dict Returns: **Response Syntax** { 'QueryId': 'string' } **Response Structure** * *(dict) --* A structure for the output. * **QueryId** *(string) --* The ID of the plan query operation can be used to fetch the actual work unit descriptors that are produced as the result of the operation. The ID is also used to get the query state and as an input to the "Execute" operation. **Exceptions** * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.AccessDeniedException" * "LakeFormation.Client.exceptions.ThrottledException" LakeFormation / Client / delete_lf_tag_expression delete_lf_tag_expression ************************ LakeFormation.Client.delete_lf_tag_expression(**kwargs) Deletes the LF-Tag expression. The caller must be a data lake admin or have "DROP" permissions on the LF-Tag expression. Deleting a LF- Tag expression will also delete all "LFTagPolicy" permissions referencing the LF-Tag expression. See also: AWS API Documentation **Request Syntax** response = client.delete_lf_tag_expression( Name='string', CatalogId='string' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name for the LF-Tag expression. * **CatalogId** (*string*) -- The identifier for the Data Catalog. By default, the account ID in which the LF-Tag expression is saved. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.AccessDeniedException" LakeFormation / Client / delete_data_cells_filter delete_data_cells_filter ************************ LakeFormation.Client.delete_data_cells_filter(**kwargs) Deletes a data cell filter. See also: AWS API Documentation **Request Syntax** response = client.delete_data_cells_filter( TableCatalogId='string', DatabaseName='string', TableName='string', Name='string' ) Parameters: * **TableCatalogId** (*string*) -- The ID of the catalog to which the table belongs. * **DatabaseName** (*string*) -- A database in the Glue Data Catalog. * **TableName** (*string*) -- A table in the database. * **Name** (*string*) -- The name given by the user to the data filter cell. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.AccessDeniedException" LakeFormation / Client / create_lake_formation_opt_in create_lake_formation_opt_in **************************** LakeFormation.Client.create_lake_formation_opt_in(**kwargs) Enforce Lake Formation permissions for the given databases, tables, and principals. See also: AWS API Documentation **Request Syntax** response = 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' } }, Condition={ 'Expression': 'string' } ) Parameters: * **Principal** (*dict*) -- **[REQUIRED]** The Lake Formation principal. Supported principals are IAM users or IAM roles. * **DataLakePrincipalIdentifier** *(string) --* An identifier for the Lake Formation principal. * **Resource** (*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. * **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. * **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. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.AccessDeniedException" * "LakeFormation.Client.exceptions.ConcurrentModificationException" * "LakeFormation.Client.exceptions.ResourceNumberLimitExceededExce ption" LakeFormation / Client / close close ***** LakeFormation.Client.close() Closes underlying endpoint connections. LakeFormation / Client / get_lf_tag_expression get_lf_tag_expression ********************* LakeFormation.Client.get_lf_tag_expression(**kwargs) Returns the details about the LF-Tag expression. The caller must be a data lake admin or must have "DESCRIBE" permission on the LF-Tag expression resource. See also: AWS API Documentation **Request Syntax** response = client.get_lf_tag_expression( Name='string', CatalogId='string' ) Parameters: * **Name** (*string*) -- **[REQUIRED]** The name for the LF-Tag expression * **CatalogId** (*string*) -- The identifier for the Data Catalog. By default, the account ID. Return type: dict Returns: **Response Syntax** { 'Name': 'string', 'Description': 'string', 'CatalogId': 'string', 'Expression': [ { 'TagKey': 'string', 'TagValues': [ 'string', ] }, ] } **Response Structure** * *(dict) --* * **Name** *(string) --* The name for the LF-Tag expression. * **Description** *(string) --* The description with information about the LF-Tag expression. * **CatalogId** *(string) --* The identifier for the Data Catalog. By default, the account ID in which the LF-Tag expression is saved. * **Expression** *(list) --* The body of the LF-Tag expression. It is composed of one or more LF-Tag key-value pairs. * *(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) --* **Exceptions** * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.AccessDeniedException" LakeFormation / Client / get_data_cells_filter get_data_cells_filter ********************* LakeFormation.Client.get_data_cells_filter(**kwargs) Returns a data cells filter. See also: AWS API Documentation **Request Syntax** response = client.get_data_cells_filter( TableCatalogId='string', DatabaseName='string', TableName='string', Name='string' ) Parameters: * **TableCatalogId** (*string*) -- **[REQUIRED]** The ID of the catalog to which the table belongs. * **DatabaseName** (*string*) -- **[REQUIRED]** A database in the Glue Data Catalog. * **TableName** (*string*) -- **[REQUIRED]** A table in the database. * **Name** (*string*) -- **[REQUIRED]** The name given by the user to the data filter cell. Return type: dict Returns: **Response Syntax** { 'DataCellsFilter': { 'TableCatalogId': 'string', 'DatabaseName': 'string', 'TableName': 'string', 'Name': 'string', 'RowFilter': { 'FilterExpression': 'string', 'AllRowsWildcard': {} }, 'ColumnNames': [ 'string', ], 'ColumnWildcard': { 'ExcludedColumnNames': [ 'string', ] }, 'VersionId': 'string' } } **Response Structure** * *(dict) --* * **DataCellsFilter** *(dict) --* A structure that describes certain columns on certain rows. * **TableCatalogId** *(string) --* The ID of the catalog to which the table belongs. * **DatabaseName** *(string) --* A database in the Glue Data Catalog. * **TableName** *(string) --* A table in the database. * **Name** *(string) --* The name given by the user to the data filter cell. * **RowFilter** *(dict) --* A PartiQL predicate. * **FilterExpression** *(string) --* A filter expression. * **AllRowsWildcard** *(dict) --* A wildcard for all rows. * **ColumnNames** *(list) --* A list of column names and/or nested column attributes. When specifying nested attributes, use a qualified dot (.) delimited format such as "address"."zip". Nested attributes within this list may not exceed a depth of 5. * *(string) --* * **ColumnWildcard** *(dict) --* A wildcard with exclusions. You must specify either a "ColumnNames" list or the "ColumnWildCard". * **ExcludedColumnNames** *(list) --* Excludes column names. Any column with this name will be excluded. * *(string) --* * **VersionId** *(string) --* The ID of the data cells filter version. **Exceptions** * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.AccessDeniedException" LakeFormation / Client / search_tables_by_lf_tags search_tables_by_lf_tags ************************ LakeFormation.Client.search_tables_by_lf_tags(**kwargs) This operation allows a search on "TABLE" resources by "LFTag``s. This will be used by admins who want to grant user permissions on certain LF-tags. Before making a grant, the admin can use ``SearchTablesByLFTags" to find all resources where the given >>``<, <, >=, <= * The logical operators supported are: AND * The data types supported are integer, long, date(yyyy-MM- dd), timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd HH:mm:ss"), string and decimal. * **MaxResults** (*integer*) -- Specifies how many values to return in a page. * **NextToken** (*string*) -- A continuation token if this is not the first call to retrieve these objects. Return type: dict Returns: **Response Syntax** { 'Objects': [ { 'PartitionValues': [ 'string', ], 'Objects': [ { 'Uri': 'string', 'ETag': 'string', 'Size': 123 }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Objects** *(list) --* A list of objects organized by partition keys. * *(dict) --* A structure containing a list of partition values and table objects. * **PartitionValues** *(list) --* A list of partition values. * *(string) --* * **Objects** *(list) --* A list of table objects * *(dict) --* Specifies the details of a governed table. * **Uri** *(string) --* The Amazon S3 location of the object. * **ETag** *(string) --* The Amazon S3 ETag of the object. Returned by "GetTableObjects" for validation and used to identify changes to the underlying data. * **Size** *(integer) --* The size of the Amazon S3 object in bytes. * **NextToken** *(string) --* A continuation token indicating whether additional data is available. **Exceptions** * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.TransactionCommittedException" * "LakeFormation.Client.exceptions.TransactionCanceledException" * "LakeFormation.Client.exceptions.ResourceNotReadyException" LakeFormation / Client / delete_objects_on_cancel delete_objects_on_cancel ************************ LakeFormation.Client.delete_objects_on_cancel(**kwargs) For a specific governed table, provides a list of Amazon S3 objects that will be written during the current transaction and that can be automatically deleted if the transaction is canceled. Without this call, no Amazon S3 objects are automatically deleted when a transaction cancels. The Glue ETL library function "write_dynamic_frame.from_catalog()" includes an option to automatically call "DeleteObjectsOnCancel" before writes. For more information, see Rolling Back Amazon S3 Writes. See also: AWS API Documentation **Request Syntax** response = client.delete_objects_on_cancel( CatalogId='string', DatabaseName='string', TableName='string', TransactionId='string', Objects=[ { 'Uri': 'string', 'ETag': 'string' }, ] ) Parameters: * **CatalogId** (*string*) -- The Glue data catalog that contains the governed table. Defaults to the current account ID. * **DatabaseName** (*string*) -- **[REQUIRED]** The database that contains the governed table. * **TableName** (*string*) -- **[REQUIRED]** The name of the governed table. * **TransactionId** (*string*) -- **[REQUIRED]** ID of the transaction that the writes occur in. * **Objects** (*list*) -- **[REQUIRED]** A list of VirtualObject structures, which indicates the Amazon S3 objects to be deleted if the transaction cancels. * *(dict) --* An object that defines an Amazon S3 object to be deleted if a transaction cancels, provided that "VirtualPut" was called before writing the object. * **Uri** *(string) --* **[REQUIRED]** The path to the Amazon S3 object. Must start with s3:// * **ETag** *(string) --* The ETag of the Amazon S3 object. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "LakeFormation.Client.exceptions.InternalServiceException" * "LakeFormation.Client.exceptions.InvalidInputException" * "LakeFormation.Client.exceptions.OperationTimeoutException" * "LakeFormation.Client.exceptions.EntityNotFoundException" * "LakeFormation.Client.exceptions.TransactionCommittedException" * "LakeFormation.Client.exceptions.TransactionCanceledException" * "LakeFormation.Client.exceptions.ResourceNotReadyException" * "LakeFormation.Client.exceptions.ConcurrentModificationException"