com.amazonaws.services.athena.AmazonAthena Maven / Gradle / Ivy
Show all versions of aws-java-sdk-athena Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.athena;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.athena.model.*;
/**
* Interface for accessing Amazon Athena.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.athena.AbstractAmazonAthena} instead.
*
*
*
* Amazon Athena is an interactive query service that lets you use standard SQL to analyze data directly in Amazon S3.
* You can point Athena at your data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is
* serverless, so there is no infrastructure to set up or manage. You pay only for the queries you run. Athena scales
* automatically—executing queries in parallel—so results are fast, even with large datasets and complex queries. For
* more information, see What is Amazon Athena in
* the Amazon Athena User Guide.
*
*
* If you connect to Athena using the JDBC driver, use version 1.1.0 of the driver or later with the Amazon Athena API.
* Earlier version drivers do not support the API. For more information and to download the driver, see Accessing Amazon Athena with JDBC.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonAthena {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "athena";
/**
*
* 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.
*
*
* @param batchGetNamedQueryRequest
* Contains an array of named query IDs.
* @return Result of the BatchGetNamedQuery operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.BatchGetNamedQuery
* @see AWS API
* Documentation
*/
BatchGetNamedQueryResult batchGetNamedQuery(BatchGetNamedQueryRequest batchGetNamedQueryRequest);
/**
*
* 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.
*
*
* @param batchGetPreparedStatementRequest
* @return Result of the BatchGetPreparedStatement operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.BatchGetPreparedStatement
* @see AWS API Documentation
*/
BatchGetPreparedStatementResult batchGetPreparedStatement(BatchGetPreparedStatementRequest batchGetPreparedStatementRequest);
/**
*
* 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.
*
*
* @param batchGetQueryExecutionRequest
* Contains an array of query execution IDs.
* @return Result of the BatchGetQueryExecution operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.BatchGetQueryExecution
* @see AWS
* API Documentation
*/
BatchGetQueryExecutionResult batchGetQueryExecution(BatchGetQueryExecutionRequest batchGetQueryExecutionRequest);
/**
*
* 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.
*
*
* @param cancelCapacityReservationRequest
* @return Result of the CancelCapacityReservation operation returned by the service.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @sample AmazonAthena.CancelCapacityReservation
* @see AWS API Documentation
*/
CancelCapacityReservationResult cancelCapacityReservation(CancelCapacityReservationRequest cancelCapacityReservationRequest);
/**
*
* Creates a capacity reservation with the specified name and number of requested data processing units.
*
*
* @param createCapacityReservationRequest
* @return Result of the CreateCapacityReservation operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.CreateCapacityReservation
* @see AWS API Documentation
*/
CreateCapacityReservationResult createCapacityReservation(CreateCapacityReservationRequest createCapacityReservationRequest);
/**
*
* 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.
*
*
* @param createDataCatalogRequest
* @return Result of the CreateDataCatalog operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.CreateDataCatalog
* @see AWS API
* Documentation
*/
CreateDataCatalogResult createDataCatalog(CreateDataCatalogRequest createDataCatalogRequest);
/**
*
* Creates a named query in the specified workgroup. Requires that you have access to the workgroup.
*
*
* @param createNamedQueryRequest
* @return Result of the CreateNamedQuery operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.CreateNamedQuery
* @see AWS API
* Documentation
*/
CreateNamedQueryResult createNamedQuery(CreateNamedQueryRequest createNamedQueryRequest);
/**
*
* 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.
*
*
* @param createNotebookRequest
* @return Result of the CreateNotebook operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws TooManyRequestsException
* Indicates that the request was throttled.
* @sample AmazonAthena.CreateNotebook
* @see AWS API
* Documentation
*/
CreateNotebookResult createNotebook(CreateNotebookRequest createNotebookRequest);
/**
*
* Creates a prepared statement for use with SQL queries in Athena.
*
*
* @param createPreparedStatementRequest
* @return Result of the CreatePreparedStatement operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.CreatePreparedStatement
* @see AWS
* API Documentation
*/
CreatePreparedStatementResult createPreparedStatement(CreatePreparedStatementRequest createPreparedStatementRequest);
/**
*
* 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.
*
*
* @param createPresignedNotebookUrlRequest
* @return Result of the CreatePresignedNotebookUrl operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws ResourceNotFoundException
* A resource, such as a workgroup, was not found.
* @sample AmazonAthena.CreatePresignedNotebookUrl
* @see AWS API Documentation
*/
CreatePresignedNotebookUrlResult createPresignedNotebookUrl(CreatePresignedNotebookUrlRequest createPresignedNotebookUrlRequest);
/**
*
* Creates a workgroup with the specified name. A workgroup can be an Apache Spark enabled workgroup or an Athena
* SQL workgroup.
*
*
* @param createWorkGroupRequest
* @return Result of the CreateWorkGroup operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.CreateWorkGroup
* @see AWS API
* Documentation
*/
CreateWorkGroupResult createWorkGroup(CreateWorkGroupRequest createWorkGroupRequest);
/**
*
* 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.
*
*
* @param deleteCapacityReservationRequest
* @return Result of the DeleteCapacityReservation operation returned by the service.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @sample AmazonAthena.DeleteCapacityReservation
* @see AWS API Documentation
*/
DeleteCapacityReservationResult deleteCapacityReservation(DeleteCapacityReservationRequest deleteCapacityReservationRequest);
/**
*
* Deletes a data catalog.
*
*
* @param deleteDataCatalogRequest
* @return Result of the DeleteDataCatalog operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.DeleteDataCatalog
* @see AWS API
* Documentation
*/
DeleteDataCatalogResult deleteDataCatalog(DeleteDataCatalogRequest deleteDataCatalogRequest);
/**
*
* Deletes the named query if you have access to the workgroup in which the query was saved.
*
*
* @param deleteNamedQueryRequest
* @return Result of the DeleteNamedQuery operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.DeleteNamedQuery
* @see AWS API
* Documentation
*/
DeleteNamedQueryResult deleteNamedQuery(DeleteNamedQueryRequest deleteNamedQueryRequest);
/**
*
* Deletes the specified notebook.
*
*
* @param deleteNotebookRequest
* @return Result of the DeleteNotebook operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws TooManyRequestsException
* Indicates that the request was throttled.
* @sample AmazonAthena.DeleteNotebook
* @see AWS API
* Documentation
*/
DeleteNotebookResult deleteNotebook(DeleteNotebookRequest deleteNotebookRequest);
/**
*
* Deletes the prepared statement with the specified name from the specified workgroup.
*
*
* @param deletePreparedStatementRequest
* @return Result of the DeletePreparedStatement operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws ResourceNotFoundException
* A resource, such as a workgroup, was not found.
* @sample AmazonAthena.DeletePreparedStatement
* @see AWS
* API Documentation
*/
DeletePreparedStatementResult deletePreparedStatement(DeletePreparedStatementRequest deletePreparedStatementRequest);
/**
*
* Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.
*
*
* @param deleteWorkGroupRequest
* @return Result of the DeleteWorkGroup operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.DeleteWorkGroup
* @see AWS API
* Documentation
*/
DeleteWorkGroupResult deleteWorkGroup(DeleteWorkGroupRequest deleteWorkGroupRequest);
/**
*
* Exports the specified notebook and its metadata.
*
*
* @param exportNotebookRequest
* @return Result of the ExportNotebook operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws TooManyRequestsException
* Indicates that the request was throttled.
* @sample AmazonAthena.ExportNotebook
* @see AWS API
* Documentation
*/
ExportNotebookResult exportNotebook(ExportNotebookRequest exportNotebookRequest);
/**
*
* Describes a previously submitted calculation execution.
*
*
* @param getCalculationExecutionRequest
* @return Result of the GetCalculationExecution operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws ResourceNotFoundException
* A resource, such as a workgroup, was not found.
* @sample AmazonAthena.GetCalculationExecution
* @see AWS
* API Documentation
*/
GetCalculationExecutionResult getCalculationExecution(GetCalculationExecutionRequest getCalculationExecutionRequest);
/**
*
* Retrieves the unencrypted code that was executed for the calculation.
*
*
* @param getCalculationExecutionCodeRequest
* @return Result of the GetCalculationExecutionCode operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws ResourceNotFoundException
* A resource, such as a workgroup, was not found.
* @sample AmazonAthena.GetCalculationExecutionCode
* @see AWS API Documentation
*/
GetCalculationExecutionCodeResult getCalculationExecutionCode(GetCalculationExecutionCodeRequest getCalculationExecutionCodeRequest);
/**
*
* Gets the status of a current calculation.
*
*
* @param getCalculationExecutionStatusRequest
* @return Result of the GetCalculationExecutionStatus operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws ResourceNotFoundException
* A resource, such as a workgroup, was not found.
* @sample AmazonAthena.GetCalculationExecutionStatus
* @see AWS API Documentation
*/
GetCalculationExecutionStatusResult getCalculationExecutionStatus(GetCalculationExecutionStatusRequest getCalculationExecutionStatusRequest);
/**
*
* Gets the capacity assignment configuration for a capacity reservation, if one exists.
*
*
* @param getCapacityAssignmentConfigurationRequest
* @return Result of the GetCapacityAssignmentConfiguration operation returned by the service.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @sample AmazonAthena.GetCapacityAssignmentConfiguration
* @see AWS API Documentation
*/
GetCapacityAssignmentConfigurationResult getCapacityAssignmentConfiguration(
GetCapacityAssignmentConfigurationRequest getCapacityAssignmentConfigurationRequest);
/**
*
* Returns information about the capacity reservation with the specified name.
*
*
* @param getCapacityReservationRequest
* @return Result of the GetCapacityReservation operation returned by the service.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @sample AmazonAthena.GetCapacityReservation
* @see AWS
* API Documentation
*/
GetCapacityReservationResult getCapacityReservation(GetCapacityReservationRequest getCapacityReservationRequest);
/**
*
* Returns the specified data catalog.
*
*
* @param getDataCatalogRequest
* @return Result of the GetDataCatalog operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.GetDataCatalog
* @see AWS API
* Documentation
*/
GetDataCatalogResult getDataCatalog(GetDataCatalogRequest getDataCatalogRequest);
/**
*
* Returns a database object for the specified database and data catalog.
*
*
* @param getDatabaseRequest
* @return Result of the GetDatabase operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws MetadataException
* An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by
* user input (InvalidRequestException) or from the Athena platform (
* InternalServerException). For example, if a user-created Lambda function is missing
* permissions, the Lambda 4XX exception is returned in a MetadataException.
* @sample AmazonAthena.GetDatabase
* @see AWS API
* Documentation
*/
GetDatabaseResult getDatabase(GetDatabaseRequest getDatabaseRequest);
/**
*
* Returns information about a single query. Requires that you have access to the workgroup in which the query was
* saved.
*
*
* @param getNamedQueryRequest
* @return Result of the GetNamedQuery operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.GetNamedQuery
* @see AWS API
* Documentation
*/
GetNamedQueryResult getNamedQuery(GetNamedQueryRequest getNamedQueryRequest);
/**
*
* Retrieves notebook metadata for the specified notebook ID.
*
*
* @param getNotebookMetadataRequest
* @return Result of the GetNotebookMetadata operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws TooManyRequestsException
* Indicates that the request was throttled.
* @sample AmazonAthena.GetNotebookMetadata
* @see AWS API
* Documentation
*/
GetNotebookMetadataResult getNotebookMetadata(GetNotebookMetadataRequest getNotebookMetadataRequest);
/**
*
* Retrieves the prepared statement with the specified name from the specified workgroup.
*
*
* @param getPreparedStatementRequest
* @return Result of the GetPreparedStatement operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws ResourceNotFoundException
* A resource, such as a workgroup, was not found.
* @sample AmazonAthena.GetPreparedStatement
* @see AWS
* API Documentation
*/
GetPreparedStatementResult getPreparedStatement(GetPreparedStatementRequest getPreparedStatementRequest);
/**
*
* 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.
*
*
* @param getQueryExecutionRequest
* @return Result of the GetQueryExecution operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.GetQueryExecution
* @see AWS API
* Documentation
*/
GetQueryExecutionResult getQueryExecution(GetQueryExecutionRequest getQueryExecutionRequest);
/**
*
* 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.
*
*
*
* @param getQueryResultsRequest
* @return Result of the GetQueryResults operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws TooManyRequestsException
* Indicates that the request was throttled.
* @sample AmazonAthena.GetQueryResults
* @see AWS API
* Documentation
*/
GetQueryResultsResult getQueryResults(GetQueryResultsRequest getQueryResultsRequest);
/**
*
* 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.
*
*
* @param getQueryRuntimeStatisticsRequest
* @return Result of the GetQueryRuntimeStatistics operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.GetQueryRuntimeStatistics
* @see AWS API Documentation
*/
GetQueryRuntimeStatisticsResult getQueryRuntimeStatistics(GetQueryRuntimeStatisticsRequest getQueryRuntimeStatisticsRequest);
/**
*
* Gets the full details of a previously created session, including the session status and configuration.
*
*
* @param getSessionRequest
* @return Result of the GetSession operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws ResourceNotFoundException
* A resource, such as a workgroup, was not found.
* @sample AmazonAthena.GetSession
* @see AWS API
* Documentation
*/
GetSessionResult getSession(GetSessionRequest getSessionRequest);
/**
*
* Gets the current status of a session.
*
*
* @param getSessionStatusRequest
* @return Result of the GetSessionStatus operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws ResourceNotFoundException
* A resource, such as a workgroup, was not found.
* @sample AmazonAthena.GetSessionStatus
* @see AWS API
* Documentation
*/
GetSessionStatusResult getSessionStatus(GetSessionStatusRequest getSessionStatusRequest);
/**
*
* Returns table metadata for the specified catalog, database, and table.
*
*
* @param getTableMetadataRequest
* @return Result of the GetTableMetadata operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws MetadataException
* An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by
* user input (InvalidRequestException) or from the Athena platform (
* InternalServerException). For example, if a user-created Lambda function is missing
* permissions, the Lambda 4XX exception is returned in a MetadataException.
* @sample AmazonAthena.GetTableMetadata
* @see AWS API
* Documentation
*/
GetTableMetadataResult getTableMetadata(GetTableMetadataRequest getTableMetadataRequest);
/**
*
* Returns information about the workgroup with the specified name.
*
*
* @param getWorkGroupRequest
* @return Result of the GetWorkGroup operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.GetWorkGroup
* @see AWS API
* Documentation
*/
GetWorkGroupResult getWorkGroup(GetWorkGroupRequest getWorkGroupRequest);
/**
*
* 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.
*
*
* @param importNotebookRequest
* @return Result of the ImportNotebook operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws TooManyRequestsException
* Indicates that the request was throttled.
* @sample AmazonAthena.ImportNotebook
* @see AWS API
* Documentation
*/
ImportNotebookResult importNotebook(ImportNotebookRequest importNotebookRequest);
/**
*
* Returns the supported DPU sizes for the supported application runtimes (for example,
* Athena notebook version 1).
*
*
* @param listApplicationDPUSizesRequest
* @return Result of the ListApplicationDPUSizes operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws TooManyRequestsException
* Indicates that the request was throttled.
* @sample AmazonAthena.ListApplicationDPUSizes
* @see AWS
* API Documentation
*/
ListApplicationDPUSizesResult listApplicationDPUSizes(ListApplicationDPUSizesRequest listApplicationDPUSizesRequest);
/**
*
* Lists the calculations that have been submitted to a session in descending order. Newer calculations are listed
* first; older calculations are listed later.
*
*
* @param listCalculationExecutionsRequest
* @return Result of the ListCalculationExecutions operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws ResourceNotFoundException
* A resource, such as a workgroup, was not found.
* @sample AmazonAthena.ListCalculationExecutions
* @see AWS API Documentation
*/
ListCalculationExecutionsResult listCalculationExecutions(ListCalculationExecutionsRequest listCalculationExecutionsRequest);
/**
*
* Lists the capacity reservations for the current account.
*
*
* @param listCapacityReservationsRequest
* @return Result of the ListCapacityReservations operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.ListCapacityReservations
* @see AWS API Documentation
*/
ListCapacityReservationsResult listCapacityReservations(ListCapacityReservationsRequest listCapacityReservationsRequest);
/**
*
* 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.
*
*
*
* @param listDataCatalogsRequest
* @return Result of the ListDataCatalogs operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.ListDataCatalogs
* @see AWS API
* Documentation
*/
ListDataCatalogsResult listDataCatalogs(ListDataCatalogsRequest listDataCatalogsRequest);
/**
*
* Lists the databases in the specified data catalog.
*
*
* @param listDatabasesRequest
* @return Result of the ListDatabases operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws MetadataException
* An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by
* user input (InvalidRequestException) or from the Athena platform (
* InternalServerException). For example, if a user-created Lambda function is missing
* permissions, the Lambda 4XX exception is returned in a MetadataException.
* @sample AmazonAthena.ListDatabases
* @see AWS API
* Documentation
*/
ListDatabasesResult listDatabases(ListDatabasesRequest listDatabasesRequest);
/**
*
* Returns a list of engine versions that are available to choose from, including the Auto option.
*
*
* @param listEngineVersionsRequest
* @return Result of the ListEngineVersions operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.ListEngineVersions
* @see AWS API
* Documentation
*/
ListEngineVersionsResult listEngineVersions(ListEngineVersionsRequest listEngineVersionsRequest);
/**
*
* 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.
*
*
* @param listExecutorsRequest
* @return Result of the ListExecutors operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws ResourceNotFoundException
* A resource, such as a workgroup, was not found.
* @sample AmazonAthena.ListExecutors
* @see AWS API
* Documentation
*/
ListExecutorsResult listExecutors(ListExecutorsRequest listExecutorsRequest);
/**
*
* 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.
*
*
* @param listNamedQueriesRequest
* @return Result of the ListNamedQueries operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.ListNamedQueries
* @see AWS API
* Documentation
*/
ListNamedQueriesResult listNamedQueries(ListNamedQueriesRequest listNamedQueriesRequest);
/**
*
* Displays the notebook files for the specified workgroup in paginated format.
*
*
* @param listNotebookMetadataRequest
* @return Result of the ListNotebookMetadata operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws TooManyRequestsException
* Indicates that the request was throttled.
* @sample AmazonAthena.ListNotebookMetadata
* @see AWS
* API Documentation
*/
ListNotebookMetadataResult listNotebookMetadata(ListNotebookMetadataRequest listNotebookMetadataRequest);
/**
*
* 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.
*
*
* @param listNotebookSessionsRequest
* @return Result of the ListNotebookSessions operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws ResourceNotFoundException
* A resource, such as a workgroup, was not found.
* @sample AmazonAthena.ListNotebookSessions
* @see AWS
* API Documentation
*/
ListNotebookSessionsResult listNotebookSessions(ListNotebookSessionsRequest listNotebookSessionsRequest);
/**
*
* Lists the prepared statements in the specified workgroup.
*
*
* @param listPreparedStatementsRequest
* @return Result of the ListPreparedStatements operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.ListPreparedStatements
* @see AWS
* API Documentation
*/
ListPreparedStatementsResult listPreparedStatements(ListPreparedStatementsRequest listPreparedStatementsRequest);
/**
*
* 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.
*
*
* @param listQueryExecutionsRequest
* @return Result of the ListQueryExecutions operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.ListQueryExecutions
* @see AWS API
* Documentation
*/
ListQueryExecutionsResult listQueryExecutions(ListQueryExecutionsRequest listQueryExecutionsRequest);
/**
*
* 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.
*
*
* @param listSessionsRequest
* @return Result of the ListSessions operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws ResourceNotFoundException
* A resource, such as a workgroup, was not found.
* @sample AmazonAthena.ListSessions
* @see AWS API
* Documentation
*/
ListSessionsResult listSessions(ListSessionsRequest listSessionsRequest);
/**
*
* Lists the metadata for the tables in the specified data catalog database.
*
*
* @param listTableMetadataRequest
* @return Result of the ListTableMetadata operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws MetadataException
* An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by
* user input (InvalidRequestException) or from the Athena platform (
* InternalServerException). For example, if a user-created Lambda function is missing
* permissions, the Lambda 4XX exception is returned in a MetadataException.
* @sample AmazonAthena.ListTableMetadata
* @see AWS API
* Documentation
*/
ListTableMetadataResult listTableMetadata(ListTableMetadataRequest listTableMetadataRequest);
/**
*
* Lists the tags associated with an Athena resource.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws ResourceNotFoundException
* A resource, such as a workgroup, was not found.
* @sample AmazonAthena.ListTagsForResource
* @see AWS API
* Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Lists available workgroups for the account.
*
*
* @param listWorkGroupsRequest
* @return Result of the ListWorkGroups operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.ListWorkGroups
* @see AWS API
* Documentation
*/
ListWorkGroupsResult listWorkGroups(ListWorkGroupsRequest listWorkGroupsRequest);
/**
*
* 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.
*
*
* @param putCapacityAssignmentConfigurationRequest
* @return Result of the PutCapacityAssignmentConfiguration operation returned by the service.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @sample AmazonAthena.PutCapacityAssignmentConfiguration
* @see AWS API Documentation
*/
PutCapacityAssignmentConfigurationResult putCapacityAssignmentConfiguration(
PutCapacityAssignmentConfigurationRequest putCapacityAssignmentConfigurationRequest);
/**
*
* 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.
*
*
*
* @param startCalculationExecutionRequest
* @return Result of the StartCalculationExecution operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws ResourceNotFoundException
* A resource, such as a workgroup, was not found.
* @sample AmazonAthena.StartCalculationExecution
* @see AWS API Documentation
*/
StartCalculationExecutionResult startCalculationExecution(StartCalculationExecutionRequest startCalculationExecutionRequest);
/**
*
* 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.
*
*
* @param startQueryExecutionRequest
* @return Result of the StartQueryExecution operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws TooManyRequestsException
* Indicates that the request was throttled.
* @sample AmazonAthena.StartQueryExecution
* @see AWS API
* Documentation
*/
StartQueryExecutionResult startQueryExecution(StartQueryExecutionRequest startQueryExecutionRequest);
/**
*
* Creates a session for running calculations within a workgroup. The session is ready when it reaches an
* IDLE state.
*
*
* @param startSessionRequest
* @return Result of the StartSession operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws ResourceNotFoundException
* A resource, such as a workgroup, was not found.
* @throws SessionAlreadyExistsException
* The specified session already exists.
* @throws TooManyRequestsException
* Indicates that the request was throttled.
* @sample AmazonAthena.StartSession
* @see AWS API
* Documentation
*/
StartSessionResult startSession(StartSessionRequest startSessionRequest);
/**
*
* 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.
*
*
*
* @param stopCalculationExecutionRequest
* @return Result of the StopCalculationExecution operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws ResourceNotFoundException
* A resource, such as a workgroup, was not found.
* @sample AmazonAthena.StopCalculationExecution
* @see AWS API Documentation
*/
StopCalculationExecutionResult stopCalculationExecution(StopCalculationExecutionRequest stopCalculationExecutionRequest);
/**
*
* Stops a query execution. Requires you to have access to the workgroup in which the query ran.
*
*
* @param stopQueryExecutionRequest
* @return Result of the StopQueryExecution operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.StopQueryExecution
* @see AWS API
* Documentation
*/
StopQueryExecutionResult stopQueryExecution(StopQueryExecutionRequest stopQueryExecutionRequest);
/**
*
* 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.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws ResourceNotFoundException
* A resource, such as a workgroup, was not found.
* @sample AmazonAthena.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* 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.
*
*
* @param terminateSessionRequest
* @return Result of the TerminateSession operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws ResourceNotFoundException
* A resource, such as a workgroup, was not found.
* @sample AmazonAthena.TerminateSession
* @see AWS API
* Documentation
*/
TerminateSessionResult terminateSession(TerminateSessionRequest terminateSessionRequest);
/**
*
* Removes one or more tags from an Athena resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws ResourceNotFoundException
* A resource, such as a workgroup, was not found.
* @sample AmazonAthena.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Updates the number of requested data processing units for the capacity reservation with the specified name.
*
*
* @param updateCapacityReservationRequest
* @return Result of the UpdateCapacityReservation operation returned by the service.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @sample AmazonAthena.UpdateCapacityReservation
* @see AWS API Documentation
*/
UpdateCapacityReservationResult updateCapacityReservation(UpdateCapacityReservationRequest updateCapacityReservationRequest);
/**
*
* Updates the data catalog that has the specified name.
*
*
* @param updateDataCatalogRequest
* @return Result of the UpdateDataCatalog operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.UpdateDataCatalog
* @see AWS API
* Documentation
*/
UpdateDataCatalogResult updateDataCatalog(UpdateDataCatalogRequest updateDataCatalogRequest);
/**
*
* Updates a NamedQuery object. The database or workgroup cannot be updated.
*
*
* @param updateNamedQueryRequest
* @return Result of the UpdateNamedQuery operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.UpdateNamedQuery
* @see AWS API
* Documentation
*/
UpdateNamedQueryResult updateNamedQuery(UpdateNamedQueryRequest updateNamedQueryRequest);
/**
*
* Updates the contents of a Spark notebook.
*
*
* @param updateNotebookRequest
* @return Result of the UpdateNotebook operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws TooManyRequestsException
* Indicates that the request was throttled.
* @sample AmazonAthena.UpdateNotebook
* @see AWS API
* Documentation
*/
UpdateNotebookResult updateNotebook(UpdateNotebookRequest updateNotebookRequest);
/**
*
* Updates the metadata for a notebook.
*
*
* @param updateNotebookMetadataRequest
* @return Result of the UpdateNotebookMetadata operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws TooManyRequestsException
* Indicates that the request was throttled.
* @sample AmazonAthena.UpdateNotebookMetadata
* @see AWS
* API Documentation
*/
UpdateNotebookMetadataResult updateNotebookMetadata(UpdateNotebookMetadataRequest updateNotebookMetadataRequest);
/**
*
* Updates a prepared statement.
*
*
* @param updatePreparedStatementRequest
* @return Result of the UpdatePreparedStatement operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @throws ResourceNotFoundException
* A resource, such as a workgroup, was not found.
* @sample AmazonAthena.UpdatePreparedStatement
* @see AWS
* API Documentation
*/
UpdatePreparedStatementResult updatePreparedStatement(UpdatePreparedStatementRequest updatePreparedStatementRequest);
/**
*
* Updates the workgroup with the specified name. The workgroup's name cannot be changed. Only
* ConfigurationUpdates can be specified.
*
*
* @param updateWorkGroupRequest
* @return Result of the UpdateWorkGroup operation returned by the service.
* @throws InternalServerException
* Indicates a platform issue, which may be due to a transient condition or outage.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a required parameter may be
* missing or out of range.
* @sample AmazonAthena.UpdateWorkGroup
* @see AWS API
* Documentation
*/
UpdateWorkGroupResult updateWorkGroup(UpdateWorkGroupRequest updateWorkGroupRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}