com.amazonaws.services.athena

Class AmazonAthenaClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.athena.AmazonAthenaClient

All Implemented Interfaces:

AmazonAthena

Direct Known Subclasses:

AmazonAthenaAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonAthenaClient
extends AmazonWebServiceClient
implements AmazonAthena

Client for accessing Amazon Athena. All service calls made using this client are blocking, and will not return until the service call completes.

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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

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

ENDPOINT_PREFIX

Method Summary

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.
static AmazonAthenaClientBuilder	builder()
CreateNamedQueryResult	createNamedQuery(CreateNamedQueryRequest request) Creates a named query.
DeleteNamedQueryResult	deleteNamedQuery(DeleteNamedQueryRequest request) 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 request) Returns information about a single query.
GetQueryExecutionResult	getQueryExecution(GetQueryExecutionRequest request) Returns information about a single execution of a query.
GetQueryResultsResult	getQueryResults(GetQueryResultsRequest request) Returns the results of a single query execution specified by QueryExecutionId.
ListNamedQueriesResult	listNamedQueries(ListNamedQueriesRequest request) Provides a list of all available query IDs.
ListQueryExecutionsResult	listQueryExecutions(ListQueryExecutionsRequest request) Provides a list of all available query execution IDs.
StartQueryExecutionResult	startQueryExecution(StartQueryExecutionRequest request) Runs (executes) the SQL query statements contained in the Query string.
StopQueryExecutionResult	stopQueryExecution(StopQueryExecutionRequest request) Stops a query execution.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

shutdown

Method Detail

builder

public static AmazonAthenaClientBuilder builder()

batchGetNamedQuery

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

Specified by:

batchGetNamedQuery in interface AmazonAthena

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

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

Specified by:

batchGetQueryExecution in interface AmazonAthena

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

public CreateNamedQueryResult createNamedQuery(CreateNamedQueryRequest request)

Creates a named query.

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

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

public DeleteNamedQueryResult deleteNamedQuery(DeleteNamedQueryRequest request)

Deletes a named query.

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

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

public GetNamedQueryResult getNamedQuery(GetNamedQueryRequest request)

Returns information about a single query.

Specified by:

getNamedQuery in interface AmazonAthena

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

public GetQueryExecutionResult getQueryExecution(GetQueryExecutionRequest request)

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.

Specified by:

getQueryExecution in interface AmazonAthena

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

public GetQueryResultsResult getQueryResults(GetQueryResultsRequest request)

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.

Specified by:

getQueryResults in interface AmazonAthena

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

public ListNamedQueriesResult listNamedQueries(ListNamedQueriesRequest request)

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.

Specified by:

listNamedQueries in interface AmazonAthena

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

public ListQueryExecutionsResult listQueryExecutions(ListQueryExecutionsRequest request)

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.

Specified by:

listQueryExecutions in interface AmazonAthena

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

public StartQueryExecutionResult startQueryExecution(StartQueryExecutionRequest request)

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.

Specified by:

startQueryExecution in interface AmazonAthena

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

public StopQueryExecutionResult stopQueryExecution(StopQueryExecutionRequest request)

Stops a query execution.

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

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

getCachedResponseMetadata

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