com.amazonaws.services.athena.AmazonAthena Maven / Gradle / Ivy
Show all versions of aws-java-sdk-athena Show documentation
/*
* Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.athena;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.athena.model.*;
/**
* Interface for accessing Amazon Athena.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.athena.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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonAthena {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "athena";
/**
*
* 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.
*
*
* @param batchGetNamedQueryRequest
* @return 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.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.BatchGetNamedQuery
* @see AWS API
* Documentation
*/
BatchGetNamedQueryResult batchGetNamedQuery(BatchGetNamedQueryRequest batchGetNamedQueryRequest);
/**
*
* 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.
*
*
* @param batchGetQueryExecutionRequest
* @return 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.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.BatchGetQueryExecution
* @see AWS
* API Documentation
*/
BatchGetQueryExecutionResult batchGetQueryExecution(BatchGetQueryExecutionRequest batchGetQueryExecutionRequest);
/**
*
* Creates (registers) a data catalog with the specified name and properties. Catalogs created are visible to all
* users of the same AWS account.
*
*
* @param createDataCatalogRequest
* @return Result of the CreateDataCatalog operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.CreateDataCatalog
* @see AWS API
* Documentation
*/
CreateDataCatalogResult createDataCatalog(CreateDataCatalogRequest createDataCatalogRequest);
/**
*
* 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.
*
*
* @param createNamedQueryRequest
* @return 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.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.CreateNamedQuery
* @see AWS API
* Documentation
*/
CreateNamedQueryResult createNamedQuery(CreateNamedQueryRequest createNamedQueryRequest);
/**
*
* Creates a workgroup with the specified name.
*
*
* @param createWorkGroupRequest
* @return 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.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.CreateWorkGroup
* @see AWS API
* Documentation
*/
CreateWorkGroupResult createWorkGroup(CreateWorkGroupRequest createWorkGroupRequest);
/**
*
* Deletes a data catalog.
*
*
* @param deleteDataCatalogRequest
* @return Result of the DeleteDataCatalog operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.DeleteDataCatalog
* @see AWS API
* Documentation
*/
DeleteDataCatalogResult deleteDataCatalog(DeleteDataCatalogRequest deleteDataCatalogRequest);
/**
*
* 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.
*
*
* @param deleteNamedQueryRequest
* @return 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.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.DeleteNamedQuery
* @see AWS API
* Documentation
*/
DeleteNamedQueryResult deleteNamedQuery(DeleteNamedQueryRequest deleteNamedQueryRequest);
/**
*
* Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.
*
*
* @param deleteWorkGroupRequest
* @return 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.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.DeleteWorkGroup
* @see AWS API
* Documentation
*/
DeleteWorkGroupResult deleteWorkGroup(DeleteWorkGroupRequest deleteWorkGroupRequest);
/**
*
* Returns the specified data catalog.
*
*
* @param getDataCatalogRequest
* @return Result of the GetDataCatalog operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.GetDataCatalog
* @see AWS API
* Documentation
*/
GetDataCatalogResult getDataCatalog(GetDataCatalogRequest getDataCatalogRequest);
/**
*
* Returns a database object for the specified database and data catalog.
*
*
* @param getDatabaseRequest
* @return Result of the GetDatabase operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws MetadataException
* An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by
* user input (InvalidRequestException) or from the Athena platform (
* InternalServerException). For example, if a user-created Lambda function is missing
* permissions, the Lambda 4XX exception is returned in a MetadataException.
* @sample AmazonAthena.GetDatabase
* @see AWS API
* Documentation
*/
GetDatabaseResult getDatabase(GetDatabaseRequest getDatabaseRequest);
/**
*
* Returns information about a single query. Requires that you have access to the workgroup in which the query was
* saved.
*
*
* @param getNamedQueryRequest
* @return 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.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.GetNamedQuery
* @see AWS API
* Documentation
*/
GetNamedQueryResult getNamedQuery(GetNamedQueryRequest getNamedQueryRequest);
/**
*
* 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.
*
*
* @param getQueryExecutionRequest
* @return 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.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.GetQueryExecution
* @see AWS API
* Documentation
*/
GetQueryExecutionResult getQueryExecution(GetQueryExecutionRequest getQueryExecutionRequest);
/**
*
* 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.
*
*
*
* @param getQueryResultsRequest
* @return 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.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.GetQueryResults
* @see AWS API
* Documentation
*/
GetQueryResultsResult getQueryResults(GetQueryResultsRequest getQueryResultsRequest);
/**
*
* Returns table metadata for the specified catalog, database, and table.
*
*
* @param getTableMetadataRequest
* @return Result of the GetTableMetadata operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws MetadataException
* An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by
* user input (InvalidRequestException) or from the Athena platform (
* InternalServerException). For example, if a user-created Lambda function is missing
* permissions, the Lambda 4XX exception is returned in a MetadataException.
* @sample AmazonAthena.GetTableMetadata
* @see AWS API
* Documentation
*/
GetTableMetadataResult getTableMetadata(GetTableMetadataRequest getTableMetadataRequest);
/**
*
* Returns information about the workgroup with the specified name.
*
*
* @param getWorkGroupRequest
* @return 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.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.GetWorkGroup
* @see AWS API
* Documentation
*/
GetWorkGroupResult getWorkGroup(GetWorkGroupRequest getWorkGroupRequest);
/**
*
* Lists the data catalogs in the current AWS account.
*
*
* @param listDataCatalogsRequest
* @return Result of the ListDataCatalogs operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.ListDataCatalogs
* @see AWS API
* Documentation
*/
ListDataCatalogsResult listDataCatalogs(ListDataCatalogsRequest listDataCatalogsRequest);
/**
*
* Lists the databases in the specified data catalog.
*
*
* @param listDatabasesRequest
* @return Result of the ListDatabases operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws MetadataException
* An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by
* user input (InvalidRequestException) or from the Athena platform (
* InternalServerException). For example, if a user-created Lambda function is missing
* permissions, the Lambda 4XX exception is returned in a MetadataException.
* @sample AmazonAthena.ListDatabases
* @see AWS API
* Documentation
*/
ListDatabasesResult listDatabases(ListDatabasesRequest listDatabasesRequest);
/**
*
* Returns a list of engine versions that are available to choose from, including the Auto option.
*
*
* @param listEngineVersionsRequest
* @return Result of the ListEngineVersions operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.ListEngineVersions
* @see AWS API
* Documentation
*/
ListEngineVersionsResult listEngineVersions(ListEngineVersionsRequest listEngineVersionsRequest);
/**
*
* 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.
*
*
* @param listNamedQueriesRequest
* @return 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.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.ListNamedQueries
* @see AWS API
* Documentation
*/
ListNamedQueriesResult listNamedQueries(ListNamedQueriesRequest listNamedQueriesRequest);
/**
*
* 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.
*
*
* @param listQueryExecutionsRequest
* @return 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.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.ListQueryExecutions
* @see AWS API
* Documentation
*/
ListQueryExecutionsResult listQueryExecutions(ListQueryExecutionsRequest listQueryExecutionsRequest);
/**
*
* Lists the metadata for the tables in the specified data catalog database.
*
*
* @param listTableMetadataRequest
* @return Result of the ListTableMetadata operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws MetadataException
* An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by
* user input (InvalidRequestException) or from the Athena platform (
* InternalServerException). For example, if a user-created Lambda function is missing
* permissions, the Lambda 4XX exception is returned in a MetadataException.
* @sample AmazonAthena.ListTableMetadata
* @see AWS API
* Documentation
*/
ListTableMetadataResult listTableMetadata(ListTableMetadataRequest listTableMetadataRequest);
/**
*
* Lists the tags associated with an Athena workgroup or data catalog resource.
*
*
* @param listTagsForResourceRequest
* @return 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.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws ResourceNotFoundException
* A resource, such as a workgroup, was not found.
* @sample AmazonAthena.ListTagsForResource
* @see AWS API
* Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Lists available workgroups for the account.
*
*
* @param listWorkGroupsRequest
* @return 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.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.ListWorkGroups
* @see AWS API
* Documentation
*/
ListWorkGroupsResult listWorkGroups(ListWorkGroupsRequest listWorkGroupsRequest);
/**
*
* 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.
*
*
* @param startQueryExecutionRequest
* @return 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.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws TooManyRequestsException
* Indicates that the request was throttled.
* @sample AmazonAthena.StartQueryExecution
* @see AWS API
* Documentation
*/
StartQueryExecutionResult startQueryExecution(StartQueryExecutionRequest startQueryExecutionRequest);
/**
*
* 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.
*
*
* @param stopQueryExecutionRequest
* @return 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.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.StopQueryExecution
* @see AWS API
* Documentation
*/
StopQueryExecutionResult stopQueryExecution(StopQueryExecutionRequest stopQueryExecutionRequest);
/**
*
* 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.
*
*
* @param tagResourceRequest
* @return 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.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws ResourceNotFoundException
* A resource, such as a workgroup, was not found.
* @sample AmazonAthena.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Removes one or more tags from a data catalog or workgroup resource.
*
*
* @param untagResourceRequest
* @return 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.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws ResourceNotFoundException
* A resource, such as a workgroup, was not found.
* @sample AmazonAthena.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Updates the data catalog that has the specified name.
*
*
* @param updateDataCatalogRequest
* @return Result of the UpdateDataCatalog operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.UpdateDataCatalog
* @see AWS API
* Documentation
*/
UpdateDataCatalogResult updateDataCatalog(UpdateDataCatalogRequest updateDataCatalogRequest);
/**
*
* Updates the workgroup with the specified name. The workgroup's name cannot be changed.
*
*
* @param updateWorkGroupRequest
* @return 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.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.UpdateWorkGroup
* @see AWS API
* Documentation
*/
UpdateWorkGroupResult updateWorkGroup(UpdateWorkGroupRequest updateWorkGroupRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}