Package software.amazon.awssdk.services.athena

Interface AthenaAsyncClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface AthenaAsyncClient
extends AutoCloseable

Service client for accessing null asynchronously. This can be created using the static builder() method.

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.

Method Summary

Modifier and Type	Method	Description
default CompletableFuture<BatchGetNamedQueryResponse>	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.
default CompletableFuture<BatchGetQueryExecutionResponse>	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.
static AthenaAsyncClientBuilder	builder()	Create a builder that can be used to configure and create a AthenaAsyncClient.
static AthenaAsyncClient	create()	Create a AthenaAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateNamedQueryResponse>	createNamedQuery(CreateNamedQueryRequest createNamedQueryRequest)	Creates a named query.
default CompletableFuture<DeleteNamedQueryResponse>	deleteNamedQuery(DeleteNamedQueryRequest deleteNamedQueryRequest)	Deletes a named query.
default CompletableFuture<GetNamedQueryResponse>	getNamedQuery(GetNamedQueryRequest getNamedQueryRequest)	Returns information about a single query.
default CompletableFuture<GetQueryExecutionResponse>	getQueryExecution(GetQueryExecutionRequest getQueryExecutionRequest)	Returns information about a single execution of a query.
default CompletableFuture<GetQueryResultsResponse>	getQueryResults(GetQueryResultsRequest getQueryResultsRequest)	Returns the results of a single query execution specified by QueryExecutionId.
default CompletableFuture<ListNamedQueriesResponse>	listNamedQueries(ListNamedQueriesRequest listNamedQueriesRequest)	Provides a list of all available query IDs.
default CompletableFuture<ListQueryExecutionsResponse>	listQueryExecutions(ListQueryExecutionsRequest listQueryExecutionsRequest)	Provides a list of all available query execution IDs.
default CompletableFuture<StartQueryExecutionResponse>	startQueryExecution(StartQueryExecutionRequest startQueryExecutionRequest)	Runs (executes) the SQL query statements contained in the Query string.
default CompletableFuture<StopQueryExecutionResponse>	stopQueryExecution(StopQueryExecutionRequest stopQueryExecutionRequest)	Stops a query execution.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

create

static AthenaAsyncClient create()

Create a AthenaAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static AthenaAsyncClientBuilder builder()

Create a builder that can be used to configure and create a AthenaAsyncClient.

batchGetNamedQuery

default CompletableFuture<BatchGetNamedQueryResponse> 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:

A Java Future containing the result of the BatchGetNamedQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

batchGetQueryExecution

default CompletableFuture<BatchGetQueryExecutionResponse> 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:

A Java Future containing the result of the BatchGetQueryExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createNamedQuery

default CompletableFuture<CreateNamedQueryResponse> 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:

A Java Future containing the result of the CreateNamedQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteNamedQuery

default CompletableFuture<DeleteNamedQueryResponse> 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:

A Java Future containing the result of the DeleteNamedQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getNamedQuery

default CompletableFuture<GetNamedQueryResponse> getNamedQuery(GetNamedQueryRequest getNamedQueryRequest)

Returns information about a single query.

Parameters:

getNamedQueryRequest -

Returns:

A Java Future containing the result of the GetNamedQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getQueryExecution

default CompletableFuture<GetQueryExecutionResponse> 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:

A Java Future containing the result of the GetQueryExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getQueryResults

default CompletableFuture<GetQueryResultsResponse> 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:

A Java Future containing the result of the GetQueryResults operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listNamedQueries

default CompletableFuture<ListNamedQueriesResponse> 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:

A Java Future containing the result of the ListNamedQueries operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listQueryExecutions

default CompletableFuture<ListQueryExecutionsResponse> 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:

A Java Future containing the result of the ListQueryExecutions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

startQueryExecution

default CompletableFuture<StartQueryExecutionResponse> 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:

A Java Future containing the result of the StartQueryExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

stopQueryExecution

default CompletableFuture<StopQueryExecutionResponse> 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:

A Java Future containing the result of the StopQueryExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation