View Source aws_lakeformation (aws v1.0.4)

Lake Formation

Defines the public endpoint for the Lake Formation service.

Summary

Functions

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

Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML assertion included in the request.

Batch operation to grant permissions to the principal.
Batch operation to revoke permissions from the principal.

Attempts to cancel the specified transaction.

Attempts to commit the specified transaction.

Creates a data cell filter to allow one to grant access to certain columns on certain rows.
Creates an LF-tag with the specified name and values.
Creates an IAM Identity Center connection with Lake Formation to allow IAM Identity Center users and groups to access Data Catalog resources.
Enforce Lake Formation permissions for the given databases, tables, and principals.
Deletes a data cell filter.

Deletes the specified LF-tag given a key name.

Deletes an IAM Identity Center connection with Lake Formation.
Remove the Lake Formation permissions enforcement of the given databases, tables, and principals.

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.

Deregisters the resource as managed by the Data Catalog.

Retrieves the instance ARN and application ARN for the connection.
Retrieves the current data access role for the given resource registered in Lake Formation.
Returns the details of a single transaction.

Indicates to the service that the specified transaction is still active and should not be treated as idle and aborted.

Returns a data cells filter.
Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.

Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.

Returns an LF-tag definition.

Returns the state of a query previously submitted.

Retrieves statistics on the planning and execution of a query.
Returns the LF-tags applied to a resource.

Returns the set of Amazon S3 objects that make up the specified governed table.

This API is identical to GetTemporaryTableCredentials except that this is used when the target Data Catalog resource is of type Partition.

Allows a caller in a secure environment to assume a role with permission to access Amazon S3.

Returns the work units resulting from the query.

Retrieves the work units generated by the StartQueryPlanning operation.

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

Lists all the data cell filters on a table.
Lists LF-tags that the requester has permission to view.
Retrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions.

Returns a list of the principal permissions on the resource, filtered by the permissions of the caller.

Lists the resources registered to be managed by the Data Catalog.
Returns the configuration of all storage optimizers associated with a specified table.

Returns metadata about transactions and their status.

Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation.

Registers the resource as managed by the Data Catalog.

Removes an LF-tag from the resource.

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

This operation allows a search on DATABASE resources by TagCondition.

This operation allows a search on TABLE resources by LFTags.

Submits a request to process a query statement.

Starts a new transaction and returns its transaction ID.

Updates a data cell filter.

Updates the list of possible values for the specified LF-tag key.

Updates the IAM Identity Center connection parameters.
Updates the data access role used for vending access to the given (registered) resource in Lake Formation.
Updates the manifest of Amazon S3 objects that make up the specified governed table.
Updates the configuration of the storage optimizers for a table.

Functions

Link to this function

add_l_f_tags_to_resource(Client, Input)

View Source
Attaches one or more LF-tags to an existing resource.
Link to this function

add_l_f_tags_to_resource(Client, Input0, Options0)

View Source
Link to this function

assume_decorated_role_with_saml(Client, Input)

View Source

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:
Link to this function

assume_decorated_role_with_saml(Client, Input0, Options0)

View Source
Link to this function

batch_grant_permissions(Client, Input)

View Source
Batch operation to grant permissions to the principal.
Link to this function

batch_grant_permissions(Client, Input0, Options0)

View Source
Link to this function

batch_revoke_permissions(Client, Input)

View Source
Batch operation to revoke permissions from the principal.
Link to this function

batch_revoke_permissions(Client, Input0, Options0)

View Source
Link to this function

cancel_transaction(Client, Input)

View Source

Attempts to cancel the specified transaction.

Returns an exception if the transaction was previously committed.
Link to this function

cancel_transaction(Client, Input0, Options0)

View Source
Link to this function

commit_transaction(Client, Input)

View Source

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.
Link to this function

commit_transaction(Client, Input0, Options0)

View Source
Link to this function

create_data_cells_filter(Client, Input)

View Source
Creates a data cell filter to allow one to grant access to certain columns on certain rows.
Link to this function

create_data_cells_filter(Client, Input0, Options0)

View Source
Link to this function

create_l_f_tag(Client, Input)

View Source
Creates an LF-tag with the specified name and values.
Link to this function

create_l_f_tag(Client, Input0, Options0)

View Source
Link to this function

create_lake_formation_identity_center_configuration(Client, Input)

View Source
Creates an IAM Identity Center connection with Lake Formation to allow IAM Identity Center users and groups to access Data Catalog resources.
Link to this function

create_lake_formation_identity_center_configuration(Client, Input0, Options0)

View Source
Link to this function

create_lake_formation_opt_in(Client, Input)

View Source
Enforce Lake Formation permissions for the given databases, tables, and principals.
Link to this function

create_lake_formation_opt_in(Client, Input0, Options0)

View Source
Link to this function

delete_data_cells_filter(Client, Input)

View Source
Deletes a data cell filter.
Link to this function

delete_data_cells_filter(Client, Input0, Options0)

View Source
Link to this function

delete_l_f_tag(Client, Input)

View Source

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.
Link to this function

delete_l_f_tag(Client, Input0, Options0)

View Source
Link to this function

delete_lake_formation_identity_center_configuration(Client, Input)

View Source
Deletes an IAM Identity Center connection with Lake Formation.
Link to this function

delete_lake_formation_identity_center_configuration(Client, Input0, Options0)

View Source
Link to this function

delete_lake_formation_opt_in(Client, Input)

View Source
Remove the Lake Formation permissions enforcement of the given databases, tables, and principals.
Link to this function

delete_lake_formation_opt_in(Client, Input0, Options0)

View Source
Link to this function

delete_objects_on_cancel(Client, Input)

View Source

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 includes an option to automatically call DeleteObjectsOnCancel before writes. For more information, see Rolling Back Amazon S3 Writes: https://docs.aws.amazon.com/lake-formation/latest/dg/transactions-data-operations.html#rolling-back-writes.
Link to this function

delete_objects_on_cancel(Client, Input0, Options0)

View Source
Link to this function

deregister_resource(Client, Input)

View Source

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.
Link to this function

deregister_resource(Client, Input0, Options0)

View Source
Link to this function

describe_lake_formation_identity_center_configuration(Client, Input)

View Source
Retrieves the instance ARN and application ARN for the connection.
Link to this function

describe_lake_formation_identity_center_configuration(Client, Input0, Options0)

View Source
Link to this function

describe_resource(Client, Input)

View Source
Retrieves the current data access role for the given resource registered in Lake Formation.
Link to this function

describe_resource(Client, Input0, Options0)

View Source
Link to this function

describe_transaction(Client, Input)

View Source
Returns the details of a single transaction.
Link to this function

describe_transaction(Client, Input0, Options0)

View Source
Link to this function

extend_transaction(Client, Input)

View Source

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.
Link to this function

extend_transaction(Client, Input0, Options0)

View Source
Link to this function

get_data_cells_filter(Client, Input)

View Source
Returns a data cells filter.
Link to this function

get_data_cells_filter(Client, Input0, Options0)

View Source
Link to this function

get_data_lake_settings(Client, Input)

View Source
Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
Link to this function

get_data_lake_settings(Client, Input0, Options0)

View Source
Link to this function

get_effective_permissions_for_path(Client, Input)

View Source

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.
Link to this function

get_effective_permissions_for_path(Client, Input0, Options0)

View Source
Link to this function

get_l_f_tag(Client, Input)

View Source
Returns an LF-tag definition.
Link to this function

get_l_f_tag(Client, Input0, Options0)

View Source
Link to this function

get_query_state(Client, Input)

View Source

Returns the state of a query previously submitted.

Clients are expected to poll GetQueryState to monitor the current state of the planning before retrieving the work units. A query state is only visible to the principal that made the initial call to StartQueryPlanning.
Link to this function

get_query_state(Client, Input0, Options0)

View Source
Link to this function

get_query_statistics(Client, Input)

View Source
Retrieves statistics on the planning and execution of a query.
Link to this function

get_query_statistics(Client, Input0, Options0)

View Source
Link to this function

get_resource_l_f_tags(Client, Input)

View Source
Returns the LF-tags applied to a resource.
Link to this function

get_resource_l_f_tags(Client, Input0, Options0)

View Source
Link to this function

get_table_objects(Client, Input)

View Source

Returns the set of Amazon S3 objects that make up the specified governed table.

A transaction ID or timestamp can be specified for time-travel queries.
Link to this function

get_table_objects(Client, Input0, Options0)

View Source
Link to this function

get_temporary_glue_partition_credentials(Client, Input)

View Source

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.
Link to this function

get_temporary_glue_partition_credentials(Client, Input0, Options0)

View Source
Link to this function

get_temporary_glue_table_credentials(Client, Input)

View Source

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.
Link to this function

get_temporary_glue_table_credentials(Client, Input0, Options0)

View Source
Link to this function

get_work_unit_results(Client, Input)

View Source

Returns the work units resulting from the query.

Work units can be executed in any order and in parallel.
Link to this function

get_work_unit_results(Client, Input0, Options0)

View Source
Link to this function

get_work_units(Client, Input)

View Source
Retrieves the work units generated by the StartQueryPlanning operation.
Link to this function

get_work_units(Client, Input0, Options0)

View Source
Link to this function

grant_permissions(Client, Input)

View Source

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

For information about permissions, see Security and Access Control to Metadata and Data: https://docs.aws.amazon.com/lake-formation/latest/dg/security-data-access.html.
Link to this function

grant_permissions(Client, Input0, Options0)

View Source
Link to this function

list_data_cells_filter(Client, Input)

View Source
Lists all the data cell filters on a table.
Link to this function

list_data_cells_filter(Client, Input0, Options0)

View Source
Link to this function

list_l_f_tags(Client, Input)

View Source
Lists LF-tags that the requester has permission to view.
Link to this function

list_l_f_tags(Client, Input0, Options0)

View Source
Link to this function

list_lake_formation_opt_ins(Client, Input)

View Source
Retrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions.
Link to this function

list_lake_formation_opt_ins(Client, Input0, Options0)

View Source
Link to this function

list_permissions(Client, Input)

View Source

Returns a list of the principal permissions on the resource, filtered by the permissions of the caller.

For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.

This operation returns only those permissions that have been explicitly granted.

For information about permissions, see Security and Access Control to Metadata and Data: https://docs.aws.amazon.com/lake-formation/latest/dg/security-data-access.html.
Link to this function

list_permissions(Client, Input0, Options0)

View Source
Link to this function

list_resources(Client, Input)

View Source
Lists the resources registered to be managed by the Data Catalog.
Link to this function

list_resources(Client, Input0, Options0)

View Source
Link to this function

list_table_storage_optimizers(Client, Input)

View Source
Returns the configuration of all storage optimizers associated with a specified table.
Link to this function

list_table_storage_optimizers(Client, Input0, Options0)

View Source
Link to this function

list_transactions(Client, Input)

View Source

Returns metadata about transactions and their status.

To prevent the response from growing indefinitely, only uncommitted transactions and those available for time-travel queries are returned.

This operation can help you identify uncommitted transactions or to get information about transactions.
Link to this function

list_transactions(Client, Input0, Options0)

View Source
Link to this function

put_data_lake_settings(Client, Input)

View Source

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: https://docs.aws.amazon.com/lake-formation/latest/dg/lake-formation-permissions.html.

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.
Link to this function

put_data_lake_settings(Client, Input0, Options0)

View Source
Link to this function

register_resource(Client, Input)

View Source

Registers the resource as managed by the Data Catalog.

To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.

The following request registers a new location and gives Lake Formation permission to use the service-linked role to access that location.

ResourceArn = arn:aws:s3:::my-bucket UseServiceLinkedRole = true

If UseServiceLinkedRole is not set to true, you must provide or set the RoleArn:

arn:aws:iam::12345:role/my-data-access-role
Link to this function

register_resource(Client, Input0, Options0)

View Source
Link to this function

remove_l_f_tags_from_resource(Client, Input)

View Source

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.
Link to this function

remove_l_f_tags_from_resource(Client, Input0, Options0)

View Source
Link to this function

revoke_permissions(Client, Input)

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

revoke_permissions(Client, Input0, Options0)

View Source
Link to this function

search_databases_by_l_f_tags(Client, Input)

View Source

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.
Link to this function

search_databases_by_l_f_tags(Client, Input0, Options0)

View Source
Link to this function

search_tables_by_l_f_tags(Client, Input)

View Source

This operation allows a search on TABLE resources by LFTags.

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 LFTags are valid to verify whether the returned resources can be shared.
Link to this function

search_tables_by_l_f_tags(Client, Input0, Options0)

View Source
Link to this function

start_query_planning(Client, Input)

View Source

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.
Link to this function

start_query_planning(Client, Input0, Options0)

View Source
Link to this function

start_transaction(Client, Input)

View Source

Starts a new transaction and returns its transaction ID.

Transaction IDs are opaque objects that you can use to identify a transaction.
Link to this function

start_transaction(Client, Input0, Options0)

View Source
Link to this function

update_data_cells_filter(Client, Input)

View Source
Updates a data cell filter.
Link to this function

update_data_cells_filter(Client, Input0, Options0)

View Source
Link to this function

update_l_f_tag(Client, Input)

View Source

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.
Link to this function

update_l_f_tag(Client, Input0, Options0)

View Source
Link to this function

update_lake_formation_identity_center_configuration(Client, Input)

View Source
Updates the IAM Identity Center connection parameters.
Link to this function

update_lake_formation_identity_center_configuration(Client, Input0, Options0)

View Source
Link to this function

update_resource(Client, Input)

View Source
Updates the data access role used for vending access to the given (registered) resource in Lake Formation.
Link to this function

update_resource(Client, Input0, Options0)

View Source
Link to this function

update_table_objects(Client, Input)

View Source
Updates the manifest of Amazon S3 objects that make up the specified governed table.
Link to this function

update_table_objects(Client, Input0, Options0)

View Source
Link to this function

update_table_storage_optimizer(Client, Input)

View Source
Updates the configuration of the storage optimizers for a table.
Link to this function

update_table_storage_optimizer(Client, Input0, Options0)

View Source