View Source aws_lakeformation (aws v1.0.4)
Lake Formation
Defines the public endpoint for the Lake Formation service.Summary
Functions
Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML assertion included in the request.
Attempts to cancel the specified transaction.
Attempts to commit the specified transaction.
Deletes the specified LF-tag given a key name.
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.
Indicates to the service that the specified transaction is still active and should not be treated as idle and aborted.
Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.
Returns the state of a query previously submitted.
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.
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.
Returns a list of the principal permissions on the resource, filtered by the permissions of the caller.
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.
This operation allows a search on DATABASE
resources by TagCondition
.
This operation allows a search on TABLE
resources by LFTag
s.
Submits a request to process a query statement.
Starts a new transaction and returns its transaction ID.
Updates the list of possible values for the specified LF-tag key.
Functions
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 APIGetDataAccess
. 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:
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.create_lake_formation_identity_center_configuration(Client, Input)
View Sourcecreate_lake_formation_identity_center_configuration(Client, Input0, Options0)
View SourceDeletes 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, theLFTagPolicy
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.
delete_lake_formation_identity_center_configuration(Client, Input)
View Sourcedelete_lake_formation_identity_center_configuration(Client, Input0, Options0)
View SourceFor 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 callDeleteObjectsOnCancel
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.
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)
View Sourcedescribe_lake_formation_identity_center_configuration(Client, Input0, Options0)
View SourceIndicates 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 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 the state of a query previously submitted.
Clients are expected to pollGetQueryState
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
.
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.This API is identical to GetTemporaryTableCredentials
except that this is used when the target Data Catalog resource is of type Partition.
get_temporary_glue_partition_credentials(Client, Input0, Options0)
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.Returns the work units resulting from the query.
Work units can be executed in any order and in parallel.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: https://docs.aws.amazon.com/lake-formation/latest/dg/security-data-access.html.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.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: 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.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
Removes an LF-tag from the resource.
Only database, table, or tableWithColumns resource are allowed. To tag columns, use the column inclusion list intableWithColumns
to specify column input.
This operation allows a search on DATABASE
resources by TagCondition
.
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 LFTag
s.
SearchTablesByLFTags
to find all resources where the given LFTag
s 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 theGetWorkUnits
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 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.