Amazon Web Services, Inc.

Amazon Athena

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…

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

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 What is Amazon Athena in the Amazon Athena User
Guide .
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 Accessing
Amazon Athena with JDBC .

Endpoints 75

  • POSTBatch get named query/#X-Amz-Target=AmazonAthena.BatchGetNamedQueryReturns 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…
  • POSTBatch get prepared statement/#X-Amz-Target=AmazonAthena.BatchGetPreparedStatementReturns 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.…
  • POSTBatch get query execution/#X-Amz-Target=AmazonAthena.BatchGetQueryExecutionReturns 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…
  • POSTCancel capacity reservation/#X-Amz-Target=AmazonAthena.CancelCapacityReservationCancels the capacity reservation with the specified name. Cancelled reservations remain in your account and will be deleted 45 days after cancellation. During…
  • POSTCreate capacity reservation/#X-Amz-Target=AmazonAthena.CreateCapacityReservationCreates a capacity reservation with the specified name and number of requested data processing units.
  • POSTCreate data catalog/#X-Amz-Target=AmazonAthena.CreateDataCatalogCreates (registers) a data catalog with the specified name and properties. Catalogs created are visible to all users of the same Amazon Web Services account.…
  • POSTCreate named query/#X-Amz-Target=AmazonAthena.CreateNamedQueryCreates a named query in the specified workgroup. Requires that you have access to the workgroup.
  • POSTCreate notebook/#X-Amz-Target=AmazonAthena.CreateNotebookCreates an empty ipynb file in the specified Apache Spark enabled workgroup. Throws an error if a file in the workgroup with the same name already exists.
  • POSTCreate prepared statement/#X-Amz-Target=AmazonAthena.CreatePreparedStatementCreates a prepared statement for use with SQL queries in Athena.
  • POSTCreate presigned notebook url/#X-Amz-Target=AmazonAthena.CreatePresignedNotebookUrlGets an authentication token and the URL at which the notebook can be accessed. During programmatic access, CreatePresignedNotebookUrl must be called every 10…
  • POSTCreate system table configuration/#X-Amz-Target=AmazonAthena.CreateSystemTableConfigurationEnables system tables for the current account. System tables are enabled or disabled for the entire account: creating this configuration enables them. If a…
  • POSTCreate work group/#X-Amz-Target=AmazonAthena.CreateWorkGroupCreates a workgroup with the specified name. A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup.
  • POSTDelete capacity reservation/#X-Amz-Target=AmazonAthena.DeleteCapacityReservationDeletes a cancelled capacity reservation. A reservation must be cancelled before it can be deleted. A deleted reservation is immediately removed from your…
  • POSTDelete data catalog/#X-Amz-Target=AmazonAthena.DeleteDataCatalogDeletes a data catalog.
  • POSTDelete named query/#X-Amz-Target=AmazonAthena.DeleteNamedQueryDeletes the named query if you have access to the workgroup in which the query was saved.
  • POSTDelete notebook/#X-Amz-Target=AmazonAthena.DeleteNotebookDeletes the specified notebook.
  • POSTDelete prepared statement/#X-Amz-Target=AmazonAthena.DeletePreparedStatementDeletes the prepared statement with the specified name from the specified workgroup.
  • POSTDelete system table configuration/#X-Amz-Target=AmazonAthena.DeleteSystemTableConfigurationDisables system tables for the current account by deleting the account-level configuration. If the configuration doesn't exist, the operation succeeds without…
  • POSTDelete work group/#X-Amz-Target=AmazonAthena.DeleteWorkGroupDeletes the workgroup with the specified name. The primary workgroup cannot be deleted.
  • POSTExport notebook/#X-Amz-Target=AmazonAthena.ExportNotebookExports the specified notebook and its metadata.
  • POSTGet calculation execution/#X-Amz-Target=AmazonAthena.GetCalculationExecutionDescribes a previously submitted calculation execution.
  • POSTGet calculation execution code/#X-Amz-Target=AmazonAthena.GetCalculationExecutionCodeRetrieves the unencrypted code that was executed for the calculation.
  • POSTGet calculation execution status/#X-Amz-Target=AmazonAthena.GetCalculationExecutionStatusGets the status of a current calculation.
  • POSTGet capacity assignment configuration/#X-Amz-Target=AmazonAthena.GetCapacityAssignmentConfigurationGets the capacity assignment configuration for a capacity reservation, if one exists.
  • POSTGet capacity reservation/#X-Amz-Target=AmazonAthena.GetCapacityReservationReturns information about the capacity reservation with the specified name.
  • POSTGet data catalog/#X-Amz-Target=AmazonAthena.GetDataCatalogReturns the specified data catalog.
  • POSTGet database/#X-Amz-Target=AmazonAthena.GetDatabaseReturns a database object for the specified database and data catalog.
  • POSTGet named query/#X-Amz-Target=AmazonAthena.GetNamedQueryReturns information about a single query. Requires that you have access to the workgroup in which the query was saved.
  • POSTGet notebook metadata/#X-Amz-Target=AmazonAthena.GetNotebookMetadataRetrieves notebook metadata for the specified notebook ID.
  • POSTGet prepared statement/#X-Amz-Target=AmazonAthena.GetPreparedStatementRetrieves the prepared statement with the specified name from the specified workgroup.
  • POSTGet query execution/#X-Amz-Target=AmazonAthena.GetQueryExecutionReturns 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…
  • POSTGet query results/#X-Amz-Target=AmazonAthena.GetQueryResultsStreams the results of a single query execution specified by QueryExecutionId from the Athena query results location in Amazon S3. For more information, see…
  • POSTGet query runtime statistics/#X-Amz-Target=AmazonAthena.GetQueryRuntimeStatisticsReturns query execution runtime statistics related to a single execution of a query if you have access to the workgroup in which the query ran. Statistics…
  • POSTGet resource dashboard/#X-Amz-Target=AmazonAthena.GetResourceDashboardGets the Live UI/Persistence UI for a session.
  • POSTGet session/#X-Amz-Target=AmazonAthena.GetSessionGets the full details of a previously created session, including the session status and configuration.
  • POSTGet session endpoint/#X-Amz-Target=AmazonAthena.GetSessionEndpointGets a connection endpoint and authentication token for a given session Id.
  • POSTGet session status/#X-Amz-Target=AmazonAthena.GetSessionStatusGets the current status of a session.
  • POSTGet system table configuration/#X-Amz-Target=AmazonAthena.GetSystemTableConfigurationReturns the account-level system tables configuration. Fails with a ResourceNotFoundException if system tables are not enabled for the account.
  • POSTGet table metadata/#X-Amz-Target=AmazonAthena.GetTableMetadataReturns table metadata for the specified catalog, database, and table.
  • POSTGet work group/#X-Amz-Target=AmazonAthena.GetWorkGroupReturns information about the workgroup with the specified name.
  • POSTImport notebook/#X-Amz-Target=AmazonAthena.ImportNotebookImports a single ipynb file to a Spark enabled workgroup. To import the notebook, the request must specify a value for either Payload or NoteBookS3LocationUri…
  • POSTList application dPU sizes/#X-Amz-Target=AmazonAthena.ListApplicationDPUSizesReturns the supported DPU sizes for the supported application runtimes (for example, Athena notebook version 1 ).
  • POSTList calculation executions/#X-Amz-Target=AmazonAthena.ListCalculationExecutionsLists the calculations that have been submitted to a session in descending order. Newer calculations are listed first; older calculations are listed later.
  • POSTList capacity reservations/#X-Amz-Target=AmazonAthena.ListCapacityReservationsLists the capacity reservations for the current account.
  • POSTList data catalogs/#X-Amz-Target=AmazonAthena.ListDataCatalogsLists the data catalogs in the current Amazon Web Services account. In the Athena console, data catalogs are listed as "data sources" on the Data sources page…
  • POSTList databases/#X-Amz-Target=AmazonAthena.ListDatabasesLists the databases in the specified data catalog.
  • POSTList engine versions/#X-Amz-Target=AmazonAthena.ListEngineVersionsReturns a list of engine versions that are available to choose from, including the Auto option.
  • POSTList executors/#X-Amz-Target=AmazonAthena.ListExecutorsLists, in descending order, the executors that joined a session. Newer executors are listed first; older executors are listed later. The result can be…
  • POSTList named queries/#X-Amz-Target=AmazonAthena.ListNamedQueriesProvides 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…
  • POSTList notebook metadata/#X-Amz-Target=AmazonAthena.ListNotebookMetadataDisplays the notebook files for the specified workgroup in paginated format.
  • POSTList notebook sessions/#X-Amz-Target=AmazonAthena.ListNotebookSessionsLists, in descending order, the sessions that have been created in a notebook that are in an active state like CREATING , CREATED , IDLE or BUSY . Newer…
  • POSTList prepared statements/#X-Amz-Target=AmazonAthena.ListPreparedStatementsLists the prepared statements in the specified workgroup.
  • POSTList query executions/#X-Amz-Target=AmazonAthena.ListQueryExecutionsProvides a list of available query execution IDs for the queries in the specified workgroup. Athena keeps a query history for 45 days. If a workgroup is not…
  • POSTList sessions/#X-Amz-Target=AmazonAthena.ListSessionsLists the sessions in a workgroup that are in an active state like CREATING , CREATED , IDLE , or BUSY . Newer sessions are listed first; older sessions are…
  • POSTList system table statuses/#X-Amz-Target=AmazonAthena.ListSystemTableStatusesLists the system tables that the account-level configuration activates, along with whether each is currently enabled. Because system tables are enabled at the…
  • POSTList table metadata/#X-Amz-Target=AmazonAthena.ListTableMetadataLists the metadata for the tables in the specified data catalog database.
  • POSTList tags for resource/#X-Amz-Target=AmazonAthena.ListTagsForResourceLists the tags associated with an Athena resource.
  • POSTList work groups/#X-Amz-Target=AmazonAthena.ListWorkGroupsLists available workgroups for the account.
  • POSTPut capacity assignment configuration/#X-Amz-Target=AmazonAthena.PutCapacityAssignmentConfigurationPuts a new capacity assignment configuration for a specified capacity reservation. If a capacity assignment configuration already exists for the capacity…
  • POSTStart calculation execution/#X-Amz-Target=AmazonAthena.StartCalculationExecutionSubmits calculations for execution within a session. You can supply the code to run as an inline code block within the request. The request syntax requires…
  • POSTStart query execution/#X-Amz-Target=AmazonAthena.StartQueryExecutionRuns the SQL query statements contained in the Query . Requires you to have access to the workgroup in which the query ran. Running queries against an…
  • POSTStart session/#X-Amz-Target=AmazonAthena.StartSessionCreates a session for running calculations within a workgroup. The session is ready when it reaches an IDLE state.
  • POSTStop calculation execution/#X-Amz-Target=AmazonAthena.StopCalculationExecutionRequests the cancellation of a calculation. A StopCalculationExecution call on a calculation that is already in a terminal state (for example, STOPPED ,…
  • POSTStop query execution/#X-Amz-Target=AmazonAthena.StopQueryExecutionStops a query execution. Requires you to have access to the workgroup in which the query ran.
  • POSTTag resource/#X-Amz-Target=AmazonAthena.TagResourceAdds one or more tags to an Athena resource. A tag is a label that you assign to a resource. Each tag consists of a key and an optional value, both of which…
  • POSTTerminate session/#X-Amz-Target=AmazonAthena.TerminateSessionTerminates an active session. A TerminateSession call on a session that is already inactive (for example, in a FAILED , TERMINATED or TERMINATING state)…
  • POSTUntag resource/#X-Amz-Target=AmazonAthena.UntagResourceRemoves one or more tags from an Athena resource.
  • POSTUpdate capacity reservation/#X-Amz-Target=AmazonAthena.UpdateCapacityReservationUpdates the number of requested data processing units for the capacity reservation with the specified name.
  • POSTUpdate data catalog/#X-Amz-Target=AmazonAthena.UpdateDataCatalogUpdates the data catalog that has the specified name.
  • POSTUpdate named query/#X-Amz-Target=AmazonAthena.UpdateNamedQueryUpdates a NamedQuery object. The database or workgroup cannot be updated.
  • POSTUpdate notebook/#X-Amz-Target=AmazonAthena.UpdateNotebookUpdates the contents of a Spark notebook.
  • POSTUpdate notebook metadata/#X-Amz-Target=AmazonAthena.UpdateNotebookMetadataUpdates the metadata for a notebook.
  • POSTUpdate prepared statement/#X-Amz-Target=AmazonAthena.UpdatePreparedStatementUpdates a prepared statement.
  • POSTUpdate system table configuration/#X-Amz-Target=AmazonAthena.UpdateSystemTableConfigurationUpdates the account-level system tables configuration. If no configuration exists, use CreateSystemTableConfiguration to create one. Fields that you omit…
  • POSTUpdate work group/#X-Amz-Target=AmazonAthena.UpdateWorkGroupUpdates the workgroup with the specified name. The workgroup's name cannot be changed. Only ConfigurationUpdates can be specified.

API details

Base URL
https://athena.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
75 operations on 75 pathsPOST 75
Description format
AWS Smithy model, API version 2017-05-18

How to test the Amazon Athena in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Athena collection, without the publisher's secrets.
  3. 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.
  4. Send a requestPick an endpoint, for example “Batch get named query” (POST /#X-Amz-Target=AmazonAthena.BatchGetNamedQuery), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Athena?

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… It is listed under Data & analytics and has 75 endpoints.

Who publishes the Amazon Athena?

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 Amazon Athena?

Requests go to https://athena.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Athena?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Athena have?

75 operations on 75 paths (75 POST).

Is forking the Amazon Athena free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.