View Source AWS.LakeFormation (aws-elixir v1.0.4)
Lake Formation
Defines the public endpoint for the Lake Formation service.
Link to this section 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 a new LF-Tag expression with the provided name, description, catalog ID, and expression body.
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 the LF-Tag expression.
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.
Returns the identity of the invoking principal.
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 details about the LF-Tag expression.
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.
Returns the LF-Tag expressions in caller’s account filtered based on caller's permissions.
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 name of the LF-Tag expression to the new description and expression body provided.
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.
Link to this section 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.
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:
Batch operation to grant permissions to the principal.
Batch operation to revoke permissions from the principal.
Attempts to cancel the specified transaction.
Returns an exception if the transaction was previously committed.
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.
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 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.
create_lake_formation_identity_center_configuration(client, input, options \\ [])
View SourceCreates 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.
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.
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.
delete_lake_formation_identity_center_configuration(client, input, options \\ [])
View SourceDeletes 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.
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.
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.
describe_lake_formation_identity_center_configuration(client, input, options \\ [])
View SourceRetrieves 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.
Write transactions that remain idle for a long period are automatically aborted unless explicitly extended.
Returns a data cells filter.
Returns the identity of the invoking principal.
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.
GetEffectivePermissionsForPath will not return databases and tables if the
catalog is encrypted.
Returns an LF-tag definition.
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.
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.
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.
A transaction ID or timestamp can be specified for time-travel queries.
get_temporary_glue_partition_credentials(client, input, options \\ [])
View SourceThis 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.
get_temporary_glue_table_credentials(client, input, options \\ [])
View SourceAllows 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.
Returns the work units resulting from the query.
Work units can be executed in any order and in parallel.
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.
For information about permissions, see Security and Access Control to Metadata and Data.
Lists all the data cell filters on a table.
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.
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.
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.
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.
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.
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.
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 = trueIf UseServiceLinkedRole is not set to true, you must provide or set the
RoleArn:
arn:aws:iam::12345:role/my-data-access-role
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.
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 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.
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.
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.
Starts a new transaction and returns its transaction ID.
Transaction IDs are opaque objects that you can use to identify a transaction.
Updates a data cell filter.
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.
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.
update_lake_formation_identity_center_configuration(client, input, options \\ [])
View SourceUpdates 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.