AbstractAmazonAthena (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.athena.AbstractAmazonAthena

All Implemented Interfaces:

AmazonAthena

Direct Known Subclasses:

AbstractAmazonAthenaAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonAthena
extends Object
implements AmazonAthena
```
Abstract implementation of AmazonAthena. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.athena.AmazonAthena
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchGetNamedQueryResult`	`batchGetNamedQuery(BatchGetNamedQueryRequest request)` 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.
`BatchGetQueryExecutionResult`	`batchGetQueryExecution(BatchGetQueryExecutionRequest request)` 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.
`CreateDataCatalogResult`	`createDataCatalog(CreateDataCatalogRequest request)` Creates (registers) a data catalog with the specified name and properties.
`CreateNamedQueryResult`	`createNamedQuery(CreateNamedQueryRequest request)` Creates a named query in the specified workgroup.
`CreateWorkGroupResult`	`createWorkGroup(CreateWorkGroupRequest request)` Creates a workgroup with the specified name.
`DeleteDataCatalogResult`	`deleteDataCatalog(DeleteDataCatalogRequest request)` Deletes a data catalog.
`DeleteNamedQueryResult`	`deleteNamedQuery(DeleteNamedQueryRequest request)` Deletes the named query if you have access to the workgroup in which the query was saved.
`DeleteWorkGroupResult`	`deleteWorkGroup(DeleteWorkGroupRequest request)` Deletes the workgroup with the specified name.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetDatabaseResult`	`getDatabase(GetDatabaseRequest request)` Returns a database object for the specfied database and data catalog.
`GetDataCatalogResult`	`getDataCatalog(GetDataCatalogRequest request)` Returns the specified data catalog.
`GetNamedQueryResult`	`getNamedQuery(GetNamedQueryRequest request)` Returns information about a single query.
`GetQueryExecutionResult`	`getQueryExecution(GetQueryExecutionRequest request)` Returns information about a single execution of a query if you have access to the workgroup in which the query ran.
`GetQueryResultsResult`	`getQueryResults(GetQueryResultsRequest request)` Streams the results of a single query execution specified by `QueryExecutionId` from the Athena query results location in Amazon S3.
`GetTableMetadataResult`	`getTableMetadata(GetTableMetadataRequest request)` Returns table metadata for the specified catalog, database, and table.
`GetWorkGroupResult`	`getWorkGroup(GetWorkGroupRequest request)` Returns information about the workgroup with the specified name.
`ListDatabasesResult`	`listDatabases(ListDatabasesRequest request)` Lists the databases in the specified data catalog.
`ListDataCatalogsResult`	`listDataCatalogs(ListDataCatalogsRequest request)` Lists the data catalogs in the current AWS account.
`ListNamedQueriesResult`	`listNamedQueries(ListNamedQueriesRequest request)` Provides a list of available query IDs only for queries saved in the specified workgroup.
`ListQueryExecutionsResult`	`listQueryExecutions(ListQueryExecutionsRequest request)` Provides a list of available query execution IDs for the queries in the specified workgroup.
`ListTableMetadataResult`	`listTableMetadata(ListTableMetadataRequest request)` Lists the metadata for the tables in the specified data catalog database.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Lists the tags associated with an Athena workgroup or data catalog resource.
`ListWorkGroupsResult`	`listWorkGroups(ListWorkGroupsRequest request)` Lists available workgroups for the account.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartQueryExecutionResult`	`startQueryExecution(StartQueryExecutionRequest request)` Runs the SQL query statements contained in the `Query`.
`StopQueryExecutionResult`	`stopQueryExecution(StopQueryExecutionRequest request)` Stops a query execution.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Adds one or more tags to an Athena resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes one or more tags from a data catalog or workgroup resource.
`UpdateDataCatalogResult`	`updateDataCatalog(UpdateDataCatalogRequest request)` Updates the data catalog that has the specified name.
`UpdateWorkGroupResult`	`updateWorkGroup(UpdateWorkGroupRequest request)` Updates the workgroup with the specified name.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - batchGetNamedQuery
```
public BatchGetNamedQueryResult batchGetNamedQuery(BatchGetNamedQueryRequest request)
```
    Description copied from interface: AmazonAthena
    
    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 workgroup in which the queries were saved. Use ListNamedQueriesInput to get the list of named query IDs in the specified workgroup. If information could not be retrieved for a submitted query ID, information about the query ID submitted is listed under UnprocessedNamedQueryId. Named queries differ from executed queries. Use BatchGetQueryExecutionInput to get details about each unique query execution, and ListQueryExecutionsInput to get a list of query execution IDs.
    
    Specified by:
    
    batchGetNamedQuery in interface AmazonAthena
    
    Returns:
    
    Result of the BatchGetNamedQuery operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchGetQueryExecution
```
public BatchGetQueryExecutionResult batchGetQueryExecution(BatchGetQueryExecutionRequest request)
```
    Description copied from interface: AmazonAthena
    
    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 you to have access to the workgroup in which the queries ran. To get a list of query execution IDs, use ListQueryExecutionsInput$WorkGroup. Query executions differ from named (saved) queries. Use BatchGetNamedQueryInput to get details about named queries.
    
    Specified by:
    
    batchGetQueryExecution in interface AmazonAthena
    
    Returns:
    
    Result of the BatchGetQueryExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDataCatalog
```
public CreateDataCatalogResult createDataCatalog(CreateDataCatalogRequest request)
```
    Description copied from interface: AmazonAthena
    
    Creates (registers) a data catalog with the specified name and properties. Catalogs created are visible to all users of the same AWS account.
    
    Specified by:
    
    createDataCatalog in interface AmazonAthena
    
    Returns:
    
    Result of the CreateDataCatalog operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createNamedQuery
```
public CreateNamedQueryResult createNamedQuery(CreateNamedQueryRequest request)
```
    Description copied from interface: AmazonAthena
    
    Creates a named query in the specified workgroup. Requires that you have access to the workgroup.
    
    For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
    
    Specified by:
    
    createNamedQuery in interface AmazonAthena
    
    Returns:
    
    Result of the CreateNamedQuery operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createWorkGroup
```
public CreateWorkGroupResult createWorkGroup(CreateWorkGroupRequest request)
```
    Description copied from interface: AmazonAthena
    
    Creates a workgroup with the specified name.
    
    Specified by:
    
    createWorkGroup in interface AmazonAthena
    
    Returns:
    
    Result of the CreateWorkGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDataCatalog
```
public DeleteDataCatalogResult deleteDataCatalog(DeleteDataCatalogRequest request)
```
    Description copied from interface: AmazonAthena
    
    Deletes a data catalog.
    
    Specified by:
    
    deleteDataCatalog in interface AmazonAthena
    
    Returns:
    
    Result of the DeleteDataCatalog operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteNamedQuery
```
public DeleteNamedQueryResult deleteNamedQuery(DeleteNamedQueryRequest request)
```
    Description copied from interface: AmazonAthena
    
    Deletes the named query if you have access to the workgroup in which the query was saved.
    
    For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
    
    Specified by:
    
    deleteNamedQuery in interface AmazonAthena
    
    Returns:
    
    Result of the DeleteNamedQuery operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteWorkGroup
```
public DeleteWorkGroupResult deleteWorkGroup(DeleteWorkGroupRequest request)
```
    Description copied from interface: AmazonAthena
    
    Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.
    
    Specified by:
    
    deleteWorkGroup in interface AmazonAthena
    
    Returns:
    
    Result of the DeleteWorkGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDataCatalog
```
public GetDataCatalogResult getDataCatalog(GetDataCatalogRequest request)
```
    Description copied from interface: AmazonAthena
    
    Returns the specified data catalog.
    
    Specified by:
    
    getDataCatalog in interface AmazonAthena
    
    Returns:
    
    Result of the GetDataCatalog operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDatabase
```
public GetDatabaseResult getDatabase(GetDatabaseRequest request)
```
    Description copied from interface: AmazonAthena
    
    Returns a database object for the specfied database and data catalog.
    
    Specified by:
    
    getDatabase in interface AmazonAthena
    
    Returns:
    
    Result of the GetDatabase operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getNamedQuery
```
public GetNamedQueryResult getNamedQuery(GetNamedQueryRequest request)
```
    Description copied from interface: AmazonAthena
    
    Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.
    
    Specified by:
    
    getNamedQuery in interface AmazonAthena
    
    Returns:
    
    Result of the GetNamedQuery operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getQueryExecution
```
public GetQueryExecutionResult getQueryExecution(GetQueryExecutionRequest request)
```
    Description copied from interface: AmazonAthena
    
    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 about the query execution is saved with a unique ID.
    
    Specified by:
    
    getQueryExecution in interface AmazonAthena
    
    Returns:
    
    Result of the GetQueryExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getQueryResults
```
public GetQueryResultsResult getQueryResults(GetQueryResultsRequest request)
```
    Description copied from interface: AmazonAthena
    
    Streams the results of a single query execution specified by QueryExecutionId from the Athena query results location in Amazon S3. For more information, see Query Results in the Amazon Athena User Guide. This request does not execute the query but returns results. Use StartQueryExecution to run a query.
    
    To stream query results successfully, the IAM principal with permission to call GetQueryResults also must have permissions to the Amazon S3 GetObject action for the Athena query results location.
    
    IAM principals with permission to the Amazon S3 GetObject action for the query results location are able to retrieve query results from Amazon S3 even if permission to the GetQueryResults action is denied. To restrict user or role access, ensure that Amazon S3 permissions to the Athena query location are denied.
    
    Specified by:
    
    getQueryResults in interface AmazonAthena
    
    Returns:
    
    Result of the GetQueryResults operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getTableMetadata
```
public GetTableMetadataResult getTableMetadata(GetTableMetadataRequest request)
```
    Description copied from interface: AmazonAthena
    
    Returns table metadata for the specified catalog, database, and table.
    
    Specified by:
    
    getTableMetadata in interface AmazonAthena
    
    Returns:
    
    Result of the GetTableMetadata operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getWorkGroup
```
public GetWorkGroupResult getWorkGroup(GetWorkGroupRequest request)
```
    Description copied from interface: AmazonAthena
    
    Returns information about the workgroup with the specified name.
    
    Specified by:
    
    getWorkGroup in interface AmazonAthena
    
    Returns:
    
    Result of the GetWorkGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDataCatalogs
```
public ListDataCatalogsResult listDataCatalogs(ListDataCatalogsRequest request)
```
    Description copied from interface: AmazonAthena
    
    Lists the data catalogs in the current AWS account.
    
    Specified by:
    
    listDataCatalogs in interface AmazonAthena
    
    Returns:
    
    Result of the ListDataCatalogs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDatabases
```
public ListDatabasesResult listDatabases(ListDatabasesRequest request)
```
    Description copied from interface: AmazonAthena
    
    Lists the databases in the specified data catalog.
    
    Specified by:
    
    listDatabases in interface AmazonAthena
    
    Returns:
    
    Result of the ListDatabases operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listNamedQueries
```
public ListNamedQueriesResult listNamedQueries(ListNamedQueriesRequest request)
```
    Description copied from interface: AmazonAthena
    
    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 workgroup is not specified, lists the saved queries for the primary workgroup.
    
    For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
    
    Specified by:
    
    listNamedQueries in interface AmazonAthena
    
    Returns:
    
    Result of the ListNamedQueries operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listQueryExecutions
```
public ListQueryExecutionsResult listQueryExecutions(ListQueryExecutionsRequest request)
```
    Description copied from interface: AmazonAthena
    
    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 execution IDs for the primary workgroup. Requires you to have access to the workgroup in which the queries ran.
    
    For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
    
    Specified by:
    
    listQueryExecutions in interface AmazonAthena
    
    Returns:
    
    Result of the ListQueryExecutions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTableMetadata
```
public ListTableMetadataResult listTableMetadata(ListTableMetadataRequest request)
```
    Description copied from interface: AmazonAthena
    
    Lists the metadata for the tables in the specified data catalog database.
    
    Specified by:
    
    listTableMetadata in interface AmazonAthena
    
    Returns:
    
    Result of the ListTableMetadata operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AmazonAthena
    
    Lists the tags associated with an Athena workgroup or data catalog resource.
    
    Specified by:
    
    listTagsForResource in interface AmazonAthena
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listWorkGroups
```
public ListWorkGroupsResult listWorkGroups(ListWorkGroupsRequest request)
```
    Description copied from interface: AmazonAthena
    
    Lists available workgroups for the account.
    
    Specified by:
    
    listWorkGroups in interface AmazonAthena
    
    Returns:
    
    Result of the ListWorkGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startQueryExecution
```
public StartQueryExecutionResult startQueryExecution(StartQueryExecutionRequest request)
```
    Description copied from interface: AmazonAthena
    
    Runs 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 external catalog requires GetDataCatalog permission to the catalog. For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
    
    Specified by:
    
    startQueryExecution in interface AmazonAthena
    
    Returns:
    
    Result of the StartQueryExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopQueryExecution
```
public StopQueryExecutionResult stopQueryExecution(StopQueryExecutionRequest request)
```
    Description copied from interface: AmazonAthena
    
    Stops a query execution. Requires you to have access to the workgroup in which the query ran.
    
    For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
    
    Specified by:
    
    stopQueryExecution in interface AmazonAthena
    
    Returns:
    
    Result of the StopQueryExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AmazonAthena
    
    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 consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena workgroups or data catalogs by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups or data catalogs in your account. For best practices, see Tagging Best Practices. Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one tag, separate them by commas.
    
    Specified by:
    
    tagResource in interface AmazonAthena
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AmazonAthena
    
    Removes one or more tags from a data catalog or workgroup resource.
    
    Specified by:
    
    untagResource in interface AmazonAthena
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateDataCatalog
```
public UpdateDataCatalogResult updateDataCatalog(UpdateDataCatalogRequest request)
```
    Description copied from interface: AmazonAthena
    
    Updates the data catalog that has the specified name.
    
    Specified by:
    
    updateDataCatalog in interface AmazonAthena
    
    Returns:
    
    Result of the UpdateDataCatalog operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateWorkGroup
```
public UpdateWorkGroupResult updateWorkGroup(UpdateWorkGroupRequest request)
```
    Description copied from interface: AmazonAthena
    
    Updates the workgroup with the specified name. The workgroup's name cannot be changed.
    
    Specified by:
    
    updateWorkGroup in interface AmazonAthena
    
    Returns:
    
    Result of the UpdateWorkGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonAthena
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonAthena
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonAthena
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonAthena
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAmazonAthena

Field Summary

Fields inherited from interface com.amazonaws.services.athena.AmazonAthena

Method Summary

Methods inherited from class java.lang.Object

Method Detail

batchGetNamedQuery

batchGetQueryExecution

createDataCatalog

createNamedQuery

createWorkGroup

deleteDataCatalog

deleteNamedQuery

deleteWorkGroup

getDataCatalog

getDatabase

getNamedQuery

getQueryExecution

getQueryResults

getTableMetadata

getWorkGroup

listDataCatalogs

listDatabases

listNamedQueries

listQueryExecutions

listTableMetadata

listTagsForResource

listWorkGroups

startQueryExecution

stopQueryExecution

tagResource

untagResource

updateDataCatalog

updateWorkGroup

shutdown

getCachedResponseMetadata