AWS Lake Formation API

by amazonaws.com

Overview

<fullname>Lake Formation</fullname> <p>Defines the public endpoint for the Lake Formation service.</p>

AWS Lake Formation is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 47 endpoints.

At a glance

Authentication: API key
HTTPS: Yes
CORS: Unknown
Category: Cloud Platforms
Version: 2017-03-31
Endpoints: 47
OpenAPI: Specification ↗
Spec updated: 2020-03-11

Endpoints

Method	Path	What it does
POST	`/AddLFTagsToResource`	Attaches one or more LF-tags to an existing resource.
POST	`/AssumeDecoratedRoleWithSAML`	<p>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 Formati
POST	`/BatchGrantPermissions`	Batch operation to grant permissions to the principal.
POST	`/BatchRevokePermissions`	Batch operation to revoke permissions from the principal.
POST	`/CancelTransaction`	Attempts to cancel the specified transaction. Returns an exception if the transaction was previously committed.
POST	`/CommitTransaction`	Attempts to commit the specified transaction. Returns an exception if the transaction was previously aborted. This API action is idempotent if called multiple t
POST	`/CreateDataCellsFilter`	Creates a data cell filter to allow one to grant access to certain columns on certain rows.
POST	`/CreateLFTag`	Creates an LF-tag with the specified name and values.
POST	`/DeleteDataCellsFilter`	Deletes a data cell filter.
POST	`/DeleteLFTag`	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-t
POST	`/DeleteObjectsOnCancel`	<p>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
POST	`/DeregisterResource`	<p>Deregisters the resource as managed by the Data Catalog.</p> <p>When you deregister a path, Lake Formation removes the path from the inline policy attached t
POST	`/DescribeResource`	Retrieves the current data access role for the given resource registered in Lake Formation.
POST	`/DescribeTransaction`	Returns the details of a single transaction.
POST	`/ExtendTransaction`	<p>Indicates to the service that the specified transaction is still active and should not be treated as idle and aborted.</p> <p>Write transactions that remain
POST	`/GetDataCellsFilter`	Returns a data cells filter.
POST	`/GetDataLakeSettings`	Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.
POST	`/GetEffectivePermissionsForPath`	Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3. <code>GetEffectivePermissionsForPath</code> wi
POST	`/GetLFTag`	Returns an LF-tag definition.
POST	`/GetQueryState`	Returns the state of a query previously submitted. Clients are expected to poll <code>GetQueryState</code> to monitor the current state of the planning before r
POST	`/GetQueryStatistics`	Retrieves statistics on the planning and execution of a query.
POST	`/GetResourceLFTags`	Returns the LF-tags applied to a resource.
POST	`/GetTableObjects`	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.
POST	`/GetTemporaryGluePartitionCredentials`	This API is identical to <code>GetTemporaryTableCredentials</code> except that this is used when the target Data Catalog resource is of type Partition. Lake For
POST	`/GetTemporaryGlueTableCredentials`	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
POST	`/GetWorkUnitResults`	Returns the work units resulting from the query. Work units can be executed in any order and in parallel.
POST	`/GetWorkUnits`	Retrieves the work units generated by the <code>StartQueryPlanning</code> operation.
POST	`/GrantPermissions`	<p>Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.</p> <p>For inform
POST	`/ListDataCellsFilter`	Lists all the data cell filters on a table.
POST	`/ListLFTags`	Lists LF-tags that the requester has permission to view.
POST	`/ListPermissions`	<p>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,
POST	`/ListResources`	Lists the resources registered to be managed by the Data Catalog.
POST	`/ListTableStorageOptimizers`	Returns the configuration of all storage optimizers associated with a specified table.
POST	`/ListTransactions`	<p>Returns metadata about transactions and their status. To prevent the response from growing indefinitely, only uncommitted transactions and those available fo
POST	`/PutDataLakeSettings`	<p>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
POST	`/RegisterResource`	<p>Registers the resource as managed by the Data Catalog.</p> <p>To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Cho
POST	`/RemoveLFTagsFromResource`	Removes an LF-tag from the resource. Only database, table, or tableWithColumns resource are allowed. To tag columns, use the column inclusion list in <code>tabl
POST	`/RevokePermissions`	Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
POST	`/SearchDatabasesByLFTags`	This operation allows a search on <code>DATABASE</code> resources by <code>TagCondition</code>. This operation is used by admins who want to grant user permissi
POST	`/SearchTablesByLFTags`	This operation allows a search on <code>TABLE</code> resources by <code>LFTag</code>s. This will be used by admins who want to grant user permissions on certain
POST	`/StartQueryPlanning`	<p>Submits a request to process a query statement.</p> <p>This operation generates work units that can be retrieved with the <code>GetWorkUnits</code> operation
POST	`/StartTransaction`	Starts a new transaction and returns its transaction ID. Transaction IDs are opaque objects that you can use to identify a transaction.
POST	`/UpdateDataCellsFilter`	Updates a data cell filter.
POST	`/UpdateLFTag`	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 t
POST	`/UpdateResource`	Updates the data access role used for vending access to the given (registered) resource in Lake Formation.
POST	`/UpdateTableObjects`	Updates the manifest of Amazon S3 objects that make up the specified governed table.
POST	`/UpdateTableStorageOptimizer`	Updates the configuration of the storage optimizers for a table.

Questions

Does the AWS Lake Formation API need an API key?

Yes. The AWS Lake Formation API uses API key authentication; the documentation explains how to get credentials.

Does the AWS Lake Formation API support HTTPS?

Yes, the AWS Lake Formation API is served over HTTPS.

How many endpoints does the AWS Lake Formation API have?

Its OpenAPI description lists 47 endpoints in version 2017-03-31. All of them are shown on this page.

What are alternatives to the AWS Lake Formation API?

Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.

Compare alternatives →

Remote Settings PROD

Cloud Platforms

Firefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.

No auth19 endpoints

Linode API

Cloud Platforms

## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se

Bearer token350 endpoints

DigitalOcean API

Cloud Platforms

# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having

Bearer token290 endpoints

Vercel API

Cloud Platforms

Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.

Bearer token112 endpoints