AmazonAthena (AWS SDK for Java

All Known Subinterfaces:

AmazonAthenaAsync

All Known Implementing Classes:

AbstractAmazonAthena, AbstractAmazonAthenaAsync, AmazonAthenaAsyncClient, AmazonAthenaClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonAthena
```
Interface for accessing Amazon Athena.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonAthena instead.

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.

For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`BatchGetNamedQueryResult`	`batchGetNamedQuery(BatchGetNamedQueryRequest batchGetNamedQueryRequest)` 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 batchGetQueryExecutionRequest)` 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.
`CreateNamedQueryResult`	`createNamedQuery(CreateNamedQueryRequest createNamedQueryRequest)` Creates a named query in the specified workgroup.
`CreateWorkGroupResult`	`createWorkGroup(CreateWorkGroupRequest createWorkGroupRequest)` Creates a workgroup with the specified name.
`DeleteNamedQueryResult`	`deleteNamedQuery(DeleteNamedQueryRequest deleteNamedQueryRequest)` Deletes the named query if you have access to the workgroup in which the query was saved.
`DeleteWorkGroupResult`	`deleteWorkGroup(DeleteWorkGroupRequest deleteWorkGroupRequest)` 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.
`GetNamedQueryResult`	`getNamedQuery(GetNamedQueryRequest getNamedQueryRequest)` Returns information about a single query.
`GetQueryExecutionResult`	`getQueryExecution(GetQueryExecutionRequest getQueryExecutionRequest)` Returns information about a single execution of a query if you have access to the workgroup in which the query ran.
`GetQueryResultsResult`	`getQueryResults(GetQueryResultsRequest getQueryResultsRequest)` Returns the results of a single query execution specified by `QueryExecutionId` if you have access to the workgroup in which the query ran.
`GetWorkGroupResult`	`getWorkGroup(GetWorkGroupRequest getWorkGroupRequest)` Returns information about the workgroup with the specified name.
`ListNamedQueriesResult`	`listNamedQueries(ListNamedQueriesRequest listNamedQueriesRequest)` Provides a list of available query IDs only for queries saved in the specified workgroup.
`ListQueryExecutionsResult`	`listQueryExecutions(ListQueryExecutionsRequest listQueryExecutionsRequest)` Provides a list of available query execution IDs for the queries in the specified workgroup.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Lists the tags associated with this workgroup.
`ListWorkGroupsResult`	`listWorkGroups(ListWorkGroupsRequest listWorkGroupsRequest)` Lists available workgroups for the account.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartQueryExecutionResult`	`startQueryExecution(StartQueryExecutionRequest startQueryExecutionRequest)` Runs the SQL query statements contained in the `Query`.
`StopQueryExecutionResult`	`stopQueryExecution(StopQueryExecutionRequest stopQueryExecutionRequest)` Stops a query execution.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Adds one or more tags to the resource, such as a workgroup.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Removes one or more tags from the workgroup resource.
`UpdateWorkGroupResult`	`updateWorkGroup(UpdateWorkGroupRequest updateWorkGroupRequest)` Updates the workgroup with the specified name.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - batchGetNamedQuery
```
BatchGetNamedQueryResult batchGetNamedQuery(BatchGetNamedQueryRequest batchGetNamedQueryRequest)
```
    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.
    
    Parameters:
    
    batchGetNamedQueryRequest -
    
    Returns:
    
    Result of the BatchGetNamedQuery operation returned by the service.
    
    Throws:
    
    InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
    
    See Also:
    
    AWS API Documentation
  - batchGetQueryExecution
```
BatchGetQueryExecutionResult batchGetQueryExecution(BatchGetQueryExecutionRequest batchGetQueryExecutionRequest)
```
    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.
    
    Parameters:
    
    batchGetQueryExecutionRequest -
    
    Returns:
    
    Result of the BatchGetQueryExecution operation returned by the service.
    
    Throws:
    
    InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
    
    See Also:
    
    AWS API Documentation
  - createNamedQuery
```
CreateNamedQueryResult createNamedQuery(CreateNamedQueryRequest createNamedQueryRequest)
```
    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.
    
    Parameters:
    
    createNamedQueryRequest -
    
    Returns:
    
    Result of the CreateNamedQuery operation returned by the service.
    
    Throws:
    
    InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
    
    See Also:
    
    AWS API Documentation
  - createWorkGroup
```
CreateWorkGroupResult createWorkGroup(CreateWorkGroupRequest createWorkGroupRequest)
```
    Creates a workgroup with the specified name.
    
    Parameters:
    
    createWorkGroupRequest -
    
    Returns:
    
    Result of the CreateWorkGroup operation returned by the service.
    
    Throws:
    
    InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
    
    See Also:
    
    AWS API Documentation
  - deleteNamedQuery
```
DeleteNamedQueryResult deleteNamedQuery(DeleteNamedQueryRequest deleteNamedQueryRequest)
```
    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.
    
    Parameters:
    
    deleteNamedQueryRequest -
    
    Returns:
    
    Result of the DeleteNamedQuery operation returned by the service.
    
    Throws:
    
    InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
    
    See Also:
    
    AWS API Documentation
  - deleteWorkGroup
```
DeleteWorkGroupResult deleteWorkGroup(DeleteWorkGroupRequest deleteWorkGroupRequest)
```
    Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.
    
    Parameters:
    
    deleteWorkGroupRequest -
    
    Returns:
    
    Result of the DeleteWorkGroup operation returned by the service.
    
    Throws:
    
    InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
    
    See Also:
    
    AWS API Documentation
  - getNamedQuery
```
GetNamedQueryResult getNamedQuery(GetNamedQueryRequest getNamedQueryRequest)
```
    Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.
    
    Parameters:
    
    getNamedQueryRequest -
    
    Returns:
    
    Result of the GetNamedQuery operation returned by the service.
    
    Throws:
    
    InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
    
    See Also:
    
    AWS API Documentation
  - getQueryExecution
```
GetQueryExecutionResult getQueryExecution(GetQueryExecutionRequest getQueryExecutionRequest)
```
    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.
    
    Parameters:
    
    getQueryExecutionRequest -
    
    Returns:
    
    Result of the GetQueryExecution operation returned by the service.
    
    Throws:
    
    InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
    
    See Also:
    
    AWS API Documentation
  - getQueryResults
```
GetQueryResultsResult getQueryResults(GetQueryResultsRequest getQueryResultsRequest)
```
    Returns the results of a single query execution specified by QueryExecutionId if you have access to the workgroup in which the query ran. This request does not execute the query but returns results. Use StartQueryExecution to run a query.
    
    Parameters:
    
    getQueryResultsRequest -
    
    Returns:
    
    Result of the GetQueryResults operation returned by the service.
    
    Throws:
    
    InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
    
    See Also:
    
    AWS API Documentation
  - getWorkGroup
```
GetWorkGroupResult getWorkGroup(GetWorkGroupRequest getWorkGroupRequest)
```
    Returns information about the workgroup with the specified name.
    
    Parameters:
    
    getWorkGroupRequest -
    
    Returns:
    
    Result of the GetWorkGroup operation returned by the service.
    
    Throws:
    
    InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
    
    See Also:
    
    AWS API Documentation
  - listNamedQueries
```
ListNamedQueriesResult listNamedQueries(ListNamedQueriesRequest listNamedQueriesRequest)
```
    Provides a list of available query IDs only for queries saved 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.
    
    Parameters:
    
    listNamedQueriesRequest -
    
    Returns:
    
    Result of the ListNamedQueries operation returned by the service.
    
    Throws:
    
    InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
    
    See Also:
    
    AWS API Documentation
  - listQueryExecutions
```
ListQueryExecutionsResult listQueryExecutions(ListQueryExecutionsRequest listQueryExecutionsRequest)
```
    Provides a list of available query execution IDs for the queries in the specified 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.
    
    Parameters:
    
    listQueryExecutionsRequest -
    
    Returns:
    
    Result of the ListQueryExecutions operation returned by the service.
    
    Throws:
    
    InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Lists the tags associated with this workgroup.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
    
    ResourceNotFoundException - A resource, such as a workgroup, was not found.
    
    See Also:
    
    AWS API Documentation
  - listWorkGroups
```
ListWorkGroupsResult listWorkGroups(ListWorkGroupsRequest listWorkGroupsRequest)
```
    Lists available workgroups for the account.
    
    Parameters:
    
    listWorkGroupsRequest -
    
    Returns:
    
    Result of the ListWorkGroups operation returned by the service.
    
    Throws:
    
    InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
    
    See Also:
    
    AWS API Documentation
  - startQueryExecution
```
StartQueryExecutionResult startQueryExecution(StartQueryExecutionRequest startQueryExecutionRequest)
```
    Runs the SQL query statements contained in the Query. 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.
    
    Parameters:
    
    startQueryExecutionRequest -
    
    Returns:
    
    Result of the StartQueryExecution operation returned by the service.
    
    Throws:
    
    InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
    
    TooManyRequestsException - Indicates that the request was throttled.
    
    See Also:
    
    AWS API Documentation
  - stopQueryExecution
```
StopQueryExecutionResult stopQueryExecution(StopQueryExecutionRequest stopQueryExecutionRequest)
```
    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.
    
    Parameters:
    
    stopQueryExecutionRequest -
    
    Returns:
    
    Result of the StopQueryExecution operation returned by the service.
    
    Throws:
    
    InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    Adds one or more tags to the resource, such as a workgroup. A tag is a label that you assign to an AWS Athena resource (a workgroup). Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize resources (workgroups) in Athena, for example, by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups in your account. For best practices, see AWS Tagging Strategies. The key length is from 1 (minimum) to 128 (maximum) Unicode characters in UTF-8. The tag value length is from 0 (minimum) to 256 (maximum) Unicode characters in UTF-8. You 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, separate them by commas.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
    
    ResourceNotFoundException - A resource, such as a workgroup, was not found.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Removes one or more tags from the workgroup resource. Takes as an input a list of TagKey Strings separated by commas, and removes their tags at the same time.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
    
    ResourceNotFoundException - A resource, such as a workgroup, was not found.
    
    See Also:
    
    AWS API Documentation
  - updateWorkGroup
```
UpdateWorkGroupResult updateWorkGroup(UpdateWorkGroupRequest updateWorkGroupRequest)
```
    Updates the workgroup with the specified name. The workgroup's name cannot be changed.
    
    Parameters:
    
    updateWorkGroupRequest -
    
    Returns:
    
    Result of the UpdateWorkGroup operation returned by the service.
    
    Throws:
    
    InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    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.
  - getCachedResponseMetadata
```
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. 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.
    
    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?

Interface AmazonAthena

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

batchGetNamedQuery

batchGetQueryExecution

createNamedQuery

createWorkGroup

deleteNamedQuery

deleteWorkGroup

getNamedQuery

getQueryExecution

getQueryResults

getWorkGroup

listNamedQueries

listQueryExecutions

listTagsForResource

listWorkGroups

startQueryExecution

stopQueryExecution

tagResource

untagResource

updateWorkGroup

shutdown

getCachedResponseMetadata