Open documentation ↗Overview
<p>Amazon Athena is an interactive query service that lets you use standard SQL to analyze data directly in Amazon S3. You can point Athena at your data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so there is no infrastructure to set up or manage. You pay only for the queries you run. Athena scales automatically—executing queries in parallel—so results are fast, even with large datasets and complex queries. For more information, see <a href="http://docs.aws.amazon.com/athena/latest/ug/what-is.html">What is Amazon Athena</a> in the <i>Amazon Athena User Guide</i>.</p> <p>If you connect to Athena using the JDBC driver, use version 1.1.0 of the driver or later with the Amazon Athena API. Earlier version drivers do not support the API. For more information and to download the driver, see <a href="https://docs.aws.amazon.com/athena/latest/ug/connect-with-jdbc.html">Accessing Amazon Athena with JDBC</a>.</p> <p>For code samples using the Amazon Web Services SDK for Java, see <a href="https://docs.aws.amazon.com/athena/latest/ug/code-samples.html">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>
Amazon Athena is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 60 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Cloud Platforms
- Version
- 2017-05-18
- Endpoints
- 60
- OpenAPI
- Specification ↗
- Spec updated
- 2020-03-25
Endpoints
| Method | Path | What it does |
|---|---|---|
| POST | /#X-Amz-Target=AmazonAthena.BatchGetNamedQuery | Returns the details of a single named query or a list of up to 50 queries, which you provide as an array of query ID strings. Requires you to have access to the |
| POST | /#X-Amz-Target=AmazonAthena.BatchGetPreparedStatement | Returns the details of a single prepared statement or a list of up to 256 prepared statements for the array of prepared statement names that you provide. Requir |
| POST | /#X-Amz-Target=AmazonAthena.BatchGetQueryExecution | Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings. Requires yo |
| POST | /#X-Amz-Target=AmazonAthena.CreateDataCatalog | Creates (registers) a data catalog with the specified name and properties. Catalogs created are visible to all users of the same Amazon Web Services account. |
| POST | /#X-Amz-Target=AmazonAthena.CreateNamedQuery | <p>Creates a named query in the specified workgroup. Requires that you have access to the workgroup.</p> <p>For code samples using the Amazon Web Services SDK f |
| POST | /#X-Amz-Target=AmazonAthena.CreateNotebook | Creates an empty <code>ipynb</code> file in the specified Apache Spark enabled workgroup. Throws an error if a file in the workgroup with the same name already |
| POST | /#X-Amz-Target=AmazonAthena.CreatePreparedStatement | Creates a prepared statement for use with SQL queries in Athena. |
| POST | /#X-Amz-Target=AmazonAthena.CreatePresignedNotebookUrl | Gets an authentication token and the URL at which the notebook can be accessed. During programmatic access, <code>CreatePresignedNotebookUrl</code> must be call |
| POST | /#X-Amz-Target=AmazonAthena.CreateWorkGroup | Creates a workgroup with the specified name. A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup. |
| POST | /#X-Amz-Target=AmazonAthena.DeleteDataCatalog | Deletes a data catalog. |
| POST | /#X-Amz-Target=AmazonAthena.DeleteNamedQuery | <p>Deletes the named query if you have access to the workgroup in which the query was saved.</p> <p>For code samples using the Amazon Web Services SDK for Java, |
| POST | /#X-Amz-Target=AmazonAthena.DeleteNotebook | Deletes the specified notebook. |
| POST | /#X-Amz-Target=AmazonAthena.DeletePreparedStatement | Deletes the prepared statement with the specified name from the specified workgroup. |
| POST | /#X-Amz-Target=AmazonAthena.DeleteWorkGroup | Deletes the workgroup with the specified name. The primary workgroup cannot be deleted. |
| POST | /#X-Amz-Target=AmazonAthena.ExportNotebook | Exports the specified notebook and its metadata. |
| POST | /#X-Amz-Target=AmazonAthena.GetCalculationExecution | Describes a previously submitted calculation execution. |
| POST | /#X-Amz-Target=AmazonAthena.GetCalculationExecutionCode | Retrieves the unencrypted code that was executed for the calculation. |
| POST | /#X-Amz-Target=AmazonAthena.GetCalculationExecutionStatus | Gets the status of a current calculation. |
| POST | /#X-Amz-Target=AmazonAthena.GetDataCatalog | Returns the specified data catalog. |
| POST | /#X-Amz-Target=AmazonAthena.GetDatabase | Returns a database object for the specified database and data catalog. |
| POST | /#X-Amz-Target=AmazonAthena.GetNamedQuery | Returns information about a single query. Requires that you have access to the workgroup in which the query was saved. |
| POST | /#X-Amz-Target=AmazonAthena.GetNotebookMetadata | Retrieves notebook metadata for the specified notebook ID. |
| POST | /#X-Amz-Target=AmazonAthena.GetPreparedStatement | Retrieves the prepared statement with the specified name from the specified workgroup. |
| POST | /#X-Amz-Target=AmazonAthena.GetQueryExecution | Returns information about a single execution of a query if you have access to the workgroup in which the query ran. Each time a query executes, information abou |
| POST | /#X-Amz-Target=AmazonAthena.GetQueryResults | <p>Streams the results of a single query execution specified by <code>QueryExecutionId</code> from the Athena query results location in Amazon S3. For more info |
| POST | /#X-Amz-Target=AmazonAthena.GetQueryRuntimeStatistics | Returns query execution runtime statistics related to a single execution of a query if you have access to the workgroup in which the query ran. Query execution |
| POST | /#X-Amz-Target=AmazonAthena.GetSession | Gets the full details of a previously created session, including the session status and configuration. |
| POST | /#X-Amz-Target=AmazonAthena.GetSessionStatus | Gets the current status of a session. |
| POST | /#X-Amz-Target=AmazonAthena.GetTableMetadata | Returns table metadata for the specified catalog, database, and table. |
| POST | /#X-Amz-Target=AmazonAthena.GetWorkGroup | Returns information about the workgroup with the specified name. |
| POST | /#X-Amz-Target=AmazonAthena.ImportNotebook | Imports a single <code>ipynb</code> file to a Spark enabled workgroup. The maximum file size that can be imported is 10 megabytes. If an <code>ipynb</code> file |
| POST | /#X-Amz-Target=AmazonAthena.ListApplicationDPUSizes | Returns the supported DPU sizes for the supported application runtimes (for example, <code>Athena notebook version 1</code>). |
| POST | /#X-Amz-Target=AmazonAthena.ListCalculationExecutions | Lists the calculations that have been submitted to a session in descending order. Newer calculations are listed first; older calculations are listed later. |
| POST | /#X-Amz-Target=AmazonAthena.ListDataCatalogs | <p>Lists the data catalogs in the current Amazon Web Services account.</p> <note> <p>In the Athena console, data catalogs are listed as "data sources" on the <b |
| POST | /#X-Amz-Target=AmazonAthena.ListDatabases | Lists the databases in the specified data catalog. |
| POST | /#X-Amz-Target=AmazonAthena.ListEngineVersions | Returns a list of engine versions that are available to choose from, including the Auto option. |
| POST | /#X-Amz-Target=AmazonAthena.ListExecutors | Lists, in descending order, the executors that joined a session. Newer executors are listed first; older executors are listed later. The result can be optionall |
| POST | /#X-Amz-Target=AmazonAthena.ListNamedQueries | <p>Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the specified workgroup. If a work |
| POST | /#X-Amz-Target=AmazonAthena.ListNotebookMetadata | Displays the notebook files for the specified workgroup in paginated format. |
| POST | /#X-Amz-Target=AmazonAthena.ListNotebookSessions | Lists, in descending order, the sessions that have been created in a notebook that are in an active state like <code>CREATING</code>, <code>CREATED</code>, <cod |
| POST | /#X-Amz-Target=AmazonAthena.ListPreparedStatements | Lists the prepared statements in the specified workgroup. |
| POST | /#X-Amz-Target=AmazonAthena.ListQueryExecutions | <p>Provides a list of available query execution IDs for the queries in the specified workgroup. If a workgroup is not specified, returns a list of query executi |
| POST | /#X-Amz-Target=AmazonAthena.ListSessions | Lists the sessions in a workgroup that are in an active state like <code>CREATING</code>, <code>CREATED</code>, <code>IDLE</code>, or <code>BUSY</code>. Newer s |
| POST | /#X-Amz-Target=AmazonAthena.ListTableMetadata | Lists the metadata for the tables in the specified data catalog database. |
| POST | /#X-Amz-Target=AmazonAthena.ListTagsForResource | Lists the tags associated with an Athena workgroup or data catalog resource. |
| POST | /#X-Amz-Target=AmazonAthena.ListWorkGroups | Lists available workgroups for the account. |
| POST | /#X-Amz-Target=AmazonAthena.StartCalculationExecution | Submits calculations for execution within a session. You can supply the code to run as an inline code block within the request. |
| POST | /#X-Amz-Target=AmazonAthena.StartQueryExecution | Runs the SQL query statements contained in the <code>Query</code>. Requires you to have access to the workgroup in which the query ran. Running queries against |
| POST | /#X-Amz-Target=AmazonAthena.StartSession | Creates a session for running calculations within a workgroup. The session is ready when it reaches an <code>IDLE</code> state. |
| POST | /#X-Amz-Target=AmazonAthena.StopCalculationExecution | <p>Requests the cancellation of a calculation. A <code>StopCalculationExecution</code> call on a calculation that is already in a terminal state (for example, < |
| POST | /#X-Amz-Target=AmazonAthena.StopQueryExecution | <p>Stops a query execution. Requires you to have access to the workgroup in which the query ran.</p> <p>For code samples using the Amazon Web Services SDK for J |
| POST | /#X-Amz-Target=AmazonAthena.TagResource | Adds one or more tags to an Athena resource. A tag is a label that you assign to a resource. In Athena, a resource can be a workgroup or data catalog. Each tag |
| POST | /#X-Amz-Target=AmazonAthena.TerminateSession | Terminates an active session. A <code>TerminateSession</code> call on a session that is already inactive (for example, in a <code>FAILED</code>, <code>TERMINATE |
| POST | /#X-Amz-Target=AmazonAthena.UntagResource | Removes one or more tags from a data catalog or workgroup resource. |
| POST | /#X-Amz-Target=AmazonAthena.UpdateDataCatalog | Updates the data catalog that has the specified name. |
| POST | /#X-Amz-Target=AmazonAthena.UpdateNamedQuery | Updates a <a>NamedQuery</a> object. The database or workgroup cannot be updated. |
| POST | /#X-Amz-Target=AmazonAthena.UpdateNotebook | Updates the contents of a Spark notebook. |
| POST | /#X-Amz-Target=AmazonAthena.UpdateNotebookMetadata | Updates the metadata for a notebook. |
| POST | /#X-Amz-Target=AmazonAthena.UpdatePreparedStatement | Updates a prepared statement. |
| POST | /#X-Amz-Target=AmazonAthena.UpdateWorkGroup | Updates the workgroup with the specified name. The workgroup's name cannot be changed. Only <code>ConfigurationUpdates</code> can be specified. |
Questions
Does the Amazon Athena API need an API key?
Yes. The Amazon Athena API uses API key authentication; the documentation explains how to get credentials.
Does the Amazon Athena API support HTTPS?
Yes, the Amazon Athena API is served over HTTPS.
How many endpoints does the Amazon Athena API have?
Its OpenAPI description lists 60 endpoints in version 2017-05-18. All of them are shown on this page.
What are alternatives to the Amazon Athena API?
Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.
Similar cloud platforms APIs
Compare alternatives →Remote Settings PROD
Cloud PlatformsFirefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.
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
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
Vercel API
Cloud PlatformsVercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.
Platform API
Cloud PlatformsThe [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.
Azure Data Lake Storage
Cloud PlatformsAzure Data Lake Storage provides storage for Hadoop and other big data workloads.
Listed from APIs.guru (CC0).