@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonAthenaAsync extends AmazonAthena
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonAthenaAsync instead.
Amazon Athena is an interactive query service that lets you use standard SQL to analyze data directly in Amazon S3. You can point Athena at your data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so there is no infrastructure to set up or manage. You pay only for the queries you run. Athena scales automatically—executing queries in parallel—so results are fast, even with large datasets and complex queries. For more information, see What is Amazon Athena in the Amazon Athena User Guide.
If you connect to Athena using the JDBC driver, use version 1.1.0 of the driver or later with the Amazon Athena API. Earlier version drivers do not support the API. For more information and to download the driver, see Accessing Amazon Athena with JDBC.
ENDPOINT_PREFIXbatchGetNamedQuery, batchGetPreparedStatement, batchGetQueryExecution, cancelCapacityReservation, createCapacityReservation, createDataCatalog, createNamedQuery, createNotebook, createPreparedStatement, createPresignedNotebookUrl, createWorkGroup, deleteCapacityReservation, deleteDataCatalog, deleteNamedQuery, deleteNotebook, deletePreparedStatement, deleteWorkGroup, exportNotebook, getCachedResponseMetadata, getCalculationExecution, getCalculationExecutionCode, getCalculationExecutionStatus, getCapacityAssignmentConfiguration, getCapacityReservation, getDatabase, getDataCatalog, getNamedQuery, getNotebookMetadata, getPreparedStatement, getQueryExecution, getQueryResults, getQueryRuntimeStatistics, getSession, getSessionStatus, getTableMetadata, getWorkGroup, importNotebook, listApplicationDPUSizes, listCalculationExecutions, listCapacityReservations, listDatabases, listDataCatalogs, listEngineVersions, listExecutors, listNamedQueries, listNotebookMetadata, listNotebookSessions, listPreparedStatements, listQueryExecutions, listSessions, listTableMetadata, listTagsForResource, listWorkGroups, putCapacityAssignmentConfiguration, shutdown, startCalculationExecution, startQueryExecution, startSession, stopCalculationExecution, stopQueryExecution, tagResource, terminateSession, untagResource, updateCapacityReservation, updateDataCatalog, updateNamedQuery, updateNotebook, updateNotebookMetadata, updatePreparedStatement, updateWorkGroupFuture<BatchGetNamedQueryResult> batchGetNamedQueryAsync(BatchGetNamedQueryRequest batchGetNamedQueryRequest)
Returns the details of a single named query or a list of up to 50 queries, which you provide as an array of query ID strings. Requires you to have access to the workgroup in which the queries were saved. Use ListNamedQueriesInput to get the list of named query IDs in the specified workgroup. If information could not be retrieved for a submitted query ID, information about the query ID submitted is listed under UnprocessedNamedQueryId. Named queries differ from executed queries. Use BatchGetQueryExecutionInput to get details about each unique query execution, and ListQueryExecutionsInput to get a list of query execution IDs.
batchGetNamedQueryRequest - Contains an array of named query IDs.Future<BatchGetNamedQueryResult> batchGetNamedQueryAsync(BatchGetNamedQueryRequest batchGetNamedQueryRequest, AsyncHandler<BatchGetNamedQueryRequest,BatchGetNamedQueryResult> asyncHandler)
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.
batchGetNamedQueryRequest - Contains an array of named query IDs.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<BatchGetPreparedStatementResult> batchGetPreparedStatementAsync(BatchGetPreparedStatementRequest batchGetPreparedStatementRequest)
Returns the details of a single prepared statement or a list of up to 256 prepared statements for the array of
prepared statement names that you provide. Requires you to have access to the workgroup to which the prepared
statements belong. If a prepared statement cannot be retrieved for the name specified, the statement is listed in
UnprocessedPreparedStatementNames.
batchGetPreparedStatementRequest - Future<BatchGetPreparedStatementResult> batchGetPreparedStatementAsync(BatchGetPreparedStatementRequest batchGetPreparedStatementRequest, AsyncHandler<BatchGetPreparedStatementRequest,BatchGetPreparedStatementResult> asyncHandler)
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.
batchGetPreparedStatementRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<BatchGetQueryExecutionResult> batchGetQueryExecutionAsync(BatchGetQueryExecutionRequest batchGetQueryExecutionRequest)
Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings. Requires you to have access to the workgroup in which the queries ran. To get a list of query execution IDs, use ListQueryExecutionsInput$WorkGroup. Query executions differ from named (saved) queries. Use BatchGetNamedQueryInput to get details about named queries.
batchGetQueryExecutionRequest - Contains an array of query execution IDs.Future<BatchGetQueryExecutionResult> batchGetQueryExecutionAsync(BatchGetQueryExecutionRequest batchGetQueryExecutionRequest, AsyncHandler<BatchGetQueryExecutionRequest,BatchGetQueryExecutionResult> asyncHandler)
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.
batchGetQueryExecutionRequest - Contains an array of query execution IDs.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CancelCapacityReservationResult> cancelCapacityReservationAsync(CancelCapacityReservationRequest cancelCapacityReservationRequest)
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.
cancelCapacityReservationRequest - Future<CancelCapacityReservationResult> cancelCapacityReservationAsync(CancelCapacityReservationRequest cancelCapacityReservationRequest, AsyncHandler<CancelCapacityReservationRequest,CancelCapacityReservationResult> asyncHandler)
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.
cancelCapacityReservationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateCapacityReservationResult> createCapacityReservationAsync(CreateCapacityReservationRequest createCapacityReservationRequest)
Creates a capacity reservation with the specified name and number of requested data processing units.
createCapacityReservationRequest - Future<CreateCapacityReservationResult> createCapacityReservationAsync(CreateCapacityReservationRequest createCapacityReservationRequest, AsyncHandler<CreateCapacityReservationRequest,CreateCapacityReservationResult> asyncHandler)
Creates a capacity reservation with the specified name and number of requested data processing units.
createCapacityReservationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateDataCatalogResult> createDataCatalogAsync(CreateDataCatalogRequest createDataCatalogRequest)
Creates (registers) a data catalog with the specified name and properties. Catalogs created are visible to all users of the same Amazon Web Services account.
createDataCatalogRequest - Future<CreateDataCatalogResult> createDataCatalogAsync(CreateDataCatalogRequest createDataCatalogRequest, AsyncHandler<CreateDataCatalogRequest,CreateDataCatalogResult> asyncHandler)
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.
createDataCatalogRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateNamedQueryResult> createNamedQueryAsync(CreateNamedQueryRequest createNamedQueryRequest)
Creates a named query in the specified workgroup. Requires that you have access to the workgroup.
createNamedQueryRequest - Future<CreateNamedQueryResult> createNamedQueryAsync(CreateNamedQueryRequest createNamedQueryRequest, AsyncHandler<CreateNamedQueryRequest,CreateNamedQueryResult> asyncHandler)
Creates a named query in the specified workgroup. Requires that you have access to the workgroup.
createNamedQueryRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateNotebookResult> createNotebookAsync(CreateNotebookRequest createNotebookRequest)
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.
createNotebookRequest - Future<CreateNotebookResult> createNotebookAsync(CreateNotebookRequest createNotebookRequest, AsyncHandler<CreateNotebookRequest,CreateNotebookResult> asyncHandler)
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.
createNotebookRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreatePreparedStatementResult> createPreparedStatementAsync(CreatePreparedStatementRequest createPreparedStatementRequest)
Creates a prepared statement for use with SQL queries in Athena.
createPreparedStatementRequest - Future<CreatePreparedStatementResult> createPreparedStatementAsync(CreatePreparedStatementRequest createPreparedStatementRequest, AsyncHandler<CreatePreparedStatementRequest,CreatePreparedStatementResult> asyncHandler)
Creates a prepared statement for use with SQL queries in Athena.
createPreparedStatementRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreatePresignedNotebookUrlResult> createPresignedNotebookUrlAsync(CreatePresignedNotebookUrlRequest createPresignedNotebookUrlRequest)
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.
createPresignedNotebookUrlRequest - Future<CreatePresignedNotebookUrlResult> createPresignedNotebookUrlAsync(CreatePresignedNotebookUrlRequest createPresignedNotebookUrlRequest, AsyncHandler<CreatePresignedNotebookUrlRequest,CreatePresignedNotebookUrlResult> asyncHandler)
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.
createPresignedNotebookUrlRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateWorkGroupResult> createWorkGroupAsync(CreateWorkGroupRequest createWorkGroupRequest)
Creates a workgroup with the specified name. A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup.
createWorkGroupRequest - Future<CreateWorkGroupResult> createWorkGroupAsync(CreateWorkGroupRequest createWorkGroupRequest, AsyncHandler<CreateWorkGroupRequest,CreateWorkGroupResult> asyncHandler)
Creates a workgroup with the specified name. A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup.
createWorkGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteCapacityReservationResult> deleteCapacityReservationAsync(DeleteCapacityReservationRequest deleteCapacityReservationRequest)
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.
deleteCapacityReservationRequest - Future<DeleteCapacityReservationResult> deleteCapacityReservationAsync(DeleteCapacityReservationRequest deleteCapacityReservationRequest, AsyncHandler<DeleteCapacityReservationRequest,DeleteCapacityReservationResult> asyncHandler)
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.
deleteCapacityReservationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteDataCatalogResult> deleteDataCatalogAsync(DeleteDataCatalogRequest deleteDataCatalogRequest)
Deletes a data catalog.
deleteDataCatalogRequest - Future<DeleteDataCatalogResult> deleteDataCatalogAsync(DeleteDataCatalogRequest deleteDataCatalogRequest, AsyncHandler<DeleteDataCatalogRequest,DeleteDataCatalogResult> asyncHandler)
Deletes a data catalog.
deleteDataCatalogRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteNamedQueryResult> deleteNamedQueryAsync(DeleteNamedQueryRequest deleteNamedQueryRequest)
Deletes the named query if you have access to the workgroup in which the query was saved.
deleteNamedQueryRequest - Future<DeleteNamedQueryResult> deleteNamedQueryAsync(DeleteNamedQueryRequest deleteNamedQueryRequest, AsyncHandler<DeleteNamedQueryRequest,DeleteNamedQueryResult> asyncHandler)
Deletes the named query if you have access to the workgroup in which the query was saved.
deleteNamedQueryRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteNotebookResult> deleteNotebookAsync(DeleteNotebookRequest deleteNotebookRequest)
Deletes the specified notebook.
deleteNotebookRequest - Future<DeleteNotebookResult> deleteNotebookAsync(DeleteNotebookRequest deleteNotebookRequest, AsyncHandler<DeleteNotebookRequest,DeleteNotebookResult> asyncHandler)
Deletes the specified notebook.
deleteNotebookRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeletePreparedStatementResult> deletePreparedStatementAsync(DeletePreparedStatementRequest deletePreparedStatementRequest)
Deletes the prepared statement with the specified name from the specified workgroup.
deletePreparedStatementRequest - Future<DeletePreparedStatementResult> deletePreparedStatementAsync(DeletePreparedStatementRequest deletePreparedStatementRequest, AsyncHandler<DeletePreparedStatementRequest,DeletePreparedStatementResult> asyncHandler)
Deletes the prepared statement with the specified name from the specified workgroup.
deletePreparedStatementRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteWorkGroupResult> deleteWorkGroupAsync(DeleteWorkGroupRequest deleteWorkGroupRequest)
Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.
deleteWorkGroupRequest - Future<DeleteWorkGroupResult> deleteWorkGroupAsync(DeleteWorkGroupRequest deleteWorkGroupRequest, AsyncHandler<DeleteWorkGroupRequest,DeleteWorkGroupResult> asyncHandler)
Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.
deleteWorkGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ExportNotebookResult> exportNotebookAsync(ExportNotebookRequest exportNotebookRequest)
Exports the specified notebook and its metadata.
exportNotebookRequest - Future<ExportNotebookResult> exportNotebookAsync(ExportNotebookRequest exportNotebookRequest, AsyncHandler<ExportNotebookRequest,ExportNotebookResult> asyncHandler)
Exports the specified notebook and its metadata.
exportNotebookRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetCalculationExecutionResult> getCalculationExecutionAsync(GetCalculationExecutionRequest getCalculationExecutionRequest)
Describes a previously submitted calculation execution.
getCalculationExecutionRequest - Future<GetCalculationExecutionResult> getCalculationExecutionAsync(GetCalculationExecutionRequest getCalculationExecutionRequest, AsyncHandler<GetCalculationExecutionRequest,GetCalculationExecutionResult> asyncHandler)
Describes a previously submitted calculation execution.
getCalculationExecutionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetCalculationExecutionCodeResult> getCalculationExecutionCodeAsync(GetCalculationExecutionCodeRequest getCalculationExecutionCodeRequest)
Retrieves the unencrypted code that was executed for the calculation.
getCalculationExecutionCodeRequest - Future<GetCalculationExecutionCodeResult> getCalculationExecutionCodeAsync(GetCalculationExecutionCodeRequest getCalculationExecutionCodeRequest, AsyncHandler<GetCalculationExecutionCodeRequest,GetCalculationExecutionCodeResult> asyncHandler)
Retrieves the unencrypted code that was executed for the calculation.
getCalculationExecutionCodeRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetCalculationExecutionStatusResult> getCalculationExecutionStatusAsync(GetCalculationExecutionStatusRequest getCalculationExecutionStatusRequest)
Gets the status of a current calculation.
getCalculationExecutionStatusRequest - Future<GetCalculationExecutionStatusResult> getCalculationExecutionStatusAsync(GetCalculationExecutionStatusRequest getCalculationExecutionStatusRequest, AsyncHandler<GetCalculationExecutionStatusRequest,GetCalculationExecutionStatusResult> asyncHandler)
Gets the status of a current calculation.
getCalculationExecutionStatusRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetCapacityAssignmentConfigurationResult> getCapacityAssignmentConfigurationAsync(GetCapacityAssignmentConfigurationRequest getCapacityAssignmentConfigurationRequest)
Gets the capacity assignment configuration for a capacity reservation, if one exists.
getCapacityAssignmentConfigurationRequest - Future<GetCapacityAssignmentConfigurationResult> getCapacityAssignmentConfigurationAsync(GetCapacityAssignmentConfigurationRequest getCapacityAssignmentConfigurationRequest, AsyncHandler<GetCapacityAssignmentConfigurationRequest,GetCapacityAssignmentConfigurationResult> asyncHandler)
Gets the capacity assignment configuration for a capacity reservation, if one exists.
getCapacityAssignmentConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetCapacityReservationResult> getCapacityReservationAsync(GetCapacityReservationRequest getCapacityReservationRequest)
Returns information about the capacity reservation with the specified name.
getCapacityReservationRequest - Future<GetCapacityReservationResult> getCapacityReservationAsync(GetCapacityReservationRequest getCapacityReservationRequest, AsyncHandler<GetCapacityReservationRequest,GetCapacityReservationResult> asyncHandler)
Returns information about the capacity reservation with the specified name.
getCapacityReservationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetDataCatalogResult> getDataCatalogAsync(GetDataCatalogRequest getDataCatalogRequest)
Returns the specified data catalog.
getDataCatalogRequest - Future<GetDataCatalogResult> getDataCatalogAsync(GetDataCatalogRequest getDataCatalogRequest, AsyncHandler<GetDataCatalogRequest,GetDataCatalogResult> asyncHandler)
Returns the specified data catalog.
getDataCatalogRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetDatabaseResult> getDatabaseAsync(GetDatabaseRequest getDatabaseRequest)
Returns a database object for the specified database and data catalog.
getDatabaseRequest - Future<GetDatabaseResult> getDatabaseAsync(GetDatabaseRequest getDatabaseRequest, AsyncHandler<GetDatabaseRequest,GetDatabaseResult> asyncHandler)
Returns a database object for the specified database and data catalog.
getDatabaseRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetNamedQueryResult> getNamedQueryAsync(GetNamedQueryRequest getNamedQueryRequest)
Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.
getNamedQueryRequest - Future<GetNamedQueryResult> getNamedQueryAsync(GetNamedQueryRequest getNamedQueryRequest, AsyncHandler<GetNamedQueryRequest,GetNamedQueryResult> asyncHandler)
Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.
getNamedQueryRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetNotebookMetadataResult> getNotebookMetadataAsync(GetNotebookMetadataRequest getNotebookMetadataRequest)
Retrieves notebook metadata for the specified notebook ID.
getNotebookMetadataRequest - Future<GetNotebookMetadataResult> getNotebookMetadataAsync(GetNotebookMetadataRequest getNotebookMetadataRequest, AsyncHandler<GetNotebookMetadataRequest,GetNotebookMetadataResult> asyncHandler)
Retrieves notebook metadata for the specified notebook ID.
getNotebookMetadataRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetPreparedStatementResult> getPreparedStatementAsync(GetPreparedStatementRequest getPreparedStatementRequest)
Retrieves the prepared statement with the specified name from the specified workgroup.
getPreparedStatementRequest - Future<GetPreparedStatementResult> getPreparedStatementAsync(GetPreparedStatementRequest getPreparedStatementRequest, AsyncHandler<GetPreparedStatementRequest,GetPreparedStatementResult> asyncHandler)
Retrieves the prepared statement with the specified name from the specified workgroup.
getPreparedStatementRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetQueryExecutionResult> getQueryExecutionAsync(GetQueryExecutionRequest getQueryExecutionRequest)
Returns information about a single execution of a query if you have access to the workgroup in which the query ran. Each time a query executes, information about the query execution is saved with a unique ID.
getQueryExecutionRequest - Future<GetQueryExecutionResult> getQueryExecutionAsync(GetQueryExecutionRequest getQueryExecutionRequest, AsyncHandler<GetQueryExecutionRequest,GetQueryExecutionResult> asyncHandler)
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.
getQueryExecutionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetQueryResultsResult> getQueryResultsAsync(GetQueryResultsRequest getQueryResultsRequest)
Streams the results of a single query execution specified by QueryExecutionId from the Athena query
results location in Amazon S3. For more information, see 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.
getQueryResultsRequest - Future<GetQueryResultsResult> getQueryResultsAsync(GetQueryResultsRequest getQueryResultsRequest, AsyncHandler<GetQueryResultsRequest,GetQueryResultsResult> asyncHandler)
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.
getQueryResultsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetQueryRuntimeStatisticsResult> getQueryRuntimeStatisticsAsync(GetQueryRuntimeStatisticsRequest getQueryRuntimeStatisticsRequest)
Returns query execution runtime statistics related to a single execution of a query if you have access to the
workgroup in which the query ran. 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.
getQueryRuntimeStatisticsRequest - Future<GetQueryRuntimeStatisticsResult> getQueryRuntimeStatisticsAsync(GetQueryRuntimeStatisticsRequest getQueryRuntimeStatisticsRequest, AsyncHandler<GetQueryRuntimeStatisticsRequest,GetQueryRuntimeStatisticsResult> asyncHandler)
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.
getQueryRuntimeStatisticsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetSessionResult> getSessionAsync(GetSessionRequest getSessionRequest)
Gets the full details of a previously created session, including the session status and configuration.
getSessionRequest - Future<GetSessionResult> getSessionAsync(GetSessionRequest getSessionRequest, AsyncHandler<GetSessionRequest,GetSessionResult> asyncHandler)
Gets the full details of a previously created session, including the session status and configuration.
getSessionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetSessionStatusResult> getSessionStatusAsync(GetSessionStatusRequest getSessionStatusRequest)
Gets the current status of a session.
getSessionStatusRequest - Future<GetSessionStatusResult> getSessionStatusAsync(GetSessionStatusRequest getSessionStatusRequest, AsyncHandler<GetSessionStatusRequest,GetSessionStatusResult> asyncHandler)
Gets the current status of a session.
getSessionStatusRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetTableMetadataResult> getTableMetadataAsync(GetTableMetadataRequest getTableMetadataRequest)
Returns table metadata for the specified catalog, database, and table.
getTableMetadataRequest - Future<GetTableMetadataResult> getTableMetadataAsync(GetTableMetadataRequest getTableMetadataRequest, AsyncHandler<GetTableMetadataRequest,GetTableMetadataResult> asyncHandler)
Returns table metadata for the specified catalog, database, and table.
getTableMetadataRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetWorkGroupResult> getWorkGroupAsync(GetWorkGroupRequest getWorkGroupRequest)
Returns information about the workgroup with the specified name.
getWorkGroupRequest - Future<GetWorkGroupResult> getWorkGroupAsync(GetWorkGroupRequest getWorkGroupRequest, AsyncHandler<GetWorkGroupRequest,GetWorkGroupResult> asyncHandler)
Returns information about the workgroup with the specified name.
getWorkGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ImportNotebookResult> importNotebookAsync(ImportNotebookRequest importNotebookRequest)
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.
importNotebookRequest - Future<ImportNotebookResult> importNotebookAsync(ImportNotebookRequest importNotebookRequest, AsyncHandler<ImportNotebookRequest,ImportNotebookResult> asyncHandler)
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.
importNotebookRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListApplicationDPUSizesResult> listApplicationDPUSizesAsync(ListApplicationDPUSizesRequest listApplicationDPUSizesRequest)
Returns the supported DPU sizes for the supported application runtimes (for example,
Athena notebook version 1).
listApplicationDPUSizesRequest - Future<ListApplicationDPUSizesResult> listApplicationDPUSizesAsync(ListApplicationDPUSizesRequest listApplicationDPUSizesRequest, AsyncHandler<ListApplicationDPUSizesRequest,ListApplicationDPUSizesResult> asyncHandler)
Returns the supported DPU sizes for the supported application runtimes (for example,
Athena notebook version 1).
listApplicationDPUSizesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListCalculationExecutionsResult> listCalculationExecutionsAsync(ListCalculationExecutionsRequest listCalculationExecutionsRequest)
Lists the calculations that have been submitted to a session in descending order. Newer calculations are listed first; older calculations are listed later.
listCalculationExecutionsRequest - Future<ListCalculationExecutionsResult> listCalculationExecutionsAsync(ListCalculationExecutionsRequest listCalculationExecutionsRequest, AsyncHandler<ListCalculationExecutionsRequest,ListCalculationExecutionsResult> asyncHandler)
Lists the calculations that have been submitted to a session in descending order. Newer calculations are listed first; older calculations are listed later.
listCalculationExecutionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListCapacityReservationsResult> listCapacityReservationsAsync(ListCapacityReservationsRequest listCapacityReservationsRequest)
Lists the capacity reservations for the current account.
listCapacityReservationsRequest - Future<ListCapacityReservationsResult> listCapacityReservationsAsync(ListCapacityReservationsRequest listCapacityReservationsRequest, AsyncHandler<ListCapacityReservationsRequest,ListCapacityReservationsResult> asyncHandler)
Lists the capacity reservations for the current account.
listCapacityReservationsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListDataCatalogsResult> listDataCatalogsAsync(ListDataCatalogsRequest listDataCatalogsRequest)
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.
listDataCatalogsRequest - Future<ListDataCatalogsResult> listDataCatalogsAsync(ListDataCatalogsRequest listDataCatalogsRequest, AsyncHandler<ListDataCatalogsRequest,ListDataCatalogsResult> asyncHandler)
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.
listDataCatalogsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListDatabasesResult> listDatabasesAsync(ListDatabasesRequest listDatabasesRequest)
Lists the databases in the specified data catalog.
listDatabasesRequest - Future<ListDatabasesResult> listDatabasesAsync(ListDatabasesRequest listDatabasesRequest, AsyncHandler<ListDatabasesRequest,ListDatabasesResult> asyncHandler)
Lists the databases in the specified data catalog.
listDatabasesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListEngineVersionsResult> listEngineVersionsAsync(ListEngineVersionsRequest listEngineVersionsRequest)
Returns a list of engine versions that are available to choose from, including the Auto option.
listEngineVersionsRequest - Future<ListEngineVersionsResult> listEngineVersionsAsync(ListEngineVersionsRequest listEngineVersionsRequest, AsyncHandler<ListEngineVersionsRequest,ListEngineVersionsResult> asyncHandler)
Returns a list of engine versions that are available to choose from, including the Auto option.
listEngineVersionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListExecutorsResult> listExecutorsAsync(ListExecutorsRequest listExecutorsRequest)
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.
listExecutorsRequest - Future<ListExecutorsResult> listExecutorsAsync(ListExecutorsRequest listExecutorsRequest, AsyncHandler<ListExecutorsRequest,ListExecutorsResult> asyncHandler)
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.
listExecutorsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListNamedQueriesResult> listNamedQueriesAsync(ListNamedQueriesRequest listNamedQueriesRequest)
Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the specified workgroup. If a workgroup is not specified, lists the saved queries for the primary workgroup.
listNamedQueriesRequest - Future<ListNamedQueriesResult> listNamedQueriesAsync(ListNamedQueriesRequest listNamedQueriesRequest, AsyncHandler<ListNamedQueriesRequest,ListNamedQueriesResult> asyncHandler)
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.
listNamedQueriesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListNotebookMetadataResult> listNotebookMetadataAsync(ListNotebookMetadataRequest listNotebookMetadataRequest)
Displays the notebook files for the specified workgroup in paginated format.
listNotebookMetadataRequest - Future<ListNotebookMetadataResult> listNotebookMetadataAsync(ListNotebookMetadataRequest listNotebookMetadataRequest, AsyncHandler<ListNotebookMetadataRequest,ListNotebookMetadataResult> asyncHandler)
Displays the notebook files for the specified workgroup in paginated format.
listNotebookMetadataRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListNotebookSessionsResult> listNotebookSessionsAsync(ListNotebookSessionsRequest listNotebookSessionsRequest)
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.
listNotebookSessionsRequest - Future<ListNotebookSessionsResult> listNotebookSessionsAsync(ListNotebookSessionsRequest listNotebookSessionsRequest, AsyncHandler<ListNotebookSessionsRequest,ListNotebookSessionsResult> asyncHandler)
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.
listNotebookSessionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListPreparedStatementsResult> listPreparedStatementsAsync(ListPreparedStatementsRequest listPreparedStatementsRequest)
Lists the prepared statements in the specified workgroup.
listPreparedStatementsRequest - Future<ListPreparedStatementsResult> listPreparedStatementsAsync(ListPreparedStatementsRequest listPreparedStatementsRequest, AsyncHandler<ListPreparedStatementsRequest,ListPreparedStatementsResult> asyncHandler)
Lists the prepared statements in the specified workgroup.
listPreparedStatementsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListQueryExecutionsResult> listQueryExecutionsAsync(ListQueryExecutionsRequest listQueryExecutionsRequest)
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.
listQueryExecutionsRequest - Future<ListQueryExecutionsResult> listQueryExecutionsAsync(ListQueryExecutionsRequest listQueryExecutionsRequest, AsyncHandler<ListQueryExecutionsRequest,ListQueryExecutionsResult> asyncHandler)
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.
listQueryExecutionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListSessionsResult> listSessionsAsync(ListSessionsRequest listSessionsRequest)
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.
listSessionsRequest - Future<ListSessionsResult> listSessionsAsync(ListSessionsRequest listSessionsRequest, AsyncHandler<ListSessionsRequest,ListSessionsResult> asyncHandler)
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.
listSessionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTableMetadataResult> listTableMetadataAsync(ListTableMetadataRequest listTableMetadataRequest)
Lists the metadata for the tables in the specified data catalog database.
listTableMetadataRequest - Future<ListTableMetadataResult> listTableMetadataAsync(ListTableMetadataRequest listTableMetadataRequest, AsyncHandler<ListTableMetadataRequest,ListTableMetadataResult> asyncHandler)
Lists the metadata for the tables in the specified data catalog database.
listTableMetadataRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags associated with an Athena resource.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Lists the tags associated with an Athena resource.
listTagsForResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListWorkGroupsResult> listWorkGroupsAsync(ListWorkGroupsRequest listWorkGroupsRequest)
Lists available workgroups for the account.
listWorkGroupsRequest - Future<ListWorkGroupsResult> listWorkGroupsAsync(ListWorkGroupsRequest listWorkGroupsRequest, AsyncHandler<ListWorkGroupsRequest,ListWorkGroupsResult> asyncHandler)
Lists available workgroups for the account.
listWorkGroupsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutCapacityAssignmentConfigurationResult> putCapacityAssignmentConfigurationAsync(PutCapacityAssignmentConfigurationRequest putCapacityAssignmentConfigurationRequest)
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.
putCapacityAssignmentConfigurationRequest - Future<PutCapacityAssignmentConfigurationResult> putCapacityAssignmentConfigurationAsync(PutCapacityAssignmentConfigurationRequest putCapacityAssignmentConfigurationRequest, AsyncHandler<PutCapacityAssignmentConfigurationRequest,PutCapacityAssignmentConfigurationResult> asyncHandler)
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.
putCapacityAssignmentConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartCalculationExecutionResult> startCalculationExecutionAsync(StartCalculationExecutionRequest startCalculationExecutionRequest)
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.
startCalculationExecutionRequest - Future<StartCalculationExecutionResult> startCalculationExecutionAsync(StartCalculationExecutionRequest startCalculationExecutionRequest, AsyncHandler<StartCalculationExecutionRequest,StartCalculationExecutionResult> asyncHandler)
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.
startCalculationExecutionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartQueryExecutionResult> startQueryExecutionAsync(StartQueryExecutionRequest startQueryExecutionRequest)
Runs the SQL query statements contained in the Query. Requires you to have access to the workgroup
in which the query ran. Running queries against an external catalog requires GetDataCatalog permission to
the catalog. For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the
Amazon Athena User Guide.
startQueryExecutionRequest - Future<StartQueryExecutionResult> startQueryExecutionAsync(StartQueryExecutionRequest startQueryExecutionRequest, AsyncHandler<StartQueryExecutionRequest,StartQueryExecutionResult> asyncHandler)
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.
startQueryExecutionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartSessionResult> startSessionAsync(StartSessionRequest startSessionRequest)
Creates a session for running calculations within a workgroup. The session is ready when it reaches an
IDLE state.
startSessionRequest - Future<StartSessionResult> startSessionAsync(StartSessionRequest startSessionRequest, AsyncHandler<StartSessionRequest,StartSessionResult> asyncHandler)
Creates a session for running calculations within a workgroup. The session is ready when it reaches an
IDLE state.
startSessionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StopCalculationExecutionResult> stopCalculationExecutionAsync(StopCalculationExecutionRequest stopCalculationExecutionRequest)
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.
stopCalculationExecutionRequest - Future<StopCalculationExecutionResult> stopCalculationExecutionAsync(StopCalculationExecutionRequest stopCalculationExecutionRequest, AsyncHandler<StopCalculationExecutionRequest,StopCalculationExecutionResult> asyncHandler)
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.
stopCalculationExecutionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StopQueryExecutionResult> stopQueryExecutionAsync(StopQueryExecutionRequest stopQueryExecutionRequest)
Stops a query execution. Requires you to have access to the workgroup in which the query ran.
stopQueryExecutionRequest - Future<StopQueryExecutionResult> stopQueryExecutionAsync(StopQueryExecutionRequest stopQueryExecutionRequest, AsyncHandler<StopQueryExecutionRequest,StopQueryExecutionResult> asyncHandler)
Stops a query execution. Requires you to have access to the workgroup in which the query ran.
stopQueryExecutionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
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.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
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.
tagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TerminateSessionResult> terminateSessionAsync(TerminateSessionRequest terminateSessionRequest)
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.
terminateSessionRequest - Future<TerminateSessionResult> terminateSessionAsync(TerminateSessionRequest terminateSessionRequest, AsyncHandler<TerminateSessionRequest,TerminateSessionResult> asyncHandler)
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.
terminateSessionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes one or more tags from an Athena resource.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes one or more tags from an Athena resource.
untagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateCapacityReservationResult> updateCapacityReservationAsync(UpdateCapacityReservationRequest updateCapacityReservationRequest)
Updates the number of requested data processing units for the capacity reservation with the specified name.
updateCapacityReservationRequest - Future<UpdateCapacityReservationResult> updateCapacityReservationAsync(UpdateCapacityReservationRequest updateCapacityReservationRequest, AsyncHandler<UpdateCapacityReservationRequest,UpdateCapacityReservationResult> asyncHandler)
Updates the number of requested data processing units for the capacity reservation with the specified name.
updateCapacityReservationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateDataCatalogResult> updateDataCatalogAsync(UpdateDataCatalogRequest updateDataCatalogRequest)
Updates the data catalog that has the specified name.
updateDataCatalogRequest - Future<UpdateDataCatalogResult> updateDataCatalogAsync(UpdateDataCatalogRequest updateDataCatalogRequest, AsyncHandler<UpdateDataCatalogRequest,UpdateDataCatalogResult> asyncHandler)
Updates the data catalog that has the specified name.
updateDataCatalogRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateNamedQueryResult> updateNamedQueryAsync(UpdateNamedQueryRequest updateNamedQueryRequest)
Updates a NamedQuery object. The database or workgroup cannot be updated.
updateNamedQueryRequest - Future<UpdateNamedQueryResult> updateNamedQueryAsync(UpdateNamedQueryRequest updateNamedQueryRequest, AsyncHandler<UpdateNamedQueryRequest,UpdateNamedQueryResult> asyncHandler)
Updates a NamedQuery object. The database or workgroup cannot be updated.
updateNamedQueryRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateNotebookResult> updateNotebookAsync(UpdateNotebookRequest updateNotebookRequest)
Updates the contents of a Spark notebook.
updateNotebookRequest - Future<UpdateNotebookResult> updateNotebookAsync(UpdateNotebookRequest updateNotebookRequest, AsyncHandler<UpdateNotebookRequest,UpdateNotebookResult> asyncHandler)
Updates the contents of a Spark notebook.
updateNotebookRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateNotebookMetadataResult> updateNotebookMetadataAsync(UpdateNotebookMetadataRequest updateNotebookMetadataRequest)
Updates the metadata for a notebook.
updateNotebookMetadataRequest - Future<UpdateNotebookMetadataResult> updateNotebookMetadataAsync(UpdateNotebookMetadataRequest updateNotebookMetadataRequest, AsyncHandler<UpdateNotebookMetadataRequest,UpdateNotebookMetadataResult> asyncHandler)
Updates the metadata for a notebook.
updateNotebookMetadataRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdatePreparedStatementResult> updatePreparedStatementAsync(UpdatePreparedStatementRequest updatePreparedStatementRequest)
Updates a prepared statement.
updatePreparedStatementRequest - Future<UpdatePreparedStatementResult> updatePreparedStatementAsync(UpdatePreparedStatementRequest updatePreparedStatementRequest, AsyncHandler<UpdatePreparedStatementRequest,UpdatePreparedStatementResult> asyncHandler)
Updates a prepared statement.
updatePreparedStatementRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateWorkGroupResult> updateWorkGroupAsync(UpdateWorkGroupRequest updateWorkGroupRequest)
Updates the workgroup with the specified name. The workgroup's name cannot be changed. Only
ConfigurationUpdates can be specified.
updateWorkGroupRequest - Future<UpdateWorkGroupResult> updateWorkGroupAsync(UpdateWorkGroupRequest updateWorkGroupRequest, AsyncHandler<UpdateWorkGroupRequest,UpdateWorkGroupResult> asyncHandler)
Updates the workgroup with the specified name. The workgroup's name cannot be changed. Only
ConfigurationUpdates can be specified.
updateWorkGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.