Data retrieval APIs for Amazon Athena - AWS Online Register of Data Formats

Data retrieval APIs for Amazon Athena

Amazon Athena provides the following APIs for data retrieval.

Actions Description Access level
BatchGetNamedQueryGet information about one or more named queriesRead
BatchGetPreparedStatementGet information about one or more prepared statementsRead
BatchGetQueryExecutionGet information about one or more query executionsRead
GetCalculationExecutionGet a calculation executionRead
GetCalculationExecutionCodeGet a calculation execution codeRead
GetCalculationExecutionStatusGet a calculation execution statusRead
GetCapacityAssignmentConfigurationGet capacity assignment information for a capacity reservationRead
GetCapacityReservationGet a capacity reservationRead
GetCatalogsEnable access to databases and tables. Applies only to AWS services managed policy and principals that use an Athena JDBC driver version 1.1.0Read
GetDataCatalogGet a datacatalogRead
GetDatabaseGet a database for a given datacatalogRead
GetExecutionEngineEnable access to the specified database and table. Applies only to AWS services managed policy and principals that use an Athena JDBC driver version 1.1.0Read
GetExecutionEnginesEnable access to databases and tables. Applies only to AWS services managed policy and principals that use an Athena JDBC driver version 1.1.0Read
GetNamedQueryGet information about the specified named queryRead
GetNamespaceEnable access to the specified database and table. Applies only to AWS services managed policy and principals that use an Athena JDBC driver version 1.1.0Read
GetNamespacesEnable access to databases and tables. Applies only to AWS services managed policy and principals that use an Athena JDBC driver version 1.1.0Read
GetNotebookMetadataGet notebook metadataRead
GetPreparedStatementGet information about the specified prepared statementRead
GetQueryExecutionGet information about the specified query executionRead
GetQueryExecutionsGet query executions. Deprecated. Applies only to AWS services and principals that use Athena JDBC driver earlier than 1.1.0. Use ListQueryExecutions otherwiseRead
GetQueryResultsGet the query resultsRead
GetQueryResultsStreamGet the query results streamRead
GetQueryRuntimeStatisticsGet runtime statistics for the specified query executionRead
GetSessionGet a sessionRead
GetSessionStatusGet a session statusRead
GetTableEnable access to the specified table. Applies only to AWS services managed policy and principals that use an Athena JDBC driver version 1.1.0Read
GetTableMetadataGet a metadata about a table for a given datacatalogRead
GetTablesEnable access to tables. Applies only to AWS services managed policy and principals that use an Athena JDBC driver version 1.1.0Read
GetWorkGroupGet a workgroupRead
ListApplicationDPUSizesReturn a list of ApplicationRuntimeIdsList
ListCalculationExecutionsReturn a list of calculation executionsList
ListCapacityReservationsReturn a list of capacity reservations for the specified AWS accountList
ListDataCatalogsReturn a list of datacatalogs for the specified AWS accountList
ListDatabasesReturn a list of databases for a given datacatalogList
ListEngineVersionsReturn a list of athena engine versions for the specified AWS accountRead
ListExecutorsReturn a list of executorsList
ListNamedQueriesReturn a list of named queries in Amazon Athena for the specified AWS accountList
ListNotebookMetadataReturn a list of notebooks for a given workgroupList
ListNotebookSessionsReturn a list of sessions for a given notebookList
ListPreparedStatementsReturn a list of prepared statements for the specified workgroupList
ListQueryExecutionsReturn a list of query executions for the specified AWS accountRead
ListSessionsReturn a list of sessions for a given workgroupList
ListTableMetadataReturn a list of table metadata in a database for a given datacatalogRead
ListTagsForResourceReturn a list of tags for a resourceRead
ListWorkGroupsReturn a list of workgroups for the specified AWS accountList