AWS Lake Formation
Lake Formation Defines the public endpoint for the Lake Formation service.
Data & analytics#openapi#cloud
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Lake Formation
Defines the public endpoint for the Lake Formation service.
Endpoints 71
- POSTAdd lF tags to resource
/AddLFTagsToResourceAttaches one or more LF-tags to an existing resource. - POSTAssume decorated role with sAML
/AssumeDecoratedRoleWithSAMLAllows 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… - POSTAttach rLS policy
/AttachRLSPolicyAttaches a row-level security policy to a resource for a principal. When the principal queries the resource, Lake Formation applies the policy's filter… - POSTBatch grant permissions
/BatchGrantPermissionsBatch operation to grant permissions to the principal. - POSTBatch revoke permissions
/BatchRevokePermissionsBatch operation to revoke permissions from the principal. - POSTCancel transaction
/CancelTransactionAttempts to cancel the specified transaction. Returns an exception if the transaction was previously committed. - POSTCommit transaction
/CommitTransactionAttempts to commit the specified transaction. Returns an exception if the transaction was previously aborted. This API action is idempotent if called multiple… - POSTCreate data cells filter
/CreateDataCellsFilterCreates a data cell filter to allow one to grant access to certain columns on certain rows. - POSTCreate lF tag
/CreateLFTagCreates an LF-tag with the specified name and values. - POSTCreate lF tag expression
/CreateLFTagExpressionCreates 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… - POSTCreate lake formation identity center configuration
/CreateLakeFormationIdentityCenterConfigurationCreates an IAM Identity Center connection with Lake Formation to allow IAM Identity Center users and groups to access Data Catalog resources. - POSTCreate lake formation opt in
/CreateLakeFormationOptInEnforce Lake Formation permissions for the given databases, tables, and principals. - POSTCreate rLS policy
/CreateRLSPolicyCreates a row-level security (RLS) policy. A row-level security policy defines a filter expression that Lake Formation evaluates to determine which rows of a… - POSTDelete data cells filter
/DeleteDataCellsFilterDeletes a data cell filter. - POSTDelete lF tag
/DeleteLFTagDeletes an LF-tag by its key name. The operation fails if the specified tag key doesn't exist. When you delete an LF-Tag: The associated LF-Tag policy becomes… - POSTDelete lF tag expression
/DeleteLFTagExpressionDeletes 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… - POSTDelete lake formation identity center configuration
/DeleteLakeFormationIdentityCenterConfigurationDeletes an IAM Identity Center connection with Lake Formation. - POSTDelete lake formation opt in
/DeleteLakeFormationOptInRemove the Lake Formation permissions enforcement of the given databases, tables, and principals. - POSTDelete objects on cancel
/DeleteObjectsOnCancelFor 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… - POSTDelete rLS policy
/DeleteRLSPolicyDeletes a row-level security policy. Any active attachments of the policy are automatically removed as part of the deletion, so you do not need to detach the… - POSTDeregister resource
/DeregisterResourceDeregisters 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… - POSTDescribe lake formation identity center configuration
/DescribeLakeFormationIdentityCenterConfigurationRetrieves the instance ARN and application ARN for the connection. - POSTDescribe resource
/DescribeResourceRetrieves the current data access role for the given resource registered in Lake Formation. - POSTDescribe transaction
/DescribeTransactionReturns the details of a single transaction. - POSTDetach rLS policy
/DetachRLSPolicyDetaches a row-level security policy from a resource for a principal. After the policy is detached, its filter expression is no longer applied to the… - POSTExtend transaction
/ExtendTransactionIndicates 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… - POSTGet data cells filter
/GetDataCellsFilterReturns a data cells filter. - POSTGet data lake principal
/GetDataLakePrincipalReturns the identity of the invoking principal. - POSTGet data lake settings
/GetDataLakeSettingsRetrieves the list of the data lake administrators of a Lake Formation-managed data lake. - POSTGet effective permissions for path
/GetEffectivePermissionsForPathReturns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3. GetEffectivePermissionsForPath will not… - POSTGet glue function session context
/GetGlueFunctionSessionContextReturns a session context for one or more user-defined functions that an integrated analytics engine runs together in a job. You must have the EXECUTE… - POSTGet lF tag
/GetLFTagReturns an LF-tag definition. - POSTGet lF tag expression
/GetLFTagExpressionReturns 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. - POSTGet query state
/GetQueryStateReturns the state of a query previously submitted. Clients are expected to poll GetQueryState to monitor the current state of the planning before retrieving… - POSTGet query statistics
/GetQueryStatisticsRetrieves statistics on the planning and execution of a query. - POSTGet rLS policy
/GetRLSPolicyReturns the definition of a row-level security policy, including its attachment columns and filter expression. - POSTGet resource lF tags
/GetResourceLFTagsReturns the LF-tags applied to a resource. - POSTGet table objects
/GetTableObjectsReturns 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. - POSTGet temporary data location credentials
/GetTemporaryDataLocationCredentialsAllows a user or application in a secure environment to access data in a specific Amazon S3 location registered with Lake Formation by providing temporary… - POSTGet temporary glue function credentials
/GetTemporaryGlueFunctionCredentialsReturns temporary credentials that you can use to download the artifacts of a user-defined function whose GovernanceMode is LAKE_FORMATION . Lake Formation… - POSTGet temporary glue partition credentials
/GetTemporaryGluePartitionCredentialsThis API is identical to GetTemporaryTableCredentials except that this is used when the target Data Catalog resource is of type Partition. Lake Formation… - POSTGet temporary glue table credentials
/GetTemporaryGlueTableCredentialsAllows 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… - POSTGet work unit results
/GetWorkUnitResultsReturns the work units resulting from the query. Work units can be executed in any order and in parallel. - POSTGet work units
/GetWorkUnitsRetrieves the work units generated by the StartQueryPlanning operation. - POSTGrant permissions
/GrantPermissionsGrants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. For information… - POSTList data cells filter
/ListDataCellsFilterLists all the data cell filters on a table. - POSTList lF tag expressions
/ListLFTagExpressionsReturns 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… - POSTList lF tags
/ListLFTagsLists LF-tags that the requester has permission to view. - POSTList lake formation opt ins
/ListLakeFormationOptInsRetrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions. - POSTList permissions
/ListPermissionsReturns 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,… - POSTList rLS policies
/ListRLSPoliciesLists the row-level security policies in the Data Catalog. - POSTList rLS policy attachments
/ListRLSPolicyAttachmentsLists the row-level security policy attachments in the Data Catalog. You can filter the results by resource, principal, or policy name. - POSTList resources
/ListResourcesLists the resources registered to be managed by the Data Catalog. - POSTList table storage optimizers
/ListTableStorageOptimizersReturns the configuration of all storage optimizers associated with a specified table. - POSTList transactions
/ListTransactionsReturns metadata about transactions and their status. To prevent the response from growing indefinitely, only uncommitted transactions and those available for… - POSTPut data lake settings
/PutDataLakeSettingsSets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation. For more information on admin privileges, see… - POSTRegister resource
/RegisterResourceRegisters 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… - POSTRemove lF tags from resource
/RemoveLFTagsFromResourceRemoves an LF-tag from the resource. Only database, table, or tableWithColumns resource are allowed. To tag columns, use the column inclusion list in… - POSTRevoke permissions
/RevokePermissionsRevokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. - POSTSearch databases by lF tags
/SearchDatabasesByLFTagsThis operation allows a search on DATABASE resources by TagCondition . This operation is used by admins who want to grant user permissions on certain… - POSTSearch tables by lF tags
/SearchTablesByLFTagsThis 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… - POSTStart query planning
/StartQueryPlanningSubmits 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… - POSTStart transaction
/StartTransactionStarts a new transaction and returns its transaction ID. Transaction IDs are opaque objects that you can use to identify a transaction. - POSTUpdate data cells filter
/UpdateDataCellsFilterUpdates a data cell filter. - POSTUpdate lF tag
/UpdateLFTagUpdates 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… - POSTUpdate lF tag expression
/UpdateLFTagExpressionUpdates the name of the LF-Tag expression to the new description and expression body provided. Updating a LF-Tag expression immediately changes the permission… - POSTUpdate lake formation identity center configuration
/UpdateLakeFormationIdentityCenterConfigurationUpdates the IAM Identity Center connection parameters. - POSTUpdate rLS policy
/UpdateRLSPolicyUpdates the filter expression of an existing row-level security policy. The change applies to all attachments of the policy. - POSTUpdate resource
/UpdateResourceUpdates the data access role used for vending access to the given (registered) resource in Lake Formation. - POSTUpdate table objects
/UpdateTableObjectsUpdates the manifest of Amazon S3 objects that make up the specified governed table. - POSTUpdate table storage optimizer
/UpdateTableStorageOptimizerUpdates the configuration of the storage optimizers for a table.
API details
- Base URL
https://lakeformation.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 71 operations on 71 pathsPOST 71
- Description format
- AWS Smithy model, API version
2017-03-31 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS Lake Formation in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Lake Formation collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Add lF tags to resource” (POST /AddLFTagsToResource), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS Lake Formation?
Lake Formation Defines the public endpoint for the Lake Formation service. It is listed under Data & analytics and has 71 endpoints.
Who publishes the AWS Lake Formation?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS Lake Formation?
Requests go to https://lakeformation.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS Lake Formation?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS Lake Formation have?
71 operations on 71 paths (71 POST).
Is forking the AWS Lake Formation free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.