com.amazonaws.services.athena.AmazonAthena Maven / Gradle / Ivy
Show all versions of aws-java-sdk-athena Show documentation
/*
* Copyright 2012-2017 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.
*
*
* 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. Use ListNamedQueries to get the list of named query IDs. If information could not be retrieved
* for a submitted query ID, information about the query ID submitted is listed under
* UnprocessedNamedQueryId. Named queries are different from executed queries. Use
* BatchGetQueryExecution to get details about each unique query execution, and ListQueryExecutions 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. To get a list of query execution IDs, use ListQueryExecutions. Query
* executions are different from named (saved) queries. Use BatchGetNamedQuery 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 a named query.
*
*
* 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);
/**
*
* Deletes a named query.
*
*
* 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);
/**
*
* Returns information about a single query.
*
*
* @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. 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);
/**
*
* Returns the results of a single query execution specified by QueryExecutionId. This request does not
* execute the query but returns results. Use StartQueryExecution to run a query.
*
*
* @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);
/**
*
* Provides a list of all available query IDs.
*
*
* 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 all available query execution IDs.
*
*
* 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);
/**
*
* Runs (executes) the SQL query statements contained in the Query string.
*
*
* 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.
*
*
* 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);
/**
* 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);
}