AmazonAthenaClient (AWS Java SDK for Amazon Athena 1.12.285 API)

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.

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

protected static ClientConfigurationFactory configFactory
Client configuration factory providing ClientConfigurations tailored to this client
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
- Fields inherited from interface com.amazonaws.services.athena.AmazonAthena
  ENDPOINT_PREFIX

Fields
Modifier and Type	Field and Description
`protected static ClientConfigurationFactory`	`configFactory` Client configuration factory providing ClientConfigurations tailored to this client

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.
`BatchGetPreparedStatementResult`	`batchGetPreparedStatement(BatchGetPreparedStatementRequest request)` 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 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()`
`CreateDataCatalogResult`	`createDataCatalog(CreateDataCatalogRequest request)` Creates (registers) a data catalog with the specified name and properties.
`CreateNamedQueryResult`	`createNamedQuery(CreateNamedQueryRequest request)` Creates a named query in the specified workgroup.
`CreatePreparedStatementResult`	`createPreparedStatement(CreatePreparedStatementRequest request)` Creates a prepared statement for use with SQL queries in Athena.
`CreateWorkGroupResult`	`createWorkGroup(CreateWorkGroupRequest request)` Creates a workgroup with the specified name.
`DeleteDataCatalogResult`	`deleteDataCatalog(DeleteDataCatalogRequest request)` Deletes a data catalog.
`DeleteNamedQueryResult`	`deleteNamedQuery(DeleteNamedQueryRequest request)` Deletes the named query if you have access to the workgroup in which the query was saved.
`DeletePreparedStatementResult`	`deletePreparedStatement(DeletePreparedStatementRequest request)` Deletes the prepared statement with the specified name from the specified workgroup.
`DeleteWorkGroupResult`	`deleteWorkGroup(DeleteWorkGroupRequest request)` 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 request)` Returns a database object for the specified database and data catalog.
`GetDataCatalogResult`	`getDataCatalog(GetDataCatalogRequest request)` Returns the specified data catalog.
`GetNamedQueryResult`	`getNamedQuery(GetNamedQueryRequest request)` Returns information about a single query.
`GetPreparedStatementResult`	`getPreparedStatement(GetPreparedStatementRequest request)` Retrieves the prepared statement with the specified name from the specified workgroup.
`GetQueryExecutionResult`	`getQueryExecution(GetQueryExecutionRequest request)` Returns information about a single execution of a query if you have access to the workgroup in which the query ran.
`GetQueryResultsResult`	`getQueryResults(GetQueryResultsRequest request)` Streams the results of a single query execution specified by `QueryExecutionId` from the Athena query results location in Amazon S3.
`GetQueryRuntimeStatisticsResult`	`getQueryRuntimeStatistics(GetQueryRuntimeStatisticsRequest request)` 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 request)` Returns table metadata for the specified catalog, database, and table.
`GetWorkGroupResult`	`getWorkGroup(GetWorkGroupRequest request)` Returns information about the workgroup with the specified name.
`ListDatabasesResult`	`listDatabases(ListDatabasesRequest request)` Lists the databases in the specified data catalog.
`ListDataCatalogsResult`	`listDataCatalogs(ListDataCatalogsRequest request)` Lists the data catalogs in the current Amazon Web Services account.
`ListEngineVersionsResult`	`listEngineVersions(ListEngineVersionsRequest request)` Returns a list of engine versions that are available to choose from, including the Auto option.
`ListNamedQueriesResult`	`listNamedQueries(ListNamedQueriesRequest request)` Provides a list of available query IDs only for queries saved in the specified workgroup.
`ListPreparedStatementsResult`	`listPreparedStatements(ListPreparedStatementsRequest request)` Lists the prepared statements in the specified workgroup.
`ListQueryExecutionsResult`	`listQueryExecutions(ListQueryExecutionsRequest request)` Provides a list of available query execution IDs for the queries in the specified workgroup.
`ListTableMetadataResult`	`listTableMetadata(ListTableMetadataRequest request)` Lists the metadata for the tables in the specified data catalog database.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Lists the tags associated with an Athena workgroup or data catalog resource.
`ListWorkGroupsResult`	`listWorkGroups(ListWorkGroupsRequest request)` Lists available workgroups for the account.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartQueryExecutionResult`	`startQueryExecution(StartQueryExecutionRequest request)` Runs the SQL query statements contained in the `Query`.
`StopQueryExecutionResult`	`stopQueryExecution(StopQueryExecutionRequest request)` Stops a query execution.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Adds one or more tags to an Athena resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes one or more tags from a data catalog or workgroup resource.
`UpdateDataCatalogResult`	`updateDataCatalog(UpdateDataCatalogRequest request)` Updates the data catalog that has the specified name.
`UpdateNamedQueryResult`	`updateNamedQuery(UpdateNamedQueryRequest request)` Updates a NamedQuery object.
`UpdatePreparedStatementResult`	`updatePreparedStatement(UpdatePreparedStatementRequest request)` Updates a prepared statement.
`UpdateWorkGroupResult`	`updateWorkGroup(UpdateWorkGroupRequest request)` Updates the workgroup with the specified name.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - configFactory
```
protected static final ClientConfigurationFactory configFactory
```
    Client configuration factory providing ClientConfigurations tailored to this client
- 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. 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.
    
    Specified by:
    
    batchGetNamedQuery in interface AmazonAthena
    
    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
```
public BatchGetPreparedStatementResult batchGetPreparedStatement(BatchGetPreparedStatementRequest request)
```
    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.
    
    Specified by:
    
    batchGetPreparedStatement in interface AmazonAthena
    
    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
```
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. 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.
    
    Specified by:
    
    batchGetQueryExecution in interface AmazonAthena
    
    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
```
public CreateDataCatalogResult createDataCatalog(CreateDataCatalogRequest request)
```
    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.
    
    Specified by:
    
    createDataCatalog in interface AmazonAthena
    
    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
```
public CreateNamedQueryResult createNamedQuery(CreateNamedQueryRequest request)
```
    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.
    
    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
  - createPreparedStatement
```
public CreatePreparedStatementResult createPreparedStatement(CreatePreparedStatementRequest request)
```
    Creates a prepared statement for use with SQL queries in Athena.
    
    Specified by:
    
    createPreparedStatement in interface AmazonAthena
    
    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
```
public CreateWorkGroupResult createWorkGroup(CreateWorkGroupRequest request)
```
    Creates a workgroup with the specified name.
    
    Specified by:
    
    createWorkGroup in interface AmazonAthena
    
    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
```
public DeleteDataCatalogResult deleteDataCatalog(DeleteDataCatalogRequest request)
```
    Deletes a data catalog.
    
    Specified by:
    
    deleteDataCatalog in interface AmazonAthena
    
    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
```
public DeleteNamedQueryResult deleteNamedQuery(DeleteNamedQueryRequest request)
```
    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.
    
    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
  - deletePreparedStatement
```
public DeletePreparedStatementResult deletePreparedStatement(DeletePreparedStatementRequest request)
```
    Deletes the prepared statement with the specified name from the specified workgroup.
    
    Specified by:
    
    deletePreparedStatement in interface AmazonAthena
    
    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
```
public DeleteWorkGroupResult deleteWorkGroup(DeleteWorkGroupRequest request)
```
    Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.
    
    Specified by:
    
    deleteWorkGroup in interface AmazonAthena
    
    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
```
public GetDataCatalogResult getDataCatalog(GetDataCatalogRequest request)
```
    Returns the specified data catalog.
    
    Specified by:
    
    getDataCatalog in interface AmazonAthena
    
    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
```
public GetDatabaseResult getDatabase(GetDatabaseRequest request)
```
    Returns a database object for the specified database and data catalog.
    
    Specified by:
    
    getDatabase in interface AmazonAthena
    
    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
```
public GetNamedQueryResult getNamedQuery(GetNamedQueryRequest request)
```
    Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.
    
    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
  - getPreparedStatement
```
public GetPreparedStatementResult getPreparedStatement(GetPreparedStatementRequest request)
```
    Retrieves the prepared statement with the specified name from the specified workgroup.
    
    Specified by:
    
    getPreparedStatement in interface AmazonAthena
    
    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
```
public GetQueryExecutionResult getQueryExecution(GetQueryExecutionRequest request)
```
    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.
    
    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)
```
    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.
    
    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
  - getQueryRuntimeStatistics
```
public GetQueryRuntimeStatisticsResult getQueryRuntimeStatistics(GetQueryRuntimeStatisticsRequest request)
```
    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.
    
    Specified by:
    
    getQueryRuntimeStatistics in interface AmazonAthena
    
    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
```
public GetTableMetadataResult getTableMetadata(GetTableMetadataRequest request)
```
    Returns table metadata for the specified catalog, database, and table.
    
    Specified by:
    
    getTableMetadata in interface AmazonAthena
    
    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
```
public GetWorkGroupResult getWorkGroup(GetWorkGroupRequest request)
```
    Returns information about the workgroup with the specified name.
    
    Specified by:
    
    getWorkGroup in interface AmazonAthena
    
    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
```
public ListDataCatalogsResult listDataCatalogs(ListDataCatalogsRequest request)
```
    Lists the data catalogs in the current Amazon Web Services account.
    
    Specified by:
    
    listDataCatalogs in interface AmazonAthena
    
    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
```
public ListDatabasesResult listDatabases(ListDatabasesRequest request)
```
    Lists the databases in the specified data catalog.
    
    Specified by:
    
    listDatabases in interface AmazonAthena
    
    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
```
public ListEngineVersionsResult listEngineVersions(ListEngineVersionsRequest request)
```
    Returns a list of engine versions that are available to choose from, including the Auto option.
    
    Specified by:
    
    listEngineVersions in interface AmazonAthena
    
    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
```
public ListNamedQueriesResult listNamedQueries(ListNamedQueriesRequest request)
```
    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.
    
    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
  - listPreparedStatements
```
public ListPreparedStatementsResult listPreparedStatements(ListPreparedStatementsRequest request)
```
    Lists the prepared statements in the specified workgroup.
    
    Specified by:
    
    listPreparedStatements in interface AmazonAthena
    
    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
```
public ListQueryExecutionsResult listQueryExecutions(ListQueryExecutionsRequest request)
```
    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.
    
    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
  - listTableMetadata
```
public ListTableMetadataResult listTableMetadata(ListTableMetadataRequest request)
```
    Lists the metadata for the tables in the specified data catalog database.
    
    Specified by:
    
    listTableMetadata in interface AmazonAthena
    
    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
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Lists the tags associated with an Athena workgroup or data catalog resource.
    
    Specified by:
    
    listTagsForResource in interface AmazonAthena
    
    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
```
public ListWorkGroupsResult listWorkGroups(ListWorkGroupsRequest request)
```
    Lists available workgroups for the account.
    
    Specified by:
    
    listWorkGroups in interface AmazonAthena
    
    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
```
public StartQueryExecutionResult startQueryExecution(StartQueryExecutionRequest request)
```
    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.
    
    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. 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.
    
    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
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    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.
    
    Specified by:
    
    tagResource in interface AmazonAthena
    
    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
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Removes one or more tags from a data catalog or workgroup resource.
    
    Specified by:
    
    untagResource in interface AmazonAthena
    
    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
```
public UpdateDataCatalogResult updateDataCatalog(UpdateDataCatalogRequest request)
```
    Updates the data catalog that has the specified name.
    
    Specified by:
    
    updateDataCatalog in interface AmazonAthena
    
    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
```
public UpdateNamedQueryResult updateNamedQuery(UpdateNamedQueryRequest request)
```
    Updates a NamedQuery object. The database or workgroup cannot be updated.
    
    Specified by:
    
    updateNamedQuery in interface AmazonAthena
    
    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
```
public UpdatePreparedStatementResult updatePreparedStatement(UpdatePreparedStatementRequest request)
```
    Updates a prepared statement.
    
    Specified by:
    
    updatePreparedStatement in interface AmazonAthena
    
    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
```
public UpdateWorkGroupResult updateWorkGroup(UpdateWorkGroupRequest request)
```
    Updates the workgroup with the specified name. The workgroup's name cannot be changed.
    
    Specified by:
    
    updateWorkGroup in interface AmazonAthena
    
    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
  - 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.
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonAthena
    
    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.
    
    Specified by:
    
    shutdown in interface AmazonAthena
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Class AmazonAthenaClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

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

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Field Detail

configFactory

Method Detail

builder

batchGetNamedQuery

batchGetPreparedStatement

batchGetQueryExecution

createDataCatalog

createNamedQuery

createPreparedStatement

createWorkGroup

deleteDataCatalog

deleteNamedQuery

deletePreparedStatement

deleteWorkGroup

getDataCatalog

getDatabase

getNamedQuery

getPreparedStatement

getQueryExecution

getQueryResults

getQueryRuntimeStatistics

getTableMetadata

getWorkGroup

listDataCatalogs

listDatabases

listEngineVersions

listNamedQueries

listPreparedStatements

listQueryExecutions

listTableMetadata

listTagsForResource

listWorkGroups

startQueryExecution

stopQueryExecution

tagResource

untagResource

updateDataCatalog

updateNamedQuery

updatePreparedStatement

updateWorkGroup

getCachedResponseMetadata

shutdown