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.

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 Amazon Web Services 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.
BatchGetPreparedStatementResult	batchGetPreparedStatement(BatchGetPreparedStatementRequest batchGetPreparedStatementRequest) Returns the details of a single prepared statement or a list of up to 256 prepared statements for the array of prepared statement names that you provide.
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.
CreateDataCatalogResult	createDataCatalog(CreateDataCatalogRequest createDataCatalogRequest) Creates (registers) a data catalog with the specified name and properties.
CreateNamedQueryResult	createNamedQuery(CreateNamedQueryRequest createNamedQueryRequest) Creates a named query in the specified workgroup.
CreatePreparedStatementResult	createPreparedStatement(CreatePreparedStatementRequest createPreparedStatementRequest) Creates a prepared statement for use with SQL queries in Athena.
CreateWorkGroupResult	createWorkGroup(CreateWorkGroupRequest createWorkGroupRequest) Creates a workgroup with the specified name.
DeleteDataCatalogResult	deleteDataCatalog(DeleteDataCatalogRequest deleteDataCatalogRequest) Deletes a data catalog.
DeleteNamedQueryResult	deleteNamedQuery(DeleteNamedQueryRequest deleteNamedQueryRequest) Deletes the named query if you have access to the workgroup in which the query was saved.
DeletePreparedStatementResult	deletePreparedStatement(DeletePreparedStatementRequest deletePreparedStatementRequest) Deletes the prepared statement with the specified name from the specified workgroup.
DeleteWorkGroupResult	deleteWorkGroup(DeleteWorkGroupRequest deleteWorkGroupRequest) Deletes the workgroup with the specified name.
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.
GetDatabaseResult	getDatabase(GetDatabaseRequest getDatabaseRequest) Returns a database object for the specified database and data catalog.
GetDataCatalogResult	getDataCatalog(GetDataCatalogRequest getDataCatalogRequest) Returns the specified data catalog.
GetNamedQueryResult	getNamedQuery(GetNamedQueryRequest getNamedQueryRequest) Returns information about a single query.
GetPreparedStatementResult	getPreparedStatement(GetPreparedStatementRequest getPreparedStatementRequest) Retrieves the prepared statement with the specified name from the specified workgroup.
GetQueryExecutionResult	getQueryExecution(GetQueryExecutionRequest getQueryExecutionRequest) Returns information about a single execution of a query if you have access to the workgroup in which the query ran.
GetQueryResultsResult	getQueryResults(GetQueryResultsRequest getQueryResultsRequest) Streams the results of a single query execution specified by QueryExecutionId from the Athena query results location in Amazon S3.
GetQueryRuntimeStatisticsResult	getQueryRuntimeStatistics(GetQueryRuntimeStatisticsRequest getQueryRuntimeStatisticsRequest) Returns query execution runtime statistics related to a single execution of a query if you have access to the workgroup in which the query ran.
GetTableMetadataResult	getTableMetadata(GetTableMetadataRequest getTableMetadataRequest) Returns table metadata for the specified catalog, database, and table.
GetWorkGroupResult	getWorkGroup(GetWorkGroupRequest getWorkGroupRequest) Returns information about the workgroup with the specified name.
ListDatabasesResult	listDatabases(ListDatabasesRequest listDatabasesRequest) Lists the databases in the specified data catalog.
ListDataCatalogsResult	listDataCatalogs(ListDataCatalogsRequest listDataCatalogsRequest) Lists the data catalogs in the current Amazon Web Services account.
ListEngineVersionsResult	listEngineVersions(ListEngineVersionsRequest listEngineVersionsRequest) Returns a list of engine versions that are available to choose from, including the Auto option.
ListNamedQueriesResult	listNamedQueries(ListNamedQueriesRequest listNamedQueriesRequest) Provides a list of available query IDs only for queries saved in the specified workgroup.
ListPreparedStatementsResult	listPreparedStatements(ListPreparedStatementsRequest listPreparedStatementsRequest) Lists the prepared statements in the specified workgroup.
ListQueryExecutionsResult	listQueryExecutions(ListQueryExecutionsRequest listQueryExecutionsRequest) Provides a list of available query execution IDs for the queries in the specified workgroup.
ListTableMetadataResult	listTableMetadata(ListTableMetadataRequest listTableMetadataRequest) Lists the metadata for the tables in the specified data catalog database.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags associated with an Athena workgroup or data catalog resource.
ListWorkGroupsResult	listWorkGroups(ListWorkGroupsRequest listWorkGroupsRequest) Lists available workgroups for the account.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartQueryExecutionResult	startQueryExecution(StartQueryExecutionRequest startQueryExecutionRequest) Runs the SQL query statements contained in the Query.
StopQueryExecutionResult	stopQueryExecution(StopQueryExecutionRequest stopQueryExecutionRequest) Stops a query execution.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds one or more tags to an Athena resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from a data catalog or workgroup resource.
UpdateDataCatalogResult	updateDataCatalog(UpdateDataCatalogRequest updateDataCatalogRequest) Updates the data catalog that has the specified name.
UpdateNamedQueryResult	updateNamedQuery(UpdateNamedQueryRequest updateNamedQueryRequest) Updates a NamedQuery object.
UpdatePreparedStatementResult	updatePreparedStatement(UpdatePreparedStatementRequest updatePreparedStatementRequest) Updates a prepared statement.
UpdateWorkGroupResult	updateWorkGroup(UpdateWorkGroupRequest updateWorkGroupRequest) Updates the workgroup with the specified name.

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

Parameters:

batchGetNamedQueryRequest - Contains an array of named query IDs.

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

batchGetPreparedStatement

BatchGetPreparedStatementResult batchGetPreparedStatement(BatchGetPreparedStatementRequest batchGetPreparedStatementRequest)

Returns the details of a single prepared statement or a list of up to 256 prepared statements for the array of prepared statement names that you provide. Requires you to have access to the workgroup to which the prepared statements belong. If a prepared statement cannot be retrieved for the name specified, the statement is listed in UnprocessedPreparedStatementNames.

Parameters:

batchGetPreparedStatementRequest -

Returns:

Result of the BatchGetPreparedStatement 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. 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.

Parameters:

batchGetQueryExecutionRequest - Contains an array of query execution IDs.

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

createDataCatalog

CreateDataCatalogResult createDataCatalog(CreateDataCatalogRequest createDataCatalogRequest)

Creates (registers) a data catalog with the specified name and properties. Catalogs created are visible to all users of the same Amazon Web Services account.

Parameters:

createDataCatalogRequest -

Returns:

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.

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 in the specified workgroup. Requires that you have access to the workgroup.

For code samples using the Amazon Web Services 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

createPreparedStatement

CreatePreparedStatementResult createPreparedStatement(CreatePreparedStatementRequest createPreparedStatementRequest)

Creates a prepared statement for use with SQL queries in Athena.

Parameters:

createPreparedStatementRequest -

Returns:

Result of the CreatePreparedStatement 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

createWorkGroup

CreateWorkGroupResult createWorkGroup(CreateWorkGroupRequest createWorkGroupRequest)

Creates a workgroup with the specified name.

Parameters:

createWorkGroupRequest -

Returns:

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.

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

deleteDataCatalog

DeleteDataCatalogResult deleteDataCatalog(DeleteDataCatalogRequest deleteDataCatalogRequest)

Deletes a data catalog.

Parameters:

deleteDataCatalogRequest -

Returns:

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.

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 the named query if you have access to the workgroup in which the query was saved.

For code samples using the Amazon Web Services 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

deletePreparedStatement

DeletePreparedStatementResult deletePreparedStatement(DeletePreparedStatementRequest deletePreparedStatementRequest)

Deletes the prepared statement with the specified name from the specified workgroup.

Parameters:

deletePreparedStatementRequest -

Returns:

Result of the DeletePreparedStatement 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.

ResourceNotFoundException - A resource, such as a workgroup, was not found.

See Also:

AWS API Documentation

deleteWorkGroup

DeleteWorkGroupResult deleteWorkGroup(DeleteWorkGroupRequest deleteWorkGroupRequest)

Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.

Parameters:

deleteWorkGroupRequest -

Returns:

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.

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

getDataCatalog

GetDataCatalogResult getDataCatalog(GetDataCatalogRequest getDataCatalogRequest)

Returns the specified data catalog.

Parameters:

getDataCatalogRequest -

Returns:

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.

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

getDatabase

GetDatabaseResult getDatabase(GetDatabaseRequest getDatabaseRequest)

Returns a database object for the specified database and data catalog.

Parameters:

getDatabaseRequest -

Returns:

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.

InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

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.

See Also:

AWS API Documentation

getNamedQuery

GetNamedQueryResult getNamedQuery(GetNamedQueryRequest getNamedQueryRequest)

Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.

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

getPreparedStatement

GetPreparedStatementResult getPreparedStatement(GetPreparedStatementRequest getPreparedStatementRequest)

Retrieves the prepared statement with the specified name from the specified workgroup.

Parameters:

getPreparedStatementRequest -

Returns:

Result of the GetPreparedStatement 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.

ResourceNotFoundException - A resource, such as a workgroup, was not found.

See Also:

AWS API Documentation

getQueryExecution

GetQueryExecutionResult getQueryExecution(GetQueryExecutionRequest getQueryExecutionRequest)

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.

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)

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.

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

getQueryRuntimeStatistics

GetQueryRuntimeStatisticsResult getQueryRuntimeStatistics(GetQueryRuntimeStatisticsRequest getQueryRuntimeStatisticsRequest)

Returns query execution runtime statistics related to a single execution of a query if you have access to the workgroup in which the query ran. The query execution runtime statistics is returned only when QueryExecutionStatus$State is in a SUCCEEDED or FAILED state.

Parameters:

getQueryRuntimeStatisticsRequest -

Returns:

Result of the GetQueryRuntimeStatistics 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

getTableMetadata

GetTableMetadataResult getTableMetadata(GetTableMetadataRequest getTableMetadataRequest)

Returns table metadata for the specified catalog, database, and table.

Parameters:

getTableMetadataRequest -

Returns:

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.

InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

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.

See Also:

AWS API Documentation

getWorkGroup

GetWorkGroupResult getWorkGroup(GetWorkGroupRequest getWorkGroupRequest)

Returns information about the workgroup with the specified name.

Parameters:

getWorkGroupRequest -

Returns:

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.

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

listDataCatalogs

ListDataCatalogsResult listDataCatalogs(ListDataCatalogsRequest listDataCatalogsRequest)

Lists the data catalogs in the current Amazon Web Services account.

Parameters:

listDataCatalogsRequest -

Returns:

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.

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

listDatabases

ListDatabasesResult listDatabases(ListDatabasesRequest listDatabasesRequest)

Lists the databases in the specified data catalog.

Parameters:

listDatabasesRequest -

Returns:

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.

InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

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.

See Also:

AWS API Documentation

listEngineVersions

ListEngineVersionsResult listEngineVersions(ListEngineVersionsRequest listEngineVersionsRequest)

Returns a list of engine versions that are available to choose from, including the Auto option.

Parameters:

listEngineVersionsRequest -

Returns:

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.

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 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 Amazon Web Services 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

listPreparedStatements

ListPreparedStatementsResult listPreparedStatements(ListPreparedStatementsRequest listPreparedStatementsRequest)

Lists the prepared statements in the specified workgroup.

Parameters:

listPreparedStatementsRequest -

Returns:

Result of the ListPreparedStatements 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 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 Amazon Web Services 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

listTableMetadata

ListTableMetadataResult listTableMetadata(ListTableMetadataRequest listTableMetadataRequest)

Lists the metadata for the tables in the specified data catalog database.

Parameters:

listTableMetadataRequest -

Returns:

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.

InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

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.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists the tags associated with an Athena workgroup or data catalog resource.

Parameters:

listTagsForResourceRequest -

Returns:

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.

InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ResourceNotFoundException - A resource, such as a workgroup, was not found.

See Also:

AWS API Documentation

listWorkGroups

ListWorkGroupsResult listWorkGroups(ListWorkGroupsRequest listWorkGroupsRequest)

Lists available workgroups for the account.

Parameters:

listWorkGroupsRequest -

Returns:

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.

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 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 Amazon Web Services 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. Requires you to have access to the workgroup in which the query ran.

For code samples using the Amazon Web Services 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

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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.

Parameters:

tagResourceRequest -

Returns:

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.

InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ResourceNotFoundException - A resource, such as a workgroup, was not found.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes one or more tags from a data catalog or workgroup resource.

Parameters:

untagResourceRequest -

Returns:

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.

InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

ResourceNotFoundException - A resource, such as a workgroup, was not found.

See Also:

AWS API Documentation

updateDataCatalog

UpdateDataCatalogResult updateDataCatalog(UpdateDataCatalogRequest updateDataCatalogRequest)

Updates the data catalog that has the specified name.

Parameters:

updateDataCatalogRequest -

Returns:

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.

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

updateNamedQuery

UpdateNamedQueryResult updateNamedQuery(UpdateNamedQueryRequest updateNamedQueryRequest)

Updates a NamedQuery object. The database or workgroup cannot be updated.

Parameters:

updateNamedQueryRequest -

Returns:

Result of the UpdateNamedQuery 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

updatePreparedStatement

UpdatePreparedStatementResult updatePreparedStatement(UpdatePreparedStatementRequest updatePreparedStatementRequest)

Updates a prepared statement.

Parameters:

updatePreparedStatementRequest -

Returns:

Result of the UpdatePreparedStatement 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.

ResourceNotFoundException - A resource, such as a workgroup, was not found.

See Also:

AWS API Documentation

updateWorkGroup

UpdateWorkGroupResult updateWorkGroup(UpdateWorkGroupRequest updateWorkGroupRequest)

Updates the workgroup with the specified name. The workgroup's name cannot be changed.

Parameters:

updateWorkGroupRequest -

Returns:

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.

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.