@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonAthena
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonAthena instead.
Amazon Athena is an interactive query service that lets you use standard SQL to analyze data directly in Amazon S3. You can point Athena at your data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so there is no infrastructure to set up or manage. You pay only for the queries you run. Athena scales automatically—executing queries in parallel—so results are fast, even with large datasets and complex queries. For more information, see What is Amazon Athena in the Amazon Athena User Guide.
If you connect to Athena using the JDBC driver, use version 1.1.0 of the driver or later with the Amazon Athena API. Earlier version drivers do not support the API. For more information and to download the driver, see Accessing Amazon Athena with JDBC.
For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
BatchGetNamedQueryResult |
batchGetNamedQuery(BatchGetNamedQueryRequest batchGetNamedQueryRequest)
Returns the details of a single named query or a list of up to 50 queries, which you provide as an array of query
ID strings.
|
BatchGetPreparedStatementResult |
batchGetPreparedStatement(BatchGetPreparedStatementRequest batchGetPreparedStatementRequest)
Returns the details of a single prepared statement or a list of up to 256 prepared statements for the array of
prepared statement names that you provide.
|
BatchGetQueryExecutionResult |
batchGetQueryExecution(BatchGetQueryExecutionRequest batchGetQueryExecutionRequest)
Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an
array of query execution ID strings.
|
CancelCapacityReservationResult |
cancelCapacityReservation(CancelCapacityReservationRequest cancelCapacityReservationRequest)
Cancels the capacity reservation with the specified name.
|
CreateCapacityReservationResult |
createCapacityReservation(CreateCapacityReservationRequest createCapacityReservationRequest)
Creates a capacity reservation with the specified name and number of requested data processing units.
|
CreateDataCatalogResult |
createDataCatalog(CreateDataCatalogRequest createDataCatalogRequest)
Creates (registers) a data catalog with the specified name and properties.
|
CreateNamedQueryResult |
createNamedQuery(CreateNamedQueryRequest createNamedQueryRequest)
Creates a named query in the specified workgroup.
|
CreateNotebookResult |
createNotebook(CreateNotebookRequest createNotebookRequest)
Creates an empty
ipynb file in the specified Apache Spark enabled workgroup. |
CreatePreparedStatementResult |
createPreparedStatement(CreatePreparedStatementRequest createPreparedStatementRequest)
Creates a prepared statement for use with SQL queries in Athena.
|
CreatePresignedNotebookUrlResult |
createPresignedNotebookUrl(CreatePresignedNotebookUrlRequest createPresignedNotebookUrlRequest)
Gets an authentication token and the URL at which the notebook can be accessed.
|
CreateWorkGroupResult |
createWorkGroup(CreateWorkGroupRequest createWorkGroupRequest)
Creates a workgroup with the specified name.
|
DeleteCapacityReservationResult |
deleteCapacityReservation(DeleteCapacityReservationRequest deleteCapacityReservationRequest)
Deletes a cancelled capacity reservation.
|
DeleteDataCatalogResult |
deleteDataCatalog(DeleteDataCatalogRequest deleteDataCatalogRequest)
Deletes a data catalog.
|
DeleteNamedQueryResult |
deleteNamedQuery(DeleteNamedQueryRequest deleteNamedQueryRequest)
Deletes the named query if you have access to the workgroup in which the query was saved.
|
DeleteNotebookResult |
deleteNotebook(DeleteNotebookRequest deleteNotebookRequest)
Deletes the specified notebook.
|
DeletePreparedStatementResult |
deletePreparedStatement(DeletePreparedStatementRequest deletePreparedStatementRequest)
Deletes the prepared statement with the specified name from the specified workgroup.
|
DeleteWorkGroupResult |
deleteWorkGroup(DeleteWorkGroupRequest deleteWorkGroupRequest)
Deletes the workgroup with the specified name.
|
ExportNotebookResult |
exportNotebook(ExportNotebookRequest exportNotebookRequest)
Exports the specified notebook and its metadata.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetCalculationExecutionResult |
getCalculationExecution(GetCalculationExecutionRequest getCalculationExecutionRequest)
Describes a previously submitted calculation execution.
|
GetCalculationExecutionCodeResult |
getCalculationExecutionCode(GetCalculationExecutionCodeRequest getCalculationExecutionCodeRequest)
Retrieves the unencrypted code that was executed for the calculation.
|
GetCalculationExecutionStatusResult |
getCalculationExecutionStatus(GetCalculationExecutionStatusRequest getCalculationExecutionStatusRequest)
Gets the status of a current calculation.
|
GetCapacityAssignmentConfigurationResult |
getCapacityAssignmentConfiguration(GetCapacityAssignmentConfigurationRequest getCapacityAssignmentConfigurationRequest)
Gets the capacity assignment configuration for a capacity reservation, if one exists.
|
GetCapacityReservationResult |
getCapacityReservation(GetCapacityReservationRequest getCapacityReservationRequest)
Returns information about the capacity reservation with the specified name.
|
GetDatabaseResult |
getDatabase(GetDatabaseRequest getDatabaseRequest)
Returns a database object for the specified database and data catalog.
|
GetDataCatalogResult |
getDataCatalog(GetDataCatalogRequest getDataCatalogRequest)
Returns the specified data catalog.
|
GetNamedQueryResult |
getNamedQuery(GetNamedQueryRequest getNamedQueryRequest)
Returns information about a single query.
|
GetNotebookMetadataResult |
getNotebookMetadata(GetNotebookMetadataRequest getNotebookMetadataRequest)
Retrieves notebook metadata for the specified notebook ID.
|
GetPreparedStatementResult |
getPreparedStatement(GetPreparedStatementRequest getPreparedStatementRequest)
Retrieves the prepared statement with the specified name from the specified workgroup.
|
GetQueryExecutionResult |
getQueryExecution(GetQueryExecutionRequest getQueryExecutionRequest)
Returns information about a single execution of a query if you have access to the workgroup in which the query
ran.
|
GetQueryResultsResult |
getQueryResults(GetQueryResultsRequest getQueryResultsRequest)
Streams the results of a single query execution specified by
QueryExecutionId from the Athena query
results location in Amazon S3. |
GetQueryRuntimeStatisticsResult |
getQueryRuntimeStatistics(GetQueryRuntimeStatisticsRequest getQueryRuntimeStatisticsRequest)
Returns query execution runtime statistics related to a single execution of a query if you have access to the
workgroup in which the query ran.
|
GetSessionResult |
getSession(GetSessionRequest getSessionRequest)
Gets the full details of a previously created session, including the session status and configuration.
|
GetSessionStatusResult |
getSessionStatus(GetSessionStatusRequest getSessionStatusRequest)
Gets the current status of a session.
|
GetTableMetadataResult |
getTableMetadata(GetTableMetadataRequest getTableMetadataRequest)
Returns table metadata for the specified catalog, database, and table.
|
GetWorkGroupResult |
getWorkGroup(GetWorkGroupRequest getWorkGroupRequest)
Returns information about the workgroup with the specified name.
|
ImportNotebookResult |
importNotebook(ImportNotebookRequest importNotebookRequest)
Imports a single
ipynb file to a Spark enabled workgroup. |
ListApplicationDPUSizesResult |
listApplicationDPUSizes(ListApplicationDPUSizesRequest listApplicationDPUSizesRequest)
Returns the supported DPU sizes for the supported application runtimes (for example,
Athena notebook version 1). |
ListCalculationExecutionsResult |
listCalculationExecutions(ListCalculationExecutionsRequest listCalculationExecutionsRequest)
Lists the calculations that have been submitted to a session in descending order.
|
ListCapacityReservationsResult |
listCapacityReservations(ListCapacityReservationsRequest listCapacityReservationsRequest)
Lists the capacity reservations for the current account.
|
ListDatabasesResult |
listDatabases(ListDatabasesRequest listDatabasesRequest)
Lists the databases in the specified data catalog.
|
ListDataCatalogsResult |
listDataCatalogs(ListDataCatalogsRequest listDataCatalogsRequest)
Lists the data catalogs in the current Amazon Web Services account.
|
ListEngineVersionsResult |
listEngineVersions(ListEngineVersionsRequest listEngineVersionsRequest)
Returns a list of engine versions that are available to choose from, including the Auto option.
|
ListExecutorsResult |
listExecutors(ListExecutorsRequest listExecutorsRequest)
Lists, in descending order, the executors that joined a session.
|
ListNamedQueriesResult |
listNamedQueries(ListNamedQueriesRequest listNamedQueriesRequest)
Provides a list of available query IDs only for queries saved in the specified workgroup.
|
ListNotebookMetadataResult |
listNotebookMetadata(ListNotebookMetadataRequest listNotebookMetadataRequest)
Displays the notebook files for the specified workgroup in paginated format.
|
ListNotebookSessionsResult |
listNotebookSessions(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. |
ListPreparedStatementsResult |
listPreparedStatements(ListPreparedStatementsRequest listPreparedStatementsRequest)
Lists the prepared statements in the specified workgroup.
|
ListQueryExecutionsResult |
listQueryExecutions(ListQueryExecutionsRequest listQueryExecutionsRequest)
Provides a list of available query execution IDs for the queries in the specified workgroup.
|
ListSessionsResult |
listSessions(ListSessionsRequest listSessionsRequest)
Lists the sessions in a workgroup that are in an active state like
CREATING, CREATED,
IDLE, or BUSY. |
ListTableMetadataResult |
listTableMetadata(ListTableMetadataRequest listTableMetadataRequest)
Lists the metadata for the tables in the specified data catalog database.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags associated with an Athena resource.
|
ListWorkGroupsResult |
listWorkGroups(ListWorkGroupsRequest listWorkGroupsRequest)
Lists available workgroups for the account.
|
PutCapacityAssignmentConfigurationResult |
putCapacityAssignmentConfiguration(PutCapacityAssignmentConfigurationRequest putCapacityAssignmentConfigurationRequest)
Puts a new capacity assignment configuration for a specified capacity reservation.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartCalculationExecutionResult |
startCalculationExecution(StartCalculationExecutionRequest startCalculationExecutionRequest)
Submits calculations for execution within a session.
|
StartQueryExecutionResult |
startQueryExecution(StartQueryExecutionRequest startQueryExecutionRequest)
Runs the SQL query statements contained in the
Query. |
StartSessionResult |
startSession(StartSessionRequest startSessionRequest)
Creates a session for running calculations within a workgroup.
|
StopCalculationExecutionResult |
stopCalculationExecution(StopCalculationExecutionRequest stopCalculationExecutionRequest)
Requests the cancellation of a calculation.
|
StopQueryExecutionResult |
stopQueryExecution(StopQueryExecutionRequest stopQueryExecutionRequest)
Stops a query execution.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Adds one or more tags to an Athena resource.
|
TerminateSessionResult |
terminateSession(TerminateSessionRequest terminateSessionRequest)
Terminates an active session.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from an Athena resource.
|
UpdateCapacityReservationResult |
updateCapacityReservation(UpdateCapacityReservationRequest updateCapacityReservationRequest)
Updates the number of requested data processing units for the capacity reservation with the specified name.
|
UpdateDataCatalogResult |
updateDataCatalog(UpdateDataCatalogRequest updateDataCatalogRequest)
Updates the data catalog that has the specified name.
|
UpdateNamedQueryResult |
updateNamedQuery(UpdateNamedQueryRequest updateNamedQueryRequest)
Updates a NamedQuery object.
|
UpdateNotebookResult |
updateNotebook(UpdateNotebookRequest updateNotebookRequest)
Updates the contents of a Spark notebook.
|
UpdateNotebookMetadataResult |
updateNotebookMetadata(UpdateNotebookMetadataRequest updateNotebookMetadataRequest)
Updates the metadata for a notebook.
|
UpdatePreparedStatementResult |
updatePreparedStatement(UpdatePreparedStatementRequest updatePreparedStatementRequest)
Updates a prepared statement.
|
UpdateWorkGroupResult |
updateWorkGroup(UpdateWorkGroupRequest updateWorkGroupRequest)
Updates the workgroup with the specified name.
|
static final String ENDPOINT_PREFIX
BatchGetNamedQueryResult batchGetNamedQuery(BatchGetNamedQueryRequest batchGetNamedQueryRequest)
Returns the details of a single named query or a list of up to 50 queries, which you provide as an array of query ID strings. Requires you to have access to the workgroup in which the queries were saved. Use ListNamedQueriesInput to get the list of named query IDs in the specified workgroup. If information could not be retrieved for a submitted query ID, information about the query ID submitted is listed under UnprocessedNamedQueryId. Named queries differ from executed queries. Use BatchGetQueryExecutionInput to get details about each unique query execution, and ListQueryExecutionsInput to get a list of query execution IDs.
batchGetNamedQueryRequest - Contains an array of named query IDs.InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.BatchGetPreparedStatementResult batchGetPreparedStatement(BatchGetPreparedStatementRequest batchGetPreparedStatementRequest)
Returns the details of a single prepared statement or a list of up to 256 prepared statements for the array of
prepared statement names that you provide. Requires you to have access to the workgroup to which the prepared
statements belong. If a prepared statement cannot be retrieved for the name specified, the statement is listed in
UnprocessedPreparedStatementNames.
batchGetPreparedStatementRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.BatchGetQueryExecutionResult batchGetQueryExecution(BatchGetQueryExecutionRequest batchGetQueryExecutionRequest)
Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings. Requires you to have access to the workgroup in which the queries ran. To get a list of query execution IDs, use ListQueryExecutionsInput$WorkGroup. Query executions differ from named (saved) queries. Use BatchGetNamedQueryInput to get details about named queries.
batchGetQueryExecutionRequest - Contains an array of query execution IDs.InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.CancelCapacityReservationResult cancelCapacityReservation(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 - InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.CreateCapacityReservationResult createCapacityReservation(CreateCapacityReservationRequest createCapacityReservationRequest)
Creates a capacity reservation with the specified name and number of requested data processing units.
createCapacityReservationRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.CreateDataCatalogResult createDataCatalog(CreateDataCatalogRequest createDataCatalogRequest)
Creates (registers) a data catalog with the specified name and properties. Catalogs created are visible to all users of the same Amazon Web Services account.
createDataCatalogRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.CreateNamedQueryResult createNamedQuery(CreateNamedQueryRequest createNamedQueryRequest)
Creates a named query in the specified workgroup. Requires that you have access to the workgroup.
For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
createNamedQueryRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.CreateNotebookResult createNotebook(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 - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.TooManyRequestsException - Indicates that the request was throttled.CreatePreparedStatementResult createPreparedStatement(CreatePreparedStatementRequest createPreparedStatementRequest)
Creates a prepared statement for use with SQL queries in Athena.
createPreparedStatementRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.CreatePresignedNotebookUrlResult createPresignedNotebookUrl(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 - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ResourceNotFoundException - A resource, such as a workgroup, was not found.CreateWorkGroupResult createWorkGroup(CreateWorkGroupRequest createWorkGroupRequest)
Creates a workgroup with the specified name. A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup.
createWorkGroupRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.DeleteCapacityReservationResult deleteCapacityReservation(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 - InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.DeleteDataCatalogResult deleteDataCatalog(DeleteDataCatalogRequest deleteDataCatalogRequest)
Deletes a data catalog.
deleteDataCatalogRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.DeleteNamedQueryResult deleteNamedQuery(DeleteNamedQueryRequest deleteNamedQueryRequest)
Deletes the named query if you have access to the workgroup in which the query was saved.
For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
deleteNamedQueryRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.DeleteNotebookResult deleteNotebook(DeleteNotebookRequest deleteNotebookRequest)
Deletes the specified notebook.
deleteNotebookRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.TooManyRequestsException - Indicates that the request was throttled.DeletePreparedStatementResult deletePreparedStatement(DeletePreparedStatementRequest deletePreparedStatementRequest)
Deletes the prepared statement with the specified name from the specified workgroup.
deletePreparedStatementRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ResourceNotFoundException - A resource, such as a workgroup, was not found.DeleteWorkGroupResult deleteWorkGroup(DeleteWorkGroupRequest deleteWorkGroupRequest)
Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.
deleteWorkGroupRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ExportNotebookResult exportNotebook(ExportNotebookRequest exportNotebookRequest)
Exports the specified notebook and its metadata.
exportNotebookRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.TooManyRequestsException - Indicates that the request was throttled.GetCalculationExecutionResult getCalculationExecution(GetCalculationExecutionRequest getCalculationExecutionRequest)
Describes a previously submitted calculation execution.
getCalculationExecutionRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ResourceNotFoundException - A resource, such as a workgroup, was not found.GetCalculationExecutionCodeResult getCalculationExecutionCode(GetCalculationExecutionCodeRequest getCalculationExecutionCodeRequest)
Retrieves the unencrypted code that was executed for the calculation.
getCalculationExecutionCodeRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ResourceNotFoundException - A resource, such as a workgroup, was not found.GetCalculationExecutionStatusResult getCalculationExecutionStatus(GetCalculationExecutionStatusRequest getCalculationExecutionStatusRequest)
Gets the status of a current calculation.
getCalculationExecutionStatusRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ResourceNotFoundException - A resource, such as a workgroup, was not found.GetCapacityAssignmentConfigurationResult getCapacityAssignmentConfiguration(GetCapacityAssignmentConfigurationRequest getCapacityAssignmentConfigurationRequest)
Gets the capacity assignment configuration for a capacity reservation, if one exists.
getCapacityAssignmentConfigurationRequest - InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.GetCapacityReservationResult getCapacityReservation(GetCapacityReservationRequest getCapacityReservationRequest)
Returns information about the capacity reservation with the specified name.
getCapacityReservationRequest - InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.GetDataCatalogResult getDataCatalog(GetDataCatalogRequest getDataCatalogRequest)
Returns the specified data catalog.
getDataCatalogRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.GetDatabaseResult getDatabase(GetDatabaseRequest getDatabaseRequest)
Returns a database object for the specified database and data catalog.
getDatabaseRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.MetadataException - An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by
user input (InvalidRequestException) or from the Athena platform (
InternalServerException). For example, if a user-created Lambda function is missing
permissions, the Lambda 4XX exception is returned in a MetadataException.GetNamedQueryResult getNamedQuery(GetNamedQueryRequest getNamedQueryRequest)
Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.
getNamedQueryRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.GetNotebookMetadataResult getNotebookMetadata(GetNotebookMetadataRequest getNotebookMetadataRequest)
Retrieves notebook metadata for the specified notebook ID.
getNotebookMetadataRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.TooManyRequestsException - Indicates that the request was throttled.GetPreparedStatementResult getPreparedStatement(GetPreparedStatementRequest getPreparedStatementRequest)
Retrieves the prepared statement with the specified name from the specified workgroup.
getPreparedStatementRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ResourceNotFoundException - A resource, such as a workgroup, was not found.GetQueryExecutionResult getQueryExecution(GetQueryExecutionRequest getQueryExecutionRequest)
Returns information about a single execution of a query if you have access to the workgroup in which the query ran. Each time a query executes, information about the query execution is saved with a unique ID.
getQueryExecutionRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.GetQueryResultsResult getQueryResults(GetQueryResultsRequest getQueryResultsRequest)
Streams the results of a single query execution specified by QueryExecutionId from the Athena query
results location in Amazon S3. For more information, see 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 - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.TooManyRequestsException - Indicates that the request was throttled.GetQueryRuntimeStatisticsResult getQueryRuntimeStatistics(GetQueryRuntimeStatisticsRequest getQueryRuntimeStatisticsRequest)
Returns query execution runtime statistics related to a single execution of a query if you have access to the workgroup in which the query ran. Query execution runtime statistics are returned only when QueryExecutionStatus$State is in a SUCCEEDED or FAILED state. Stage-level input and output row count and data size statistics are not shown when a query has row-level filters defined in Lake Formation.
getQueryRuntimeStatisticsRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.GetSessionResult getSession(GetSessionRequest getSessionRequest)
Gets the full details of a previously created session, including the session status and configuration.
getSessionRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ResourceNotFoundException - A resource, such as a workgroup, was not found.GetSessionStatusResult getSessionStatus(GetSessionStatusRequest getSessionStatusRequest)
Gets the current status of a session.
getSessionStatusRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ResourceNotFoundException - A resource, such as a workgroup, was not found.GetTableMetadataResult getTableMetadata(GetTableMetadataRequest getTableMetadataRequest)
Returns table metadata for the specified catalog, database, and table.
getTableMetadataRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.MetadataException - An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by
user input (InvalidRequestException) or from the Athena platform (
InternalServerException). For example, if a user-created Lambda function is missing
permissions, the Lambda 4XX exception is returned in a MetadataException.GetWorkGroupResult getWorkGroup(GetWorkGroupRequest getWorkGroupRequest)
Returns information about the workgroup with the specified name.
getWorkGroupRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ImportNotebookResult importNotebook(ImportNotebookRequest importNotebookRequest)
Imports a single ipynb file to a Spark enabled workgroup. 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 - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.TooManyRequestsException - Indicates that the request was throttled.ListApplicationDPUSizesResult listApplicationDPUSizes(ListApplicationDPUSizesRequest listApplicationDPUSizesRequest)
Returns the supported DPU sizes for the supported application runtimes (for example,
Athena notebook version 1).
listApplicationDPUSizesRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.TooManyRequestsException - Indicates that the request was throttled.ListCalculationExecutionsResult listCalculationExecutions(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 - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ResourceNotFoundException - A resource, such as a workgroup, was not found.ListCapacityReservationsResult listCapacityReservations(ListCapacityReservationsRequest listCapacityReservationsRequest)
Lists the capacity reservations for the current account.
listCapacityReservationsRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ListDataCatalogsResult listDataCatalogs(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 - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ListDatabasesResult listDatabases(ListDatabasesRequest listDatabasesRequest)
Lists the databases in the specified data catalog.
listDatabasesRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.MetadataException - An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by
user input (InvalidRequestException) or from the Athena platform (
InternalServerException). For example, if a user-created Lambda function is missing
permissions, the Lambda 4XX exception is returned in a MetadataException.ListEngineVersionsResult listEngineVersions(ListEngineVersionsRequest listEngineVersionsRequest)
Returns a list of engine versions that are available to choose from, including the Auto option.
listEngineVersionsRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ListExecutorsResult listExecutors(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 - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ResourceNotFoundException - A resource, such as a workgroup, was not found.ListNamedQueriesResult listNamedQueries(ListNamedQueriesRequest listNamedQueriesRequest)
Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the specified workgroup. If a workgroup is not specified, lists the saved queries for the primary workgroup.
For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
listNamedQueriesRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ListNotebookMetadataResult listNotebookMetadata(ListNotebookMetadataRequest listNotebookMetadataRequest)
Displays the notebook files for the specified workgroup in paginated format.
listNotebookMetadataRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.TooManyRequestsException - Indicates that the request was throttled.ListNotebookSessionsResult listNotebookSessions(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 - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ResourceNotFoundException - A resource, such as a workgroup, was not found.ListPreparedStatementsResult listPreparedStatements(ListPreparedStatementsRequest listPreparedStatementsRequest)
Lists the prepared statements in the specified workgroup.
listPreparedStatementsRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ListQueryExecutionsResult listQueryExecutions(ListQueryExecutionsRequest listQueryExecutionsRequest)
Provides a list of available query execution IDs for the queries in the specified workgroup. If a workgroup is not specified, returns a list of query execution IDs for the primary workgroup. Requires you to have access to the workgroup in which the queries ran.
For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
listQueryExecutionsRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ListSessionsResult listSessions(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 - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ResourceNotFoundException - A resource, such as a workgroup, was not found.ListTableMetadataResult listTableMetadata(ListTableMetadataRequest listTableMetadataRequest)
Lists the metadata for the tables in the specified data catalog database.
listTableMetadataRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.MetadataException - An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by
user input (InvalidRequestException) or from the Athena platform (
InternalServerException). For example, if a user-created Lambda function is missing
permissions, the Lambda 4XX exception is returned in a MetadataException.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags associated with an Athena resource.
listTagsForResourceRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ResourceNotFoundException - A resource, such as a workgroup, was not found.ListWorkGroupsResult listWorkGroups(ListWorkGroupsRequest listWorkGroupsRequest)
Lists available workgroups for the account.
listWorkGroupsRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.PutCapacityAssignmentConfigurationResult putCapacityAssignmentConfiguration(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 - InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.StartCalculationExecutionResult startCalculationExecution(StartCalculationExecutionRequest startCalculationExecutionRequest)
Submits calculations for execution within a session. You can supply the code to run as an inline code block within the request.
startCalculationExecutionRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ResourceNotFoundException - A resource, such as a workgroup, was not found.StartQueryExecutionResult startQueryExecution(StartQueryExecutionRequest startQueryExecutionRequest)
Runs the SQL query statements contained in the Query. Requires you to have access to the workgroup
in which the query ran. Running queries against an external catalog requires GetDataCatalog permission to
the catalog. For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the
Amazon Athena User Guide.
startQueryExecutionRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.TooManyRequestsException - Indicates that the request was throttled.StartSessionResult startSession(StartSessionRequest startSessionRequest)
Creates a session for running calculations within a workgroup. The session is ready when it reaches an
IDLE state.
startSessionRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ResourceNotFoundException - A resource, such as a workgroup, was not found.SessionAlreadyExistsException - The specified session already exists.TooManyRequestsException - Indicates that the request was throttled.StopCalculationExecutionResult stopCalculationExecution(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 - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ResourceNotFoundException - A resource, such as a workgroup, was not found.StopQueryExecutionResult stopQueryExecution(StopQueryExecutionRequest stopQueryExecutionRequest)
Stops a query execution. Requires you to have access to the workgroup in which the query ran.
For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.
stopQueryExecutionRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.TagResourceResult tagResource(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 - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ResourceNotFoundException - A resource, such as a workgroup, was not found.TerminateSessionResult terminateSession(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 - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ResourceNotFoundException - A resource, such as a workgroup, was not found.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from an Athena resource.
untagResourceRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ResourceNotFoundException - A resource, such as a workgroup, was not found.UpdateCapacityReservationResult updateCapacityReservation(UpdateCapacityReservationRequest updateCapacityReservationRequest)
Updates the number of requested data processing units for the capacity reservation with the specified name.
updateCapacityReservationRequest - InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.UpdateDataCatalogResult updateDataCatalog(UpdateDataCatalogRequest updateDataCatalogRequest)
Updates the data catalog that has the specified name.
updateDataCatalogRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.UpdateNamedQueryResult updateNamedQuery(UpdateNamedQueryRequest updateNamedQueryRequest)
Updates a NamedQuery object. The database or workgroup cannot be updated.
updateNamedQueryRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.UpdateNotebookResult updateNotebook(UpdateNotebookRequest updateNotebookRequest)
Updates the contents of a Spark notebook.
updateNotebookRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.TooManyRequestsException - Indicates that the request was throttled.UpdateNotebookMetadataResult updateNotebookMetadata(UpdateNotebookMetadataRequest updateNotebookMetadataRequest)
Updates the metadata for a notebook.
updateNotebookMetadataRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.TooManyRequestsException - Indicates that the request was throttled.UpdatePreparedStatementResult updatePreparedStatement(UpdatePreparedStatementRequest updatePreparedStatementRequest)
Updates a prepared statement.
updatePreparedStatementRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.ResourceNotFoundException - A resource, such as a workgroup, was not found.UpdateWorkGroupResult updateWorkGroup(UpdateWorkGroupRequest updateWorkGroupRequest)
Updates the workgroup with the specified name. The workgroup's name cannot be changed. Only
ConfigurationUpdates can be specified.
updateWorkGroupRequest - InternalServerException - Indicates a platform issue, which may be due to a transient condition or outage.InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a required parameter may be
missing or out of range.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request - The originally executed request.Copyright © 2023. All rights reserved.