AWS SDK for C++AWS SDK for C++ Version 1.11.440 |
#include <AthenaClient.h>
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.
Definition at line 34 of file AthenaClient.h.
Definition at line 37 of file AthenaClient.h.
Definition at line 41 of file AthenaClient.h.
Definition at line 42 of file AthenaClient.h.
Aws::Athena::AthenaClientConfiguration()
,
nullptr
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Athena::AthenaClientConfiguration()
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Athena::AthenaClientConfiguration()
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
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.
nullptr
An Async wrapper for BatchGetNamedQuery that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 121 of file AthenaClient.h.
A Callable wrapper for BatchGetNamedQuery that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 112 of file AthenaClient.h.
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
.
nullptr
An Async wrapper for BatchGetPreparedStatement that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 151 of file AthenaClient.h.
A Callable wrapper for BatchGetPreparedStatement that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 142 of file AthenaClient.h.
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.
nullptr
An Async wrapper for BatchGetQueryExecution that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 182 of file AthenaClient.h.
A Callable wrapper for BatchGetQueryExecution that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 173 of file AthenaClient.h.
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.
nullptr
An Async wrapper for CancelCapacityReservation that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 211 of file AthenaClient.h.
A Callable wrapper for CancelCapacityReservation that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 202 of file AthenaClient.h.
Creates a capacity reservation with the specified name and number of requested data processing units.
nullptr
An Async wrapper for CreateCapacityReservation that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 237 of file AthenaClient.h.
A Callable wrapper for CreateCapacityReservation that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 228 of file AthenaClient.h.
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.
nullptr
An Async wrapper for CreateDataCatalog that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 264 of file AthenaClient.h.
A Callable wrapper for CreateDataCatalog that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 255 of file AthenaClient.h.
Creates a named query in the specified workgroup. Requires that you have access to the workgroup.
nullptr
An Async wrapper for CreateNamedQuery that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 290 of file AthenaClient.h.
A Callable wrapper for CreateNamedQuery that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 281 of file AthenaClient.h.
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.
nullptr
An Async wrapper for CreateNotebook that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 317 of file AthenaClient.h.
A Callable wrapper for CreateNotebook that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 308 of file AthenaClient.h.
nullptr
An Async wrapper for CreatePreparedStatement that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 343 of file AthenaClient.h.
A Callable wrapper for CreatePreparedStatement that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 334 of file AthenaClient.h.
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.
nullptr
An Async wrapper for CreatePresignedNotebookUrl that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 373 of file AthenaClient.h.
A Callable wrapper for CreatePresignedNotebookUrl that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 364 of file AthenaClient.h.
Creates a workgroup with the specified name. A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup.
nullptr
An Async wrapper for CreateWorkGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 400 of file AthenaClient.h.
A Callable wrapper for CreateWorkGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 391 of file AthenaClient.h.
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
.
nullptr
An Async wrapper for DeleteCapacityReservation that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 430 of file AthenaClient.h.
A Callable wrapper for DeleteCapacityReservation that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 421 of file AthenaClient.h.
nullptr
An Async wrapper for DeleteDataCatalog that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 455 of file AthenaClient.h.
A Callable wrapper for DeleteDataCatalog that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 446 of file AthenaClient.h.
Deletes the named query if you have access to the workgroup in which the query was saved.
nullptr
An Async wrapper for DeleteNamedQuery that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 481 of file AthenaClient.h.
A Callable wrapper for DeleteNamedQuery that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 472 of file AthenaClient.h.
nullptr
An Async wrapper for DeleteNotebook that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 506 of file AthenaClient.h.
A Callable wrapper for DeleteNotebook that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 497 of file AthenaClient.h.
Deletes the prepared statement with the specified name from the specified workgroup.
nullptr
An Async wrapper for DeletePreparedStatement that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 532 of file AthenaClient.h.
A Callable wrapper for DeletePreparedStatement that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 523 of file AthenaClient.h.
Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.
nullptr
An Async wrapper for DeleteWorkGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 558 of file AthenaClient.h.
A Callable wrapper for DeleteWorkGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 549 of file AthenaClient.h.
nullptr
An Async wrapper for ExportNotebook that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 584 of file AthenaClient.h.
A Callable wrapper for ExportNotebook that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 575 of file AthenaClient.h.
nullptr
An Async wrapper for GetCalculationExecution that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 610 of file AthenaClient.h.
A Callable wrapper for GetCalculationExecution that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 601 of file AthenaClient.h.
nullptr
An Async wrapper for GetCalculationExecutionCode that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 636 of file AthenaClient.h.
A Callable wrapper for GetCalculationExecutionCode that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 627 of file AthenaClient.h.
nullptr
An Async wrapper for GetCalculationExecutionStatus that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 661 of file AthenaClient.h.
A Callable wrapper for GetCalculationExecutionStatus that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 652 of file AthenaClient.h.
Gets the capacity assignment configuration for a capacity reservation, if one exists.
nullptr
An Async wrapper for GetCapacityAssignmentConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 687 of file AthenaClient.h.
A Callable wrapper for GetCapacityAssignmentConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 678 of file AthenaClient.h.
Returns information about the capacity reservation with the specified name.
nullptr
An Async wrapper for GetCapacityReservation that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 713 of file AthenaClient.h.
A Callable wrapper for GetCapacityReservation that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 704 of file AthenaClient.h.
nullptr
An Async wrapper for GetDatabase that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 764 of file AthenaClient.h.
A Callable wrapper for GetDatabase that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 755 of file AthenaClient.h.
nullptr
An Async wrapper for GetDataCatalog that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 738 of file AthenaClient.h.
A Callable wrapper for GetDataCatalog that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 729 of file AthenaClient.h.
Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.
nullptr
An Async wrapper for GetNamedQuery that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 790 of file AthenaClient.h.
A Callable wrapper for GetNamedQuery that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 781 of file AthenaClient.h.
nullptr
An Async wrapper for GetNotebookMetadata that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 816 of file AthenaClient.h.
A Callable wrapper for GetNotebookMetadata that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 807 of file AthenaClient.h.
Retrieves the prepared statement with the specified name from the specified workgroup.
nullptr
An Async wrapper for GetPreparedStatement that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 842 of file AthenaClient.h.
A Callable wrapper for GetPreparedStatement that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 833 of file AthenaClient.h.
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.
nullptr
An Async wrapper for GetQueryExecution that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 870 of file AthenaClient.h.
A Callable wrapper for GetQueryExecution that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 861 of file AthenaClient.h.
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.
nullptr
An Async wrapper for GetQueryResults that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 910 of file AthenaClient.h.
A Callable wrapper for GetQueryResults that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 901 of file AthenaClient.h.
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.
nullptr
An Async wrapper for GetQueryRuntimeStatistics that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 943 of file AthenaClient.h.
A Callable wrapper for GetQueryRuntimeStatistics that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 934 of file AthenaClient.h.
Gets the full details of a previously created session, including the session status and configuration.
nullptr
An Async wrapper for GetSession that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 969 of file AthenaClient.h.
A Callable wrapper for GetSession that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 960 of file AthenaClient.h.
nullptr
An Async wrapper for GetSessionStatus that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 994 of file AthenaClient.h.
A Callable wrapper for GetSessionStatus that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 985 of file AthenaClient.h.
nullptr
An Async wrapper for GetTableMetadata that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1020 of file AthenaClient.h.
A Callable wrapper for GetTableMetadata that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1011 of file AthenaClient.h.
nullptr
An Async wrapper for GetWorkGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1046 of file AthenaClient.h.
A Callable wrapper for GetWorkGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1037 of file AthenaClient.h.
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.
nullptr
An Async wrapper for ImportNotebook that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1077 of file AthenaClient.h.
A Callable wrapper for ImportNotebook that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1068 of file AthenaClient.h.
{}
)
const
Returns the supported DPU sizes for the supported application runtimes (for example, Athena notebook version 1
).
nullptr
,
{}
An Async wrapper for ListApplicationDPUSizes that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1103 of file AthenaClient.h.
{}
)
const
A Callable wrapper for ListApplicationDPUSizes that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1094 of file AthenaClient.h.
Lists the calculations that have been submitted to a session in descending order. Newer calculations are listed first; older calculations are listed later.
nullptr
An Async wrapper for ListCalculationExecutions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1130 of file AthenaClient.h.
A Callable wrapper for ListCalculationExecutions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1121 of file AthenaClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for ListCapacityReservations that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1156 of file AthenaClient.h.
{}
)
const
A Callable wrapper for ListCapacityReservations that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1147 of file AthenaClient.h.
nullptr
An Async wrapper for ListDatabases that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1210 of file AthenaClient.h.
A Callable wrapper for ListDatabases that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1201 of file AthenaClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for ListDataCatalogs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1184 of file AthenaClient.h.
{}
)
const
A Callable wrapper for ListDataCatalogs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1175 of file AthenaClient.h.
{}
)
const
Returns a list of engine versions that are available to choose from, including the Auto option.
nullptr
,
{}
An Async wrapper for ListEngineVersions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1236 of file AthenaClient.h.
{}
)
const
A Callable wrapper for ListEngineVersions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1227 of file AthenaClient.h.
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.
nullptr
An Async wrapper for ListExecutors that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1263 of file AthenaClient.h.
A Callable wrapper for ListExecutors that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1254 of file AthenaClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for ListNamedQueries that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1291 of file AthenaClient.h.
{}
)
const
A Callable wrapper for ListNamedQueries that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1282 of file AthenaClient.h.
Displays the notebook files for the specified workgroup in paginated format.
nullptr
An Async wrapper for ListNotebookMetadata that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1317 of file AthenaClient.h.
A Callable wrapper for ListNotebookMetadata that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1308 of file AthenaClient.h.
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.
nullptr
An Async wrapper for ListNotebookSessions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1345 of file AthenaClient.h.
A Callable wrapper for ListNotebookSessions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1336 of file AthenaClient.h.
nullptr
An Async wrapper for ListPreparedStatements that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1371 of file AthenaClient.h.
A Callable wrapper for ListPreparedStatements that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1362 of file AthenaClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for ListQueryExecutions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1400 of file AthenaClient.h.
{}
)
const
A Callable wrapper for ListQueryExecutions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1391 of file AthenaClient.h.
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.
nullptr
An Async wrapper for ListSessions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1428 of file AthenaClient.h.
A Callable wrapper for ListSessions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1419 of file AthenaClient.h.
Lists the metadata for the tables in the specified data catalog database.
nullptr
An Async wrapper for ListTableMetadata that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1454 of file AthenaClient.h.
A Callable wrapper for ListTableMetadata that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1445 of file AthenaClient.h.
nullptr
An Async wrapper for ListTagsForResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1480 of file AthenaClient.h.
A Callable wrapper for ListTagsForResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1471 of file AthenaClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for ListWorkGroups that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1505 of file AthenaClient.h.
{}
)
const
A Callable wrapper for ListWorkGroups that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1496 of file AthenaClient.h.
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.
nullptr
An Async wrapper for PutCapacityAssignmentConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1533 of file AthenaClient.h.
A Callable wrapper for PutCapacityAssignmentConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1524 of file AthenaClient.h.
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.
nullptr
An Async wrapper for StartCalculationExecution that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1564 of file AthenaClient.h.
A Callable wrapper for StartCalculationExecution that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1555 of file AthenaClient.h.
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.
nullptr
An Async wrapper for StartQueryExecution that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1595 of file AthenaClient.h.
A Callable wrapper for StartQueryExecution that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1586 of file AthenaClient.h.
Creates a session for running calculations within a workgroup. The session is ready when it reaches an IDLE
state.
nullptr
An Async wrapper for StartSession that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1621 of file AthenaClient.h.
A Callable wrapper for StartSession that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1612 of file AthenaClient.h.
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.
nullptr
An Async wrapper for StopCalculationExecution that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1654 of file AthenaClient.h.
A Callable wrapper for StopCalculationExecution that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1645 of file AthenaClient.h.
Stops a query execution. Requires you to have access to the workgroup in which the query ran.
nullptr
An Async wrapper for StopQueryExecution that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1680 of file AthenaClient.h.
A Callable wrapper for StopQueryExecution that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1671 of file AthenaClient.h.
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.
nullptr
An Async wrapper for TagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1717 of file AthenaClient.h.
A Callable wrapper for TagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1708 of file AthenaClient.h.
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
.
nullptr
An Async wrapper for TerminateSession that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1747 of file AthenaClient.h.
A Callable wrapper for TerminateSession that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1738 of file AthenaClient.h.
nullptr
An Async wrapper for UntagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1773 of file AthenaClient.h.
A Callable wrapper for UntagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1764 of file AthenaClient.h.
Updates the number of requested data processing units for the capacity reservation with the specified name.
nullptr
An Async wrapper for UpdateCapacityReservation that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1799 of file AthenaClient.h.
A Callable wrapper for UpdateCapacityReservation that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1790 of file AthenaClient.h.
nullptr
An Async wrapper for UpdateDataCatalog that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1825 of file AthenaClient.h.
A Callable wrapper for UpdateDataCatalog that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1816 of file AthenaClient.h.
Updates a NamedQuery object. The database or workgroup cannot be updated.
nullptr
An Async wrapper for UpdateNamedQuery that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1851 of file AthenaClient.h.
A Callable wrapper for UpdateNamedQuery that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1842 of file AthenaClient.h.
nullptr
An Async wrapper for UpdateNotebook that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1876 of file AthenaClient.h.
A Callable wrapper for UpdateNotebook that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1867 of file AthenaClient.h.
nullptr
An Async wrapper for UpdateNotebookMetadata that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1901 of file AthenaClient.h.
A Callable wrapper for UpdateNotebookMetadata that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1892 of file AthenaClient.h.
nullptr
An Async wrapper for UpdatePreparedStatement that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1926 of file AthenaClient.h.
A Callable wrapper for UpdatePreparedStatement that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1917 of file AthenaClient.h.
Updates the workgroup with the specified name. The workgroup's name cannot be changed. Only ConfigurationUpdates
can be specified.
nullptr
An Async wrapper for UpdateWorkGroup that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1953 of file AthenaClient.h.
A Callable wrapper for UpdateWorkGroup that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1944 of file AthenaClient.h.
Definition at line 1960 of file AthenaClient.h.