com.amazonaws.services.athena

Interface AmazonAthena

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.

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.

Method Summary

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.
DeleteNamedQueryResult	deleteNamedQuery(DeleteNamedQueryRequest deleteNamedQueryRequest) Deletes a named query.
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.
GetQueryResultsResult	getQueryResults(GetQueryResultsRequest getQueryResultsRequest) Returns the results of a single query execution specified by QueryExecutionId.
ListNamedQueriesResult	listNamedQueries(ListNamedQueriesRequest listNamedQueriesRequest) Provides a list of all available query IDs.
ListQueryExecutionsResult	listQueryExecutions(ListQueryExecutionsRequest listQueryExecutionsRequest) Provides a list of all available query execution IDs.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartQueryExecutionResult	startQueryExecution(StartQueryExecutionRequest startQueryExecutionRequest) Runs (executes) the SQL query statements contained in the Query string.
StopQueryExecutionResult	stopQueryExecution(StopQueryExecutionRequest stopQueryExecutionRequest) Stops a query execution.

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. 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.

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. 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.

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.

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

deleteNamedQuery

DeleteNamedQueryResult deleteNamedQuery(DeleteNamedQueryRequest deleteNamedQueryRequest)

Deletes a named query.

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

getNamedQuery

GetNamedQueryResult getNamedQuery(GetNamedQueryRequest getNamedQueryRequest)

Returns information about a single query.

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. 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. 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

listNamedQueries

ListNamedQueriesResult listNamedQueries(ListNamedQueriesRequest listNamedQueriesRequest)

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.

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 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.

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

startQueryExecution

StartQueryExecutionResult startQueryExecution(StartQueryExecutionRequest startQueryExecutionRequest)

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.

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.

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

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.