AbstractAmazonAthena (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.athena.AbstractAmazonAthena

All Implemented Interfaces:

AmazonAthena

Direct Known Subclasses:

AbstractAmazonAthenaAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonAthena
extends Object
implements AmazonAthena
```
Abstract implementation of AmazonAthena. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.athena.AmazonAthena
  ENDPOINT_PREFIX

Method Summary

All 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.
`CancelCapacityReservationResult`	`cancelCapacityReservation(CancelCapacityReservationRequest request)` Cancels the capacity reservation with the specified name.
`CreateCapacityReservationResult`	`createCapacityReservation(CreateCapacityReservationRequest request)` Creates a capacity reservation with the specified name and number of requested data processing units.
`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.
`CreateNotebookResult`	`createNotebook(CreateNotebookRequest request)` Creates an empty `ipynb` file in the specified Apache Spark enabled workgroup.
`CreatePreparedStatementResult`	`createPreparedStatement(CreatePreparedStatementRequest request)` Creates a prepared statement for use with SQL queries in Athena.
`CreatePresignedNotebookUrlResult`	`createPresignedNotebookUrl(CreatePresignedNotebookUrlRequest request)` Gets an authentication token and the URL at which the notebook can be accessed.
`CreateWorkGroupResult`	`createWorkGroup(CreateWorkGroupRequest request)` Creates a workgroup with the specified name.
`DeleteCapacityReservationResult`	`deleteCapacityReservation(DeleteCapacityReservationRequest request)` Deletes a cancelled capacity reservation.
`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.
`DeleteNotebookResult`	`deleteNotebook(DeleteNotebookRequest request)` Deletes the specified notebook.
`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.
`ExportNotebookResult`	`exportNotebook(ExportNotebookRequest request)` Exports the specified notebook and its metadata.
`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.
`GetCalculationExecutionResult`	`getCalculationExecution(GetCalculationExecutionRequest request)` Describes a previously submitted calculation execution.
`GetCalculationExecutionCodeResult`	`getCalculationExecutionCode(GetCalculationExecutionCodeRequest request)` Retrieves the unencrypted code that was executed for the calculation.
`GetCalculationExecutionStatusResult`	`getCalculationExecutionStatus(GetCalculationExecutionStatusRequest request)` Gets the status of a current calculation.
`GetCapacityAssignmentConfigurationResult`	`getCapacityAssignmentConfiguration(GetCapacityAssignmentConfigurationRequest request)` Gets the capacity assignment configuration for a capacity reservation, if one exists.
`GetCapacityReservationResult`	`getCapacityReservation(GetCapacityReservationRequest request)` Returns information about the capacity reservation with the specified name.
`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.
`GetNotebookMetadataResult`	`getNotebookMetadata(GetNotebookMetadataRequest request)` Retrieves notebook metadata for the specified notebook ID.
`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.
`GetSessionResult`	`getSession(GetSessionRequest request)` Gets the full details of a previously created session, including the session status and configuration.
`GetSessionStatusResult`	`getSessionStatus(GetSessionStatusRequest request)` Gets the current status of a session.
`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.
`ImportNotebookResult`	`importNotebook(ImportNotebookRequest request)` Imports a single `ipynb` file to a Spark enabled workgroup.
`ListApplicationDPUSizesResult`	`listApplicationDPUSizes(ListApplicationDPUSizesRequest request)` Returns the supported DPU sizes for the supported application runtimes (for example, `Athena notebook version 1`).
`ListCalculationExecutionsResult`	`listCalculationExecutions(ListCalculationExecutionsRequest request)` Lists the calculations that have been submitted to a session in descending order.
`ListCapacityReservationsResult`	`listCapacityReservations(ListCapacityReservationsRequest request)` Lists the capacity reservations for the current account.
`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.
`ListExecutorsResult`	`listExecutors(ListExecutorsRequest request)` Lists, in descending order, the executors that joined a session.
`ListNamedQueriesResult`	`listNamedQueries(ListNamedQueriesRequest request)` Provides a list of available query IDs only for queries saved in the specified workgroup.
`ListNotebookMetadataResult`	`listNotebookMetadata(ListNotebookMetadataRequest request)` Displays the notebook files for the specified workgroup in paginated format.
`ListNotebookSessionsResult`	`listNotebookSessions(ListNotebookSessionsRequest request)` Lists, in descending order, the sessions that have been created in a notebook that are in an active state like `CREATING`, `CREATED`, `IDLE` or `BUSY`.
`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.
`ListSessionsResult`	`listSessions(ListSessionsRequest request)` Lists the sessions in a workgroup that are in an active state like `CREATING`, `CREATED`, `IDLE`, or `BUSY`.
`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 resource.
`ListWorkGroupsResult`	`listWorkGroups(ListWorkGroupsRequest request)` Lists available workgroups for the account.
`PutCapacityAssignmentConfigurationResult`	`putCapacityAssignmentConfiguration(PutCapacityAssignmentConfigurationRequest request)` Puts a new capacity assignment configuration for a specified capacity reservation.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartCalculationExecutionResult`	`startCalculationExecution(StartCalculationExecutionRequest request)` Submits calculations for execution within a session.
`StartQueryExecutionResult`	`startQueryExecution(StartQueryExecutionRequest request)` Runs the SQL query statements contained in the `Query`.
`StartSessionResult`	`startSession(StartSessionRequest request)` Creates a session for running calculations within a workgroup.
`StopCalculationExecutionResult`	`stopCalculationExecution(StopCalculationExecutionRequest request)` Requests the cancellation of a calculation.
`StopQueryExecutionResult`	`stopQueryExecution(StopQueryExecutionRequest request)` Stops a query execution.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Adds one or more tags to an Athena resource.
`TerminateSessionResult`	`terminateSession(TerminateSessionRequest request)` Terminates an active session.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes one or more tags from an Athena resource.
`UpdateCapacityReservationResult`	`updateCapacityReservation(UpdateCapacityReservationRequest request)` Updates the number of requested data processing units for the capacity reservation with the specified name.
`UpdateDataCatalogResult`	`updateDataCatalog(UpdateDataCatalogRequest request)` Updates the data catalog that has the specified name.
`UpdateNamedQueryResult`	`updateNamedQuery(UpdateNamedQueryRequest request)` Updates a NamedQuery object.
`UpdateNotebookResult`	`updateNotebook(UpdateNotebookRequest request)` Updates the contents of a Spark notebook.
`UpdateNotebookMetadataResult`	`updateNotebookMetadata(UpdateNotebookMetadataRequest request)` Updates the metadata for a notebook.
`UpdatePreparedStatementResult`	`updatePreparedStatement(UpdatePreparedStatementRequest request)` Updates a prepared statement.
`UpdateWorkGroupResult`	`updateWorkGroup(UpdateWorkGroupRequest request)` Updates the workgroup with the specified name.

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

- Method Detail
  - batchGetNamedQuery
```
public BatchGetNamedQueryResult batchGetNamedQuery(BatchGetNamedQueryRequest request)
```
    Description copied from interface: AmazonAthena
    
    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:
    
    request - Contains an array of named query IDs.
    
    Returns:
    
    Result of the BatchGetNamedQuery operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchGetPreparedStatement
```
public BatchGetPreparedStatementResult batchGetPreparedStatement(BatchGetPreparedStatementRequest request)
```
    Description copied from interface: AmazonAthena
    
    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
    
    Returns:
    
    Result of the BatchGetPreparedStatement operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchGetQueryExecution
```
public BatchGetQueryExecutionResult batchGetQueryExecution(BatchGetQueryExecutionRequest request)
```
    Description copied from interface: AmazonAthena
    
    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:
    
    request - Contains an array of query execution IDs.
    
    Returns:
    
    Result of the BatchGetQueryExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - cancelCapacityReservation
```
public CancelCapacityReservationResult cancelCapacityReservation(CancelCapacityReservationRequest request)
```
    Description copied from interface: AmazonAthena
    
    Cancels the capacity reservation with the specified name. Cancelled reservations remain in your account and will be deleted 45 days after cancellation. During the 45 days, you cannot re-purpose or reuse a reservation that has been cancelled, but you can refer to its tags and view it for historical reference.
    
    Specified by:
    
    cancelCapacityReservation in interface AmazonAthena
    
    Returns:
    
    Result of the CancelCapacityReservation operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createCapacityReservation
```
public CreateCapacityReservationResult createCapacityReservation(CreateCapacityReservationRequest request)
```
    Description copied from interface: AmazonAthena
    
    Creates a capacity reservation with the specified name and number of requested data processing units.
    
    Specified by:
    
    createCapacityReservation in interface AmazonAthena
    
    Returns:
    
    Result of the CreateCapacityReservation operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDataCatalog
```
public CreateDataCatalogResult createDataCatalog(CreateDataCatalogRequest request)
```
    Description copied from interface: AmazonAthena
    
    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
    
    Returns:
    
    Result of the CreateDataCatalog operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createNamedQuery
```
public CreateNamedQueryResult createNamedQuery(CreateNamedQueryRequest request)
```
    Description copied from interface: AmazonAthena
    
    Creates a named query in the specified workgroup. Requires that you have access to the workgroup.
    
    Specified by:
    
    createNamedQuery in interface AmazonAthena
    
    Returns:
    
    Result of the CreateNamedQuery operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createNotebook
```
public CreateNotebookResult createNotebook(CreateNotebookRequest request)
```
    Description copied from interface: AmazonAthena
    
    Creates an empty ipynb file in the specified Apache Spark enabled workgroup. Throws an error if a file in the workgroup with the same name already exists.
    
    Specified by:
    
    createNotebook in interface AmazonAthena
    
    Returns:
    
    Result of the CreateNotebook operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createPreparedStatement
```
public CreatePreparedStatementResult createPreparedStatement(CreatePreparedStatementRequest request)
```
    Description copied from interface: AmazonAthena
    
    Creates a prepared statement for use with SQL queries in Athena.
    
    Specified by:
    
    createPreparedStatement in interface AmazonAthena
    
    Returns:
    
    Result of the CreatePreparedStatement operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createPresignedNotebookUrl
```
public CreatePresignedNotebookUrlResult createPresignedNotebookUrl(CreatePresignedNotebookUrlRequest request)
```
    Description copied from interface: AmazonAthena
    
    Gets an authentication token and the URL at which the notebook can be accessed. During programmatic access, CreatePresignedNotebookUrl must be called every 10 minutes to refresh the authentication token. For information about granting programmatic access, see Grant programmatic access.
    
    Specified by:
    
    createPresignedNotebookUrl in interface AmazonAthena
    
    Returns:
    
    Result of the CreatePresignedNotebookUrl operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createWorkGroup
```
public CreateWorkGroupResult createWorkGroup(CreateWorkGroupRequest request)
```
    Description copied from interface: AmazonAthena
    
    Creates a workgroup with the specified name. A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup.
    
    Specified by:
    
    createWorkGroup in interface AmazonAthena
    
    Returns:
    
    Result of the CreateWorkGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteCapacityReservation
```
public DeleteCapacityReservationResult deleteCapacityReservation(DeleteCapacityReservationRequest request)
```
    Description copied from interface: AmazonAthena
    
    Deletes a cancelled capacity reservation. A reservation must be cancelled before it can be deleted. A deleted reservation is immediately removed from your account and can no longer be referenced, including by its ARN. A deleted reservation cannot be called by GetCapacityReservation, and deleted reservations do not appear in the output of ListCapacityReservations.
    
    Specified by:
    
    deleteCapacityReservation in interface AmazonAthena
    
    Returns:
    
    Result of the DeleteCapacityReservation operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDataCatalog
```
public DeleteDataCatalogResult deleteDataCatalog(DeleteDataCatalogRequest request)
```
    Description copied from interface: AmazonAthena
    
    Deletes a data catalog.
    
    Specified by:
    
    deleteDataCatalog in interface AmazonAthena
    
    Returns:
    
    Result of the DeleteDataCatalog operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteNamedQuery
```
public DeleteNamedQueryResult deleteNamedQuery(DeleteNamedQueryRequest request)
```
    Description copied from interface: AmazonAthena
    
    Deletes the named query if you have access to the workgroup in which the query was saved.
    
    Specified by:
    
    deleteNamedQuery in interface AmazonAthena
    
    Returns:
    
    Result of the DeleteNamedQuery operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteNotebook
```
public DeleteNotebookResult deleteNotebook(DeleteNotebookRequest request)
```
    Description copied from interface: AmazonAthena
    
    Deletes the specified notebook.
    
    Specified by:
    
    deleteNotebook in interface AmazonAthena
    
    Returns:
    
    Result of the DeleteNotebook operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deletePreparedStatement
```
public DeletePreparedStatementResult deletePreparedStatement(DeletePreparedStatementRequest request)
```
    Description copied from interface: AmazonAthena
    
    Deletes the prepared statement with the specified name from the specified workgroup.
    
    Specified by:
    
    deletePreparedStatement in interface AmazonAthena
    
    Returns:
    
    Result of the DeletePreparedStatement operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteWorkGroup
```
public DeleteWorkGroupResult deleteWorkGroup(DeleteWorkGroupRequest request)
```
    Description copied from interface: AmazonAthena
    
    Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.
    
    Specified by:
    
    deleteWorkGroup in interface AmazonAthena
    
    Returns:
    
    Result of the DeleteWorkGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - exportNotebook
```
public ExportNotebookResult exportNotebook(ExportNotebookRequest request)
```
    Description copied from interface: AmazonAthena
    
    Exports the specified notebook and its metadata.
    
    Specified by:
    
    exportNotebook in interface AmazonAthena
    
    Returns:
    
    Result of the ExportNotebook operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getCalculationExecution
```
public GetCalculationExecutionResult getCalculationExecution(GetCalculationExecutionRequest request)
```
    Description copied from interface: AmazonAthena
    
    Describes a previously submitted calculation execution.
    
    Specified by:
    
    getCalculationExecution in interface AmazonAthena
    
    Returns:
    
    Result of the GetCalculationExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getCalculationExecutionCode
```
public GetCalculationExecutionCodeResult getCalculationExecutionCode(GetCalculationExecutionCodeRequest request)
```
    Description copied from interface: AmazonAthena
    
    Retrieves the unencrypted code that was executed for the calculation.
    
    Specified by:
    
    getCalculationExecutionCode in interface AmazonAthena
    
    Returns:
    
    Result of the GetCalculationExecutionCode operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getCalculationExecutionStatus
```
public GetCalculationExecutionStatusResult getCalculationExecutionStatus(GetCalculationExecutionStatusRequest request)
```
    Description copied from interface: AmazonAthena
    
    Gets the status of a current calculation.
    
    Specified by:
    
    getCalculationExecutionStatus in interface AmazonAthena
    
    Returns:
    
    Result of the GetCalculationExecutionStatus operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getCapacityAssignmentConfiguration
```
public GetCapacityAssignmentConfigurationResult getCapacityAssignmentConfiguration(GetCapacityAssignmentConfigurationRequest request)
```
    Description copied from interface: AmazonAthena
    
    Gets the capacity assignment configuration for a capacity reservation, if one exists.
    
    Specified by:
    
    getCapacityAssignmentConfiguration in interface AmazonAthena
    
    Returns:
    
    Result of the GetCapacityAssignmentConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getCapacityReservation
```
public GetCapacityReservationResult getCapacityReservation(GetCapacityReservationRequest request)
```
    Description copied from interface: AmazonAthena
    
    Returns information about the capacity reservation with the specified name.
    
    Specified by:
    
    getCapacityReservation in interface AmazonAthena
    
    Returns:
    
    Result of the GetCapacityReservation operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDataCatalog
```
public GetDataCatalogResult getDataCatalog(GetDataCatalogRequest request)
```
    Description copied from interface: AmazonAthena
    
    Returns the specified data catalog.
    
    Specified by:
    
    getDataCatalog in interface AmazonAthena
    
    Returns:
    
    Result of the GetDataCatalog operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDatabase
```
public GetDatabaseResult getDatabase(GetDatabaseRequest request)
```
    Description copied from interface: AmazonAthena
    
    Returns a database object for the specified database and data catalog.
    
    Specified by:
    
    getDatabase in interface AmazonAthena
    
    Returns:
    
    Result of the GetDatabase operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getNamedQuery
```
public GetNamedQueryResult getNamedQuery(GetNamedQueryRequest request)
```
    Description copied from interface: AmazonAthena
    
    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
    
    Returns:
    
    Result of the GetNamedQuery operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getNotebookMetadata
```
public GetNotebookMetadataResult getNotebookMetadata(GetNotebookMetadataRequest request)
```
    Description copied from interface: AmazonAthena
    
    Retrieves notebook metadata for the specified notebook ID.
    
    Specified by:
    
    getNotebookMetadata in interface AmazonAthena
    
    Returns:
    
    Result of the GetNotebookMetadata operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getPreparedStatement
```
public GetPreparedStatementResult getPreparedStatement(GetPreparedStatementRequest request)
```
    Description copied from interface: AmazonAthena
    
    Retrieves the prepared statement with the specified name from the specified workgroup.
    
    Specified by:
    
    getPreparedStatement in interface AmazonAthena
    
    Returns:
    
    Result of the GetPreparedStatement operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getQueryExecution
```
public GetQueryExecutionResult getQueryExecution(GetQueryExecutionRequest request)
```
    Description copied from interface: AmazonAthena
    
    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
    
    Returns:
    
    Result of the GetQueryExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getQueryResults
```
public GetQueryResultsResult getQueryResults(GetQueryResultsRequest request)
```
    Description copied from interface: AmazonAthena
    
    Streams the results of a single query execution specified by QueryExecutionId from the Athena query results location in Amazon S3. For more information, see Working with query results, recent queries, and output files 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
    
    Returns:
    
    Result of the GetQueryResults operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getQueryRuntimeStatistics
```
public GetQueryRuntimeStatisticsResult getQueryRuntimeStatistics(GetQueryRuntimeStatisticsRequest request)
```
    Description copied from interface: AmazonAthena
    
    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. Statistics from the Timeline section of the response object are available as soon as QueryExecutionStatus$State is in a SUCCEEDED or FAILED state. The remaining non-timeline statistics in the response (like stage-level input and output row count and data size) are updated asynchronously and may not be available immediately after a query completes. The non-timeline statistics are also not included when a query has row-level filters defined in Lake Formation.
    
    Specified by:
    
    getQueryRuntimeStatistics in interface AmazonAthena
    
    Returns:
    
    Result of the GetQueryRuntimeStatistics operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getSession
```
public GetSessionResult getSession(GetSessionRequest request)
```
    Description copied from interface: AmazonAthena
    
    Gets the full details of a previously created session, including the session status and configuration.
    
    Specified by:
    
    getSession in interface AmazonAthena
    
    Returns:
    
    Result of the GetSession operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getSessionStatus
```
public GetSessionStatusResult getSessionStatus(GetSessionStatusRequest request)
```
    Description copied from interface: AmazonAthena
    
    Gets the current status of a session.
    
    Specified by:
    
    getSessionStatus in interface AmazonAthena
    
    Returns:
    
    Result of the GetSessionStatus operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getTableMetadata
```
public GetTableMetadataResult getTableMetadata(GetTableMetadataRequest request)
```
    Description copied from interface: AmazonAthena
    
    Returns table metadata for the specified catalog, database, and table.
    
    Specified by:
    
    getTableMetadata in interface AmazonAthena
    
    Returns:
    
    Result of the GetTableMetadata operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getWorkGroup
```
public GetWorkGroupResult getWorkGroup(GetWorkGroupRequest request)
```
    Description copied from interface: AmazonAthena
    
    Returns information about the workgroup with the specified name.
    
    Specified by:
    
    getWorkGroup in interface AmazonAthena
    
    Returns:
    
    Result of the GetWorkGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - importNotebook
```
public ImportNotebookResult importNotebook(ImportNotebookRequest request)
```
    Description copied from interface: AmazonAthena
    
    Imports a single ipynb file to a Spark enabled workgroup. To import the notebook, the request must specify a value for either Payload or NoteBookS3LocationUri. If neither is specified or both are specified, an InvalidRequestException occurs. The maximum file size that can be imported is 10 megabytes. If an ipynb file with the same name already exists in the workgroup, throws an error.
    
    Specified by:
    
    importNotebook in interface AmazonAthena
    
    Returns:
    
    Result of the ImportNotebook operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listApplicationDPUSizes
```
public ListApplicationDPUSizesResult listApplicationDPUSizes(ListApplicationDPUSizesRequest request)
```
    Description copied from interface: AmazonAthena
    
    Returns the supported DPU sizes for the supported application runtimes (for example, Athena notebook version 1).
    
    Specified by:
    
    listApplicationDPUSizes in interface AmazonAthena
    
    Returns:
    
    Result of the ListApplicationDPUSizes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listCalculationExecutions
```
public ListCalculationExecutionsResult listCalculationExecutions(ListCalculationExecutionsRequest request)
```
    Description copied from interface: AmazonAthena
    
    Lists the calculations that have been submitted to a session in descending order. Newer calculations are listed first; older calculations are listed later.
    
    Specified by:
    
    listCalculationExecutions in interface AmazonAthena
    
    Returns:
    
    Result of the ListCalculationExecutions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listCapacityReservations
```
public ListCapacityReservationsResult listCapacityReservations(ListCapacityReservationsRequest request)
```
    Description copied from interface: AmazonAthena
    
    Lists the capacity reservations for the current account.
    
    Specified by:
    
    listCapacityReservations in interface AmazonAthena
    
    Returns:
    
    Result of the ListCapacityReservations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDataCatalogs
```
public ListDataCatalogsResult listDataCatalogs(ListDataCatalogsRequest request)
```
    Description copied from interface: AmazonAthena
    
    Lists the data catalogs in the current Amazon Web Services account.
    
    In the Athena console, data catalogs are listed as "data sources" on the Data sources page under the Data source name column.
    
    Specified by:
    
    listDataCatalogs in interface AmazonAthena
    
    Returns:
    
    Result of the ListDataCatalogs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDatabases
```
public ListDatabasesResult listDatabases(ListDatabasesRequest request)
```
    Description copied from interface: AmazonAthena
    
    Lists the databases in the specified data catalog.
    
    Specified by:
    
    listDatabases in interface AmazonAthena
    
    Returns:
    
    Result of the ListDatabases operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listEngineVersions
```
public ListEngineVersionsResult listEngineVersions(ListEngineVersionsRequest request)
```
    Description copied from interface: AmazonAthena
    
    Returns a list of engine versions that are available to choose from, including the Auto option.
    
    Specified by:
    
    listEngineVersions in interface AmazonAthena
    
    Returns:
    
    Result of the ListEngineVersions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listExecutors
```
public ListExecutorsResult listExecutors(ListExecutorsRequest request)
```
    Description copied from interface: AmazonAthena
    
    Lists, in descending order, the executors that joined a session. Newer executors are listed first; older executors are listed later. The result can be optionally filtered by state.
    
    Specified by:
    
    listExecutors in interface AmazonAthena
    
    Returns:
    
    Result of the ListExecutors operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listNamedQueries
```
public ListNamedQueriesResult listNamedQueries(ListNamedQueriesRequest request)
```
    Description copied from interface: AmazonAthena
    
    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.
    
    Specified by:
    
    listNamedQueries in interface AmazonAthena
    
    Returns:
    
    Result of the ListNamedQueries operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listNotebookMetadata
```
public ListNotebookMetadataResult listNotebookMetadata(ListNotebookMetadataRequest request)
```
    Description copied from interface: AmazonAthena
    
    Displays the notebook files for the specified workgroup in paginated format.
    
    Specified by:
    
    listNotebookMetadata in interface AmazonAthena
    
    Returns:
    
    Result of the ListNotebookMetadata operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listNotebookSessions
```
public ListNotebookSessionsResult listNotebookSessions(ListNotebookSessionsRequest request)
```
    Description copied from interface: AmazonAthena
    
    Lists, in descending order, the sessions that have been created in a notebook that are in an active state like CREATING, CREATED, IDLE or BUSY. Newer sessions are listed first; older sessions are listed later.
    
    Specified by:
    
    listNotebookSessions in interface AmazonAthena
    
    Returns:
    
    Result of the ListNotebookSessions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listPreparedStatements
```
public ListPreparedStatementsResult listPreparedStatements(ListPreparedStatementsRequest request)
```
    Description copied from interface: AmazonAthena
    
    Lists the prepared statements in the specified workgroup.
    
    Specified by:
    
    listPreparedStatements in interface AmazonAthena
    
    Returns:
    
    Result of the ListPreparedStatements operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listQueryExecutions
```
public ListQueryExecutionsResult listQueryExecutions(ListQueryExecutionsRequest request)
```
    Description copied from interface: AmazonAthena
    
    Provides a list of available query execution IDs for the queries in the specified workgroup. Athena keeps a query history for 45 days. 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.
    
    Specified by:
    
    listQueryExecutions in interface AmazonAthena
    
    Returns:
    
    Result of the ListQueryExecutions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listSessions
```
public ListSessionsResult listSessions(ListSessionsRequest request)
```
    Description copied from interface: AmazonAthena
    
    Lists the sessions in a workgroup that are in an active state like CREATING, CREATED, IDLE, or BUSY. Newer sessions are listed first; older sessions are listed later.
    
    Specified by:
    
    listSessions in interface AmazonAthena
    
    Returns:
    
    Result of the ListSessions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTableMetadata
```
public ListTableMetadataResult listTableMetadata(ListTableMetadataRequest request)
```
    Description copied from interface: AmazonAthena
    
    Lists the metadata for the tables in the specified data catalog database.
    
    Specified by:
    
    listTableMetadata in interface AmazonAthena
    
    Returns:
    
    Result of the ListTableMetadata operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AmazonAthena
    
    Lists the tags associated with an Athena resource.
    
    Specified by:
    
    listTagsForResource in interface AmazonAthena
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listWorkGroups
```
public ListWorkGroupsResult listWorkGroups(ListWorkGroupsRequest request)
```
    Description copied from interface: AmazonAthena
    
    Lists available workgroups for the account.
    
    Specified by:
    
    listWorkGroups in interface AmazonAthena
    
    Returns:
    
    Result of the ListWorkGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putCapacityAssignmentConfiguration
```
public PutCapacityAssignmentConfigurationResult putCapacityAssignmentConfiguration(PutCapacityAssignmentConfigurationRequest request)
```
    Description copied from interface: AmazonAthena
    
    Puts a new capacity assignment configuration for a specified capacity reservation. If a capacity assignment configuration already exists for the capacity reservation, replaces the existing capacity assignment configuration.
    
    Specified by:
    
    putCapacityAssignmentConfiguration in interface AmazonAthena
    
    Returns:
    
    Result of the PutCapacityAssignmentConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startCalculationExecution
```
public StartCalculationExecutionResult startCalculationExecution(StartCalculationExecutionRequest request)
```
    Description copied from interface: AmazonAthena
    
    Submits calculations for execution within a session. You can supply the code to run as an inline code block within the request.
    
    The request syntax requires the StartCalculationExecutionRequest$CodeBlock parameter or the CalculationConfiguration$CodeBlock parameter, but not both. Because CalculationConfiguration$CodeBlock is deprecated, use the StartCalculationExecutionRequest$CodeBlock parameter instead.
    
    Specified by:
    
    startCalculationExecution in interface AmazonAthena
    
    Returns:
    
    Result of the StartCalculationExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startQueryExecution
```
public StartQueryExecutionResult startQueryExecution(StartQueryExecutionRequest request)
```
    Description copied from interface: AmazonAthena
    
    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
    
    Returns:
    
    Result of the StartQueryExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startSession
```
public StartSessionResult startSession(StartSessionRequest request)
```
    Description copied from interface: AmazonAthena
    
    Creates a session for running calculations within a workgroup. The session is ready when it reaches an IDLE state.
    
    Specified by:
    
    startSession in interface AmazonAthena
    
    Returns:
    
    Result of the StartSession operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopCalculationExecution
```
public StopCalculationExecutionResult stopCalculationExecution(StopCalculationExecutionRequest request)
```
    Description copied from interface: AmazonAthena
    
    Requests the cancellation of a calculation. A StopCalculationExecution call on a calculation that is already in a terminal state (for example, STOPPED, FAILED, or COMPLETED) succeeds but has no effect.
    
    Cancelling a calculation is done on a best effort basis. If a calculation cannot be cancelled, you can be charged for its completion. If you are concerned about being charged for a calculation that cannot be cancelled, consider terminating the session in which the calculation is running.
    
    Specified by:
    
    stopCalculationExecution in interface AmazonAthena
    
    Returns:
    
    Result of the StopCalculationExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopQueryExecution
```
public StopQueryExecutionResult stopQueryExecution(StopQueryExecutionRequest request)
```
    Description copied from interface: AmazonAthena
    
    Stops a query execution. Requires you to have access to the workgroup in which the query ran.
    
    Specified by:
    
    stopQueryExecution in interface AmazonAthena
    
    Returns:
    
    Result of the StopQueryExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AmazonAthena
    
    Adds one or more tags to an Athena resource. A tag is a label that you assign to a resource. 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, data catalogs, or capacity reservations by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter the resources 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
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - terminateSession
```
public TerminateSessionResult terminateSession(TerminateSessionRequest request)
```
    Description copied from interface: AmazonAthena
    
    Terminates an active session. A TerminateSession call on a session that is already inactive (for example, in a FAILED, TERMINATED or TERMINATING state) succeeds but has no effect. Calculations running in the session when TerminateSession is called are forcefully stopped, but may display as FAILED instead of STOPPED.
    
    Specified by:
    
    terminateSession in interface AmazonAthena
    
    Returns:
    
    Result of the TerminateSession operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AmazonAthena
    
    Removes one or more tags from an Athena resource.
    
    Specified by:
    
    untagResource in interface AmazonAthena
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateCapacityReservation
```
public UpdateCapacityReservationResult updateCapacityReservation(UpdateCapacityReservationRequest request)
```
    Description copied from interface: AmazonAthena
    
    Updates the number of requested data processing units for the capacity reservation with the specified name.
    
    Specified by:
    
    updateCapacityReservation in interface AmazonAthena
    
    Returns:
    
    Result of the UpdateCapacityReservation operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateDataCatalog
```
public UpdateDataCatalogResult updateDataCatalog(UpdateDataCatalogRequest request)
```
    Description copied from interface: AmazonAthena
    
    Updates the data catalog that has the specified name.
    
    Specified by:
    
    updateDataCatalog in interface AmazonAthena
    
    Returns:
    
    Result of the UpdateDataCatalog operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateNamedQuery
```
public UpdateNamedQueryResult updateNamedQuery(UpdateNamedQueryRequest request)
```
    Description copied from interface: AmazonAthena
    
    Updates a NamedQuery object. The database or workgroup cannot be updated.
    
    Specified by:
    
    updateNamedQuery in interface AmazonAthena
    
    Returns:
    
    Result of the UpdateNamedQuery operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateNotebook
```
public UpdateNotebookResult updateNotebook(UpdateNotebookRequest request)
```
    Description copied from interface: AmazonAthena
    
    Updates the contents of a Spark notebook.
    
    Specified by:
    
    updateNotebook in interface AmazonAthena
    
    Returns:
    
    Result of the UpdateNotebook operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateNotebookMetadata
```
public UpdateNotebookMetadataResult updateNotebookMetadata(UpdateNotebookMetadataRequest request)
```
    Description copied from interface: AmazonAthena
    
    Updates the metadata for a notebook.
    
    Specified by:
    
    updateNotebookMetadata in interface AmazonAthena
    
    Returns:
    
    Result of the UpdateNotebookMetadata operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updatePreparedStatement
```
public UpdatePreparedStatementResult updatePreparedStatement(UpdatePreparedStatementRequest request)
```
    Description copied from interface: AmazonAthena
    
    Updates a prepared statement.
    
    Specified by:
    
    updatePreparedStatement in interface AmazonAthena
    
    Returns:
    
    Result of the UpdatePreparedStatement operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateWorkGroup
```
public UpdateWorkGroupResult updateWorkGroup(UpdateWorkGroupRequest request)
```
    Description copied from interface: AmazonAthena
    
    Updates the workgroup with the specified name. The workgroup's name cannot be changed. Only ConfigurationUpdates can be specified.
    
    Specified by:
    
    updateWorkGroup in interface AmazonAthena
    
    Returns:
    
    Result of the UpdateWorkGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - 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
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonAthena
    
    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.
    
    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.

AWS SDK for Java 1.x API Reference - 1.12.773

Class AbstractAmazonAthena

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

batchGetNamedQuery

batchGetPreparedStatement

batchGetQueryExecution

cancelCapacityReservation

createCapacityReservation

createDataCatalog

createNamedQuery

createNotebook

createPreparedStatement

createPresignedNotebookUrl

createWorkGroup

deleteCapacityReservation

deleteDataCatalog

deleteNamedQuery

deleteNotebook

deletePreparedStatement

deleteWorkGroup

exportNotebook

getCalculationExecution

getCalculationExecutionCode

getCalculationExecutionStatus

getCapacityAssignmentConfiguration

getCapacityReservation

getDataCatalog

getDatabase

getNamedQuery

getNotebookMetadata

getPreparedStatement

getQueryExecution

getQueryResults

getQueryRuntimeStatistics

getSession

getSessionStatus

getTableMetadata

getWorkGroup

importNotebook

listApplicationDPUSizes

listCalculationExecutions

listCapacityReservations

listDataCatalogs

listDatabases

listEngineVersions

listExecutors

listNamedQueries

listNotebookMetadata

listNotebookSessions

listPreparedStatements

listQueryExecutions

listSessions

listTableMetadata

listTagsForResource

listWorkGroups

putCapacityAssignmentConfiguration

startCalculationExecution

startQueryExecution

startSession

stopCalculationExecution

stopQueryExecution

tagResource

terminateSession

untagResource

updateCapacityReservation

updateDataCatalog

updateNamedQuery

updateNotebook

updateNotebookMetadata

updatePreparedStatement

updateWorkGroup

shutdown

getCachedResponseMetadata