Interface AthenaAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbatchGetNamedQuery
(Consumer<BatchGetNamedQueryRequest.Builder> 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.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.batchGetPreparedStatement
(Consumer<BatchGetPreparedStatementRequest.Builder> 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.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.batchGetQueryExecution
(Consumer<BatchGetQueryExecutionRequest.Builder> 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.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.static AthenaAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aAthenaAsyncClient
.cancelCapacityReservation
(Consumer<CancelCapacityReservationRequest.Builder> cancelCapacityReservationRequest) Cancels the capacity reservation with the specified name.cancelCapacityReservation
(CancelCapacityReservationRequest cancelCapacityReservationRequest) Cancels the capacity reservation with the specified name.static AthenaAsyncClient
create()
Create aAthenaAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createCapacityReservation
(Consumer<CreateCapacityReservationRequest.Builder> createCapacityReservationRequest) Creates a capacity reservation with the specified name and number of requested data processing units.createCapacityReservation
(CreateCapacityReservationRequest createCapacityReservationRequest) Creates a capacity reservation with the specified name and number of requested data processing units.createDataCatalog
(Consumer<CreateDataCatalogRequest.Builder> createDataCatalogRequest) Creates (registers) a data catalog with the specified name and properties.createDataCatalog
(CreateDataCatalogRequest createDataCatalogRequest) Creates (registers) a data catalog with the specified name and properties.createNamedQuery
(Consumer<CreateNamedQueryRequest.Builder> createNamedQueryRequest) Creates a named query in the specified workgroup.createNamedQuery
(CreateNamedQueryRequest createNamedQueryRequest) Creates a named query in the specified workgroup.default CompletableFuture
<CreateNotebookResponse> createNotebook
(Consumer<CreateNotebookRequest.Builder> createNotebookRequest) Creates an emptyipynb
file in the specified Apache Spark enabled workgroup.default CompletableFuture
<CreateNotebookResponse> createNotebook
(CreateNotebookRequest createNotebookRequest) Creates an emptyipynb
file in the specified Apache Spark enabled workgroup.createPreparedStatement
(Consumer<CreatePreparedStatementRequest.Builder> createPreparedStatementRequest) Creates a prepared statement for use with SQL queries in Athena.createPreparedStatement
(CreatePreparedStatementRequest createPreparedStatementRequest) Creates a prepared statement for use with SQL queries in Athena.createPresignedNotebookUrl
(Consumer<CreatePresignedNotebookUrlRequest.Builder> createPresignedNotebookUrlRequest) Gets an authentication token and the URL at which the notebook can be accessed.createPresignedNotebookUrl
(CreatePresignedNotebookUrlRequest createPresignedNotebookUrlRequest) Gets an authentication token and the URL at which the notebook can be accessed.default CompletableFuture
<CreateWorkGroupResponse> createWorkGroup
(Consumer<CreateWorkGroupRequest.Builder> createWorkGroupRequest) Creates a workgroup with the specified name.default CompletableFuture
<CreateWorkGroupResponse> createWorkGroup
(CreateWorkGroupRequest createWorkGroupRequest) Creates a workgroup with the specified name.deleteCapacityReservation
(Consumer<DeleteCapacityReservationRequest.Builder> deleteCapacityReservationRequest) Deletes a cancelled capacity reservation.deleteCapacityReservation
(DeleteCapacityReservationRequest deleteCapacityReservationRequest) Deletes a cancelled capacity reservation.deleteDataCatalog
(Consumer<DeleteDataCatalogRequest.Builder> deleteDataCatalogRequest) Deletes a data catalog.deleteDataCatalog
(DeleteDataCatalogRequest deleteDataCatalogRequest) Deletes a data catalog.deleteNamedQuery
(Consumer<DeleteNamedQueryRequest.Builder> deleteNamedQueryRequest) Deletes the named query if you have access to the workgroup in which the query was saved.deleteNamedQuery
(DeleteNamedQueryRequest deleteNamedQueryRequest) Deletes the named query if you have access to the workgroup in which the query was saved.default CompletableFuture
<DeleteNotebookResponse> deleteNotebook
(Consumer<DeleteNotebookRequest.Builder> deleteNotebookRequest) Deletes the specified notebook.default CompletableFuture
<DeleteNotebookResponse> deleteNotebook
(DeleteNotebookRequest deleteNotebookRequest) Deletes the specified notebook.deletePreparedStatement
(Consumer<DeletePreparedStatementRequest.Builder> deletePreparedStatementRequest) Deletes the prepared statement with the specified name from the specified workgroup.deletePreparedStatement
(DeletePreparedStatementRequest deletePreparedStatementRequest) Deletes the prepared statement with the specified name from the specified workgroup.default CompletableFuture
<DeleteWorkGroupResponse> deleteWorkGroup
(Consumer<DeleteWorkGroupRequest.Builder> deleteWorkGroupRequest) Deletes the workgroup with the specified name.default CompletableFuture
<DeleteWorkGroupResponse> deleteWorkGroup
(DeleteWorkGroupRequest deleteWorkGroupRequest) Deletes the workgroup with the specified name.default CompletableFuture
<ExportNotebookResponse> exportNotebook
(Consumer<ExportNotebookRequest.Builder> exportNotebookRequest) Exports the specified notebook and its metadata.default CompletableFuture
<ExportNotebookResponse> exportNotebook
(ExportNotebookRequest exportNotebookRequest) Exports the specified notebook and its metadata.getCalculationExecution
(Consumer<GetCalculationExecutionRequest.Builder> getCalculationExecutionRequest) Describes a previously submitted calculation execution.getCalculationExecution
(GetCalculationExecutionRequest getCalculationExecutionRequest) Describes a previously submitted calculation execution.getCalculationExecutionCode
(Consumer<GetCalculationExecutionCodeRequest.Builder> getCalculationExecutionCodeRequest) Retrieves the unencrypted code that was executed for the calculation.getCalculationExecutionCode
(GetCalculationExecutionCodeRequest getCalculationExecutionCodeRequest) Retrieves the unencrypted code that was executed for the calculation.getCalculationExecutionStatus
(Consumer<GetCalculationExecutionStatusRequest.Builder> getCalculationExecutionStatusRequest) Gets the status of a current calculation.getCalculationExecutionStatus
(GetCalculationExecutionStatusRequest getCalculationExecutionStatusRequest) Gets the status of a current calculation.getCapacityAssignmentConfiguration
(Consumer<GetCapacityAssignmentConfigurationRequest.Builder> getCapacityAssignmentConfigurationRequest) Gets the capacity assignment configuration for a capacity reservation, if one exists.getCapacityAssignmentConfiguration
(GetCapacityAssignmentConfigurationRequest getCapacityAssignmentConfigurationRequest) Gets the capacity assignment configuration for a capacity reservation, if one exists.getCapacityReservation
(Consumer<GetCapacityReservationRequest.Builder> getCapacityReservationRequest) Returns information about the capacity reservation with the specified name.getCapacityReservation
(GetCapacityReservationRequest getCapacityReservationRequest) Returns information about the capacity reservation with the specified name.default CompletableFuture
<GetDatabaseResponse> getDatabase
(Consumer<GetDatabaseRequest.Builder> getDatabaseRequest) Returns a database object for the specified database and data catalog.default CompletableFuture
<GetDatabaseResponse> getDatabase
(GetDatabaseRequest getDatabaseRequest) Returns a database object for the specified database and data catalog.default CompletableFuture
<GetDataCatalogResponse> getDataCatalog
(Consumer<GetDataCatalogRequest.Builder> getDataCatalogRequest) Returns the specified data catalog.default CompletableFuture
<GetDataCatalogResponse> getDataCatalog
(GetDataCatalogRequest getDataCatalogRequest) Returns the specified data catalog.default CompletableFuture
<GetNamedQueryResponse> getNamedQuery
(Consumer<GetNamedQueryRequest.Builder> getNamedQueryRequest) Returns information about a single query.default CompletableFuture
<GetNamedQueryResponse> getNamedQuery
(GetNamedQueryRequest getNamedQueryRequest) Returns information about a single query.getNotebookMetadata
(Consumer<GetNotebookMetadataRequest.Builder> getNotebookMetadataRequest) Retrieves notebook metadata for the specified notebook ID.getNotebookMetadata
(GetNotebookMetadataRequest getNotebookMetadataRequest) Retrieves notebook metadata for the specified notebook ID.getPreparedStatement
(Consumer<GetPreparedStatementRequest.Builder> getPreparedStatementRequest) Retrieves the prepared statement with the specified name from the specified workgroup.getPreparedStatement
(GetPreparedStatementRequest getPreparedStatementRequest) Retrieves the prepared statement with the specified name from the specified workgroup.getQueryExecution
(Consumer<GetQueryExecutionRequest.Builder> getQueryExecutionRequest) Returns information about a single execution of a query if you have access to the workgroup in which the query ran.getQueryExecution
(GetQueryExecutionRequest getQueryExecutionRequest) Returns information about a single execution of a query if you have access to the workgroup in which the query ran.default CompletableFuture
<GetQueryResultsResponse> getQueryResults
(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest) Streams the results of a single query execution specified byQueryExecutionId
from the Athena query results location in Amazon S3.default CompletableFuture
<GetQueryResultsResponse> getQueryResults
(GetQueryResultsRequest getQueryResultsRequest) Streams the results of a single query execution specified byQueryExecutionId
from the Athena query results location in Amazon S3.default GetQueryResultsPublisher
getQueryResultsPaginator
(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest) This is a variant ofgetQueryResults(software.amazon.awssdk.services.athena.model.GetQueryResultsRequest)
operation.default GetQueryResultsPublisher
getQueryResultsPaginator
(GetQueryResultsRequest getQueryResultsRequest) This is a variant ofgetQueryResults(software.amazon.awssdk.services.athena.model.GetQueryResultsRequest)
operation.getQueryRuntimeStatistics
(Consumer<GetQueryRuntimeStatisticsRequest.Builder> 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.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.default CompletableFuture
<GetSessionResponse> getSession
(Consumer<GetSessionRequest.Builder> getSessionRequest) Gets the full details of a previously created session, including the session status and configuration.default CompletableFuture
<GetSessionResponse> getSession
(GetSessionRequest getSessionRequest) Gets the full details of a previously created session, including the session status and configuration.getSessionStatus
(Consumer<GetSessionStatusRequest.Builder> getSessionStatusRequest) Gets the current status of a session.getSessionStatus
(GetSessionStatusRequest getSessionStatusRequest) Gets the current status of a session.getTableMetadata
(Consumer<GetTableMetadataRequest.Builder> getTableMetadataRequest) Returns table metadata for the specified catalog, database, and table.getTableMetadata
(GetTableMetadataRequest getTableMetadataRequest) Returns table metadata for the specified catalog, database, and table.default CompletableFuture
<GetWorkGroupResponse> getWorkGroup
(Consumer<GetWorkGroupRequest.Builder> getWorkGroupRequest) Returns information about the workgroup with the specified name.default CompletableFuture
<GetWorkGroupResponse> getWorkGroup
(GetWorkGroupRequest getWorkGroupRequest) Returns information about the workgroup with the specified name.default CompletableFuture
<ImportNotebookResponse> importNotebook
(Consumer<ImportNotebookRequest.Builder> importNotebookRequest) Imports a singleipynb
file to a Spark enabled workgroup.default CompletableFuture
<ImportNotebookResponse> importNotebook
(ImportNotebookRequest importNotebookRequest) Imports a singleipynb
file to a Spark enabled workgroup.listApplicationDPUSizes
(Consumer<ListApplicationDpuSizesRequest.Builder> listApplicationDpuSizesRequest) Returns the supported DPU sizes for the supported application runtimes (for example,Athena notebook version 1
).listApplicationDPUSizes
(ListApplicationDpuSizesRequest listApplicationDpuSizesRequest) Returns the supported DPU sizes for the supported application runtimes (for example,Athena notebook version 1
).default ListApplicationDPUSizesPublisher
listApplicationDPUSizesPaginator
(Consumer<ListApplicationDpuSizesRequest.Builder> listApplicationDpuSizesRequest) This is a variant oflistApplicationDPUSizes(software.amazon.awssdk.services.athena.model.ListApplicationDpuSizesRequest)
operation.default ListApplicationDPUSizesPublisher
listApplicationDPUSizesPaginator
(ListApplicationDpuSizesRequest listApplicationDpuSizesRequest) This is a variant oflistApplicationDPUSizes(software.amazon.awssdk.services.athena.model.ListApplicationDpuSizesRequest)
operation.listCalculationExecutions
(Consumer<ListCalculationExecutionsRequest.Builder> listCalculationExecutionsRequest) Lists the calculations that have been submitted to a session in descending order.listCalculationExecutions
(ListCalculationExecutionsRequest listCalculationExecutionsRequest) Lists the calculations that have been submitted to a session in descending order.listCalculationExecutionsPaginator
(Consumer<ListCalculationExecutionsRequest.Builder> listCalculationExecutionsRequest) This is a variant oflistCalculationExecutions(software.amazon.awssdk.services.athena.model.ListCalculationExecutionsRequest)
operation.listCalculationExecutionsPaginator
(ListCalculationExecutionsRequest listCalculationExecutionsRequest) This is a variant oflistCalculationExecutions(software.amazon.awssdk.services.athena.model.ListCalculationExecutionsRequest)
operation.listCapacityReservations
(Consumer<ListCapacityReservationsRequest.Builder> listCapacityReservationsRequest) Lists the capacity reservations for the current account.listCapacityReservations
(ListCapacityReservationsRequest listCapacityReservationsRequest) Lists the capacity reservations for the current account.listCapacityReservationsPaginator
(Consumer<ListCapacityReservationsRequest.Builder> listCapacityReservationsRequest) This is a variant oflistCapacityReservations(software.amazon.awssdk.services.athena.model.ListCapacityReservationsRequest)
operation.listCapacityReservationsPaginator
(ListCapacityReservationsRequest listCapacityReservationsRequest) This is a variant oflistCapacityReservations(software.amazon.awssdk.services.athena.model.ListCapacityReservationsRequest)
operation.default CompletableFuture
<ListDatabasesResponse> listDatabases
(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest) Lists the databases in the specified data catalog.default CompletableFuture
<ListDatabasesResponse> listDatabases
(ListDatabasesRequest listDatabasesRequest) Lists the databases in the specified data catalog.default ListDatabasesPublisher
listDatabasesPaginator
(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest) This is a variant oflistDatabases(software.amazon.awssdk.services.athena.model.ListDatabasesRequest)
operation.default ListDatabasesPublisher
listDatabasesPaginator
(ListDatabasesRequest listDatabasesRequest) This is a variant oflistDatabases(software.amazon.awssdk.services.athena.model.ListDatabasesRequest)
operation.listDataCatalogs
(Consumer<ListDataCatalogsRequest.Builder> listDataCatalogsRequest) Lists the data catalogs in the current Amazon Web Services account.listDataCatalogs
(ListDataCatalogsRequest listDataCatalogsRequest) Lists the data catalogs in the current Amazon Web Services account.default ListDataCatalogsPublisher
listDataCatalogsPaginator
(Consumer<ListDataCatalogsRequest.Builder> listDataCatalogsRequest) This is a variant oflistDataCatalogs(software.amazon.awssdk.services.athena.model.ListDataCatalogsRequest)
operation.default ListDataCatalogsPublisher
listDataCatalogsPaginator
(ListDataCatalogsRequest listDataCatalogsRequest) This is a variant oflistDataCatalogs(software.amazon.awssdk.services.athena.model.ListDataCatalogsRequest)
operation.listEngineVersions
(Consumer<ListEngineVersionsRequest.Builder> listEngineVersionsRequest) Returns a list of engine versions that are available to choose from, including the Auto option.listEngineVersions
(ListEngineVersionsRequest listEngineVersionsRequest) Returns a list of engine versions that are available to choose from, including the Auto option.default ListEngineVersionsPublisher
listEngineVersionsPaginator
(Consumer<ListEngineVersionsRequest.Builder> listEngineVersionsRequest) This is a variant oflistEngineVersions(software.amazon.awssdk.services.athena.model.ListEngineVersionsRequest)
operation.default ListEngineVersionsPublisher
listEngineVersionsPaginator
(ListEngineVersionsRequest listEngineVersionsRequest) This is a variant oflistEngineVersions(software.amazon.awssdk.services.athena.model.ListEngineVersionsRequest)
operation.default CompletableFuture
<ListExecutorsResponse> listExecutors
(Consumer<ListExecutorsRequest.Builder> listExecutorsRequest) Lists, in descending order, the executors that joined a session.default CompletableFuture
<ListExecutorsResponse> listExecutors
(ListExecutorsRequest listExecutorsRequest) Lists, in descending order, the executors that joined a session.default ListExecutorsPublisher
listExecutorsPaginator
(Consumer<ListExecutorsRequest.Builder> listExecutorsRequest) This is a variant oflistExecutors(software.amazon.awssdk.services.athena.model.ListExecutorsRequest)
operation.default ListExecutorsPublisher
listExecutorsPaginator
(ListExecutorsRequest listExecutorsRequest) This is a variant oflistExecutors(software.amazon.awssdk.services.athena.model.ListExecutorsRequest)
operation.Provides a list of available query IDs only for queries saved in the specified workgroup.listNamedQueries
(Consumer<ListNamedQueriesRequest.Builder> listNamedQueriesRequest) Provides a list of available query IDs only for queries saved in the specified workgroup.listNamedQueries
(ListNamedQueriesRequest listNamedQueriesRequest) Provides a list of available query IDs only for queries saved in the specified workgroup.default ListNamedQueriesPublisher
This is a variant oflistNamedQueries(software.amazon.awssdk.services.athena.model.ListNamedQueriesRequest)
operation.default ListNamedQueriesPublisher
listNamedQueriesPaginator
(Consumer<ListNamedQueriesRequest.Builder> listNamedQueriesRequest) This is a variant oflistNamedQueries(software.amazon.awssdk.services.athena.model.ListNamedQueriesRequest)
operation.default ListNamedQueriesPublisher
listNamedQueriesPaginator
(ListNamedQueriesRequest listNamedQueriesRequest) This is a variant oflistNamedQueries(software.amazon.awssdk.services.athena.model.ListNamedQueriesRequest)
operation.listNotebookMetadata
(Consumer<ListNotebookMetadataRequest.Builder> listNotebookMetadataRequest) Displays the notebook files for the specified workgroup in paginated format.listNotebookMetadata
(ListNotebookMetadataRequest listNotebookMetadataRequest) Displays the notebook files for the specified workgroup in paginated format.listNotebookSessions
(Consumer<ListNotebookSessionsRequest.Builder> listNotebookSessionsRequest) Lists, in descending order, the sessions that have been created in a notebook that are in an active state likeCREATING
,CREATED
,IDLE
orBUSY
.listNotebookSessions
(ListNotebookSessionsRequest listNotebookSessionsRequest) Lists, in descending order, the sessions that have been created in a notebook that are in an active state likeCREATING
,CREATED
,IDLE
orBUSY
.listPreparedStatements
(Consumer<ListPreparedStatementsRequest.Builder> listPreparedStatementsRequest) Lists the prepared statements in the specified workgroup.listPreparedStatements
(ListPreparedStatementsRequest listPreparedStatementsRequest) Lists the prepared statements in the specified workgroup.default ListPreparedStatementsPublisher
listPreparedStatementsPaginator
(Consumer<ListPreparedStatementsRequest.Builder> listPreparedStatementsRequest) This is a variant oflistPreparedStatements(software.amazon.awssdk.services.athena.model.ListPreparedStatementsRequest)
operation.default ListPreparedStatementsPublisher
listPreparedStatementsPaginator
(ListPreparedStatementsRequest listPreparedStatementsRequest) This is a variant oflistPreparedStatements(software.amazon.awssdk.services.athena.model.ListPreparedStatementsRequest)
operation.Provides a list of available query execution IDs for the queries in the specified workgroup.listQueryExecutions
(Consumer<ListQueryExecutionsRequest.Builder> listQueryExecutionsRequest) Provides a list of available query execution IDs for the queries in the specified workgroup.listQueryExecutions
(ListQueryExecutionsRequest listQueryExecutionsRequest) Provides a list of available query execution IDs for the queries in the specified workgroup.default ListQueryExecutionsPublisher
This is a variant oflistQueryExecutions(software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest)
operation.default ListQueryExecutionsPublisher
listQueryExecutionsPaginator
(Consumer<ListQueryExecutionsRequest.Builder> listQueryExecutionsRequest) This is a variant oflistQueryExecutions(software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest)
operation.default ListQueryExecutionsPublisher
listQueryExecutionsPaginator
(ListQueryExecutionsRequest listQueryExecutionsRequest) This is a variant oflistQueryExecutions(software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest)
operation.default CompletableFuture
<ListSessionsResponse> listSessions
(Consumer<ListSessionsRequest.Builder> listSessionsRequest) Lists the sessions in a workgroup that are in an active state likeCREATING
,CREATED
,IDLE
, orBUSY
.default CompletableFuture
<ListSessionsResponse> listSessions
(ListSessionsRequest listSessionsRequest) Lists the sessions in a workgroup that are in an active state likeCREATING
,CREATED
,IDLE
, orBUSY
.default ListSessionsPublisher
listSessionsPaginator
(Consumer<ListSessionsRequest.Builder> listSessionsRequest) This is a variant oflistSessions(software.amazon.awssdk.services.athena.model.ListSessionsRequest)
operation.default ListSessionsPublisher
listSessionsPaginator
(ListSessionsRequest listSessionsRequest) This is a variant oflistSessions(software.amazon.awssdk.services.athena.model.ListSessionsRequest)
operation.listTableMetadata
(Consumer<ListTableMetadataRequest.Builder> listTableMetadataRequest) Lists the metadata for the tables in the specified data catalog database.listTableMetadata
(ListTableMetadataRequest listTableMetadataRequest) Lists the metadata for the tables in the specified data catalog database.default ListTableMetadataPublisher
listTableMetadataPaginator
(Consumer<ListTableMetadataRequest.Builder> listTableMetadataRequest) This is a variant oflistTableMetadata(software.amazon.awssdk.services.athena.model.ListTableMetadataRequest)
operation.default ListTableMetadataPublisher
listTableMetadataPaginator
(ListTableMetadataRequest listTableMetadataRequest) This is a variant oflistTableMetadata(software.amazon.awssdk.services.athena.model.ListTableMetadataRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags associated with an Athena resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags associated with an Athena resource.default ListTagsForResourcePublisher
listTagsForResourcePaginator
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.athena.model.ListTagsForResourceRequest)
operation.default ListTagsForResourcePublisher
listTagsForResourcePaginator
(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.athena.model.ListTagsForResourceRequest)
operation.default CompletableFuture
<ListWorkGroupsResponse> listWorkGroups
(Consumer<ListWorkGroupsRequest.Builder> listWorkGroupsRequest) Lists available workgroups for the account.default CompletableFuture
<ListWorkGroupsResponse> listWorkGroups
(ListWorkGroupsRequest listWorkGroupsRequest) Lists available workgroups for the account.default ListWorkGroupsPublisher
listWorkGroupsPaginator
(Consumer<ListWorkGroupsRequest.Builder> listWorkGroupsRequest) This is a variant oflistWorkGroups(software.amazon.awssdk.services.athena.model.ListWorkGroupsRequest)
operation.default ListWorkGroupsPublisher
listWorkGroupsPaginator
(ListWorkGroupsRequest listWorkGroupsRequest) This is a variant oflistWorkGroups(software.amazon.awssdk.services.athena.model.ListWorkGroupsRequest)
operation.putCapacityAssignmentConfiguration
(Consumer<PutCapacityAssignmentConfigurationRequest.Builder> putCapacityAssignmentConfigurationRequest) Puts a new capacity assignment configuration for a specified capacity reservation.putCapacityAssignmentConfiguration
(PutCapacityAssignmentConfigurationRequest putCapacityAssignmentConfigurationRequest) Puts a new capacity assignment configuration for a specified capacity reservation.default AthenaServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartCalculationExecution
(Consumer<StartCalculationExecutionRequest.Builder> startCalculationExecutionRequest) Submits calculations for execution within a session.startCalculationExecution
(StartCalculationExecutionRequest startCalculationExecutionRequest) Submits calculations for execution within a session.startQueryExecution
(Consumer<StartQueryExecutionRequest.Builder> startQueryExecutionRequest) Runs the SQL query statements contained in theQuery
.startQueryExecution
(StartQueryExecutionRequest startQueryExecutionRequest) Runs the SQL query statements contained in theQuery
.default CompletableFuture
<StartSessionResponse> startSession
(Consumer<StartSessionRequest.Builder> startSessionRequest) Creates a session for running calculations within a workgroup.default CompletableFuture
<StartSessionResponse> startSession
(StartSessionRequest startSessionRequest) Creates a session for running calculations within a workgroup.stopCalculationExecution
(Consumer<StopCalculationExecutionRequest.Builder> stopCalculationExecutionRequest) Requests the cancellation of a calculation.stopCalculationExecution
(StopCalculationExecutionRequest stopCalculationExecutionRequest) Requests the cancellation of a calculation.stopQueryExecution
(Consumer<StopQueryExecutionRequest.Builder> stopQueryExecutionRequest) Stops a query execution.stopQueryExecution
(StopQueryExecutionRequest stopQueryExecutionRequest) Stops a query execution.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds one or more tags to an Athena resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds one or more tags to an Athena resource.terminateSession
(Consumer<TerminateSessionRequest.Builder> terminateSessionRequest) Terminates an active session.terminateSession
(TerminateSessionRequest terminateSessionRequest) Terminates an active session.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from an Athena resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes one or more tags from an Athena resource.updateCapacityReservation
(Consumer<UpdateCapacityReservationRequest.Builder> updateCapacityReservationRequest) Updates the number of requested data processing units for the capacity reservation with the specified name.updateCapacityReservation
(UpdateCapacityReservationRequest updateCapacityReservationRequest) Updates the number of requested data processing units for the capacity reservation with the specified name.updateDataCatalog
(Consumer<UpdateDataCatalogRequest.Builder> updateDataCatalogRequest) Updates the data catalog that has the specified name.updateDataCatalog
(UpdateDataCatalogRequest updateDataCatalogRequest) Updates the data catalog that has the specified name.updateNamedQuery
(Consumer<UpdateNamedQueryRequest.Builder> updateNamedQueryRequest) Updates a NamedQuery object.updateNamedQuery
(UpdateNamedQueryRequest updateNamedQueryRequest) Updates a NamedQuery object.default CompletableFuture
<UpdateNotebookResponse> updateNotebook
(Consumer<UpdateNotebookRequest.Builder> updateNotebookRequest) Updates the contents of a Spark notebook.default CompletableFuture
<UpdateNotebookResponse> updateNotebook
(UpdateNotebookRequest updateNotebookRequest) Updates the contents of a Spark notebook.updateNotebookMetadata
(Consumer<UpdateNotebookMetadataRequest.Builder> updateNotebookMetadataRequest) Updates the metadata for a notebook.updateNotebookMetadata
(UpdateNotebookMetadataRequest updateNotebookMetadataRequest) Updates the metadata for a notebook.updatePreparedStatement
(Consumer<UpdatePreparedStatementRequest.Builder> updatePreparedStatementRequest) Updates a prepared statement.updatePreparedStatement
(UpdatePreparedStatementRequest updatePreparedStatementRequest) Updates a prepared statement.default CompletableFuture
<UpdateWorkGroupResponse> updateWorkGroup
(Consumer<UpdateWorkGroupRequest.Builder> updateWorkGroupRequest) Updates the workgroup with the specified name.default CompletableFuture
<UpdateWorkGroupResponse> updateWorkGroup
(UpdateWorkGroupRequest updateWorkGroupRequest) Updates the workgroup with the specified name.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
batchGetNamedQuery
default CompletableFuture<BatchGetNamedQueryResponse> 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.
- Parameters:
batchGetNamedQueryRequest
- Contains an array of named query IDs.- Returns:
- A Java Future containing the result of the BatchGetNamedQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetNamedQuery
default CompletableFuture<BatchGetNamedQueryResponse> batchGetNamedQuery(Consumer<BatchGetNamedQueryRequest.Builder> 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.
This is a convenience which creates an instance of the
BatchGetNamedQueryRequest.Builder
avoiding the need to create one manually viaBatchGetNamedQueryRequest.builder()
- Parameters:
batchGetNamedQueryRequest
- AConsumer
that will call methods onBatchGetNamedQueryRequest.Builder
to create a request. Contains an array of named query IDs.- Returns:
- A Java Future containing the result of the BatchGetNamedQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetPreparedStatement
default CompletableFuture<BatchGetPreparedStatementResponse> 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
.- Parameters:
batchGetPreparedStatementRequest
-- Returns:
- A Java Future containing the result of the BatchGetPreparedStatement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetPreparedStatement
default CompletableFuture<BatchGetPreparedStatementResponse> batchGetPreparedStatement(Consumer<BatchGetPreparedStatementRequest.Builder> 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
.
This is a convenience which creates an instance of the
BatchGetPreparedStatementRequest.Builder
avoiding the need to create one manually viaBatchGetPreparedStatementRequest.builder()
- Parameters:
batchGetPreparedStatementRequest
- AConsumer
that will call methods onBatchGetPreparedStatementRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchGetPreparedStatement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetQueryExecution
default CompletableFuture<BatchGetQueryExecutionResponse> 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 ListQueryExecutionsInputinvalid input: '$'WorkGroup. Query executions differ from named (saved) queries. Use BatchGetNamedQueryInput to get details about named queries.
- Parameters:
batchGetQueryExecutionRequest
- Contains an array of query execution IDs.- Returns:
- A Java Future containing the result of the BatchGetQueryExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetQueryExecution
default CompletableFuture<BatchGetQueryExecutionResponse> batchGetQueryExecution(Consumer<BatchGetQueryExecutionRequest.Builder> 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 ListQueryExecutionsInputinvalid input: '$'WorkGroup. Query executions differ from named (saved) queries. Use BatchGetNamedQueryInput to get details about named queries.
This is a convenience which creates an instance of the
BatchGetQueryExecutionRequest.Builder
avoiding the need to create one manually viaBatchGetQueryExecutionRequest.builder()
- Parameters:
batchGetQueryExecutionRequest
- AConsumer
that will call methods onBatchGetQueryExecutionRequest.Builder
to create a request. Contains an array of query execution IDs.- Returns:
- A Java Future containing the result of the BatchGetQueryExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelCapacityReservation
default CompletableFuture<CancelCapacityReservationResponse> 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.
- Parameters:
cancelCapacityReservationRequest
-- Returns:
- A Java Future containing the result of the CancelCapacityReservation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelCapacityReservation
default CompletableFuture<CancelCapacityReservationResponse> cancelCapacityReservation(Consumer<CancelCapacityReservationRequest.Builder> 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.
This is a convenience which creates an instance of the
CancelCapacityReservationRequest.Builder
avoiding the need to create one manually viaCancelCapacityReservationRequest.builder()
- Parameters:
cancelCapacityReservationRequest
- AConsumer
that will call methods onCancelCapacityReservationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CancelCapacityReservation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCapacityReservation
default CompletableFuture<CreateCapacityReservationResponse> createCapacityReservation(CreateCapacityReservationRequest createCapacityReservationRequest) Creates a capacity reservation with the specified name and number of requested data processing units.
- Parameters:
createCapacityReservationRequest
-- Returns:
- A Java Future containing the result of the CreateCapacityReservation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCapacityReservation
default CompletableFuture<CreateCapacityReservationResponse> createCapacityReservation(Consumer<CreateCapacityReservationRequest.Builder> createCapacityReservationRequest) Creates a capacity reservation with the specified name and number of requested data processing units.
This is a convenience which creates an instance of the
CreateCapacityReservationRequest.Builder
avoiding the need to create one manually viaCreateCapacityReservationRequest.builder()
- Parameters:
createCapacityReservationRequest
- AConsumer
that will call methods onCreateCapacityReservationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateCapacityReservation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDataCatalog
default CompletableFuture<CreateDataCatalogResponse> 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.
- Parameters:
createDataCatalogRequest
-- Returns:
- A Java Future containing the result of the CreateDataCatalog operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDataCatalog
default CompletableFuture<CreateDataCatalogResponse> createDataCatalog(Consumer<CreateDataCatalogRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateDataCatalogRequest.Builder
avoiding the need to create one manually viaCreateDataCatalogRequest.builder()
- Parameters:
createDataCatalogRequest
- AConsumer
that will call methods onCreateDataCatalogRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDataCatalog operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createNamedQuery
default CompletableFuture<CreateNamedQueryResponse> createNamedQuery(CreateNamedQueryRequest createNamedQueryRequest) Creates a named query in the specified workgroup. Requires that you have access to the workgroup.
- Parameters:
createNamedQueryRequest
-- Returns:
- A Java Future containing the result of the CreateNamedQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createNamedQuery
default CompletableFuture<CreateNamedQueryResponse> createNamedQuery(Consumer<CreateNamedQueryRequest.Builder> createNamedQueryRequest) Creates a named query in the specified workgroup. Requires that you have access to the workgroup.
This is a convenience which creates an instance of the
CreateNamedQueryRequest.Builder
avoiding the need to create one manually viaCreateNamedQueryRequest.builder()
- Parameters:
createNamedQueryRequest
- AConsumer
that will call methods onCreateNamedQueryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateNamedQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createNotebook
default CompletableFuture<CreateNotebookResponse> 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.- Parameters:
createNotebookRequest
-- Returns:
- A Java Future containing the result of the CreateNotebook operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createNotebook
default CompletableFuture<CreateNotebookResponse> createNotebook(Consumer<CreateNotebookRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateNotebookRequest.Builder
avoiding the need to create one manually viaCreateNotebookRequest.builder()
- Parameters:
createNotebookRequest
- AConsumer
that will call methods onCreateNotebookRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateNotebook operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPreparedStatement
default CompletableFuture<CreatePreparedStatementResponse> createPreparedStatement(CreatePreparedStatementRequest createPreparedStatementRequest) Creates a prepared statement for use with SQL queries in Athena.
- Parameters:
createPreparedStatementRequest
-- Returns:
- A Java Future containing the result of the CreatePreparedStatement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPreparedStatement
default CompletableFuture<CreatePreparedStatementResponse> createPreparedStatement(Consumer<CreatePreparedStatementRequest.Builder> createPreparedStatementRequest) Creates a prepared statement for use with SQL queries in Athena.
This is a convenience which creates an instance of the
CreatePreparedStatementRequest.Builder
avoiding the need to create one manually viaCreatePreparedStatementRequest.builder()
- Parameters:
createPreparedStatementRequest
- AConsumer
that will call methods onCreatePreparedStatementRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreatePreparedStatement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPresignedNotebookUrl
default CompletableFuture<CreatePresignedNotebookUrlResponse> 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.- Parameters:
createPresignedNotebookUrlRequest
-- Returns:
- A Java Future containing the result of the CreatePresignedNotebookUrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPresignedNotebookUrl
default CompletableFuture<CreatePresignedNotebookUrlResponse> createPresignedNotebookUrl(Consumer<CreatePresignedNotebookUrlRequest.Builder> 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.
This is a convenience which creates an instance of the
CreatePresignedNotebookUrlRequest.Builder
avoiding the need to create one manually viaCreatePresignedNotebookUrlRequest.builder()
- Parameters:
createPresignedNotebookUrlRequest
- AConsumer
that will call methods onCreatePresignedNotebookUrlRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreatePresignedNotebookUrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createWorkGroup
default CompletableFuture<CreateWorkGroupResponse> createWorkGroup(CreateWorkGroupRequest createWorkGroupRequest) Creates a workgroup with the specified name. A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup.
- Parameters:
createWorkGroupRequest
-- Returns:
- A Java Future containing the result of the CreateWorkGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createWorkGroup
default CompletableFuture<CreateWorkGroupResponse> createWorkGroup(Consumer<CreateWorkGroupRequest.Builder> createWorkGroupRequest) Creates a workgroup with the specified name. A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup.
This is a convenience which creates an instance of the
CreateWorkGroupRequest.Builder
avoiding the need to create one manually viaCreateWorkGroupRequest.builder()
- Parameters:
createWorkGroupRequest
- AConsumer
that will call methods onCreateWorkGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateWorkGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCapacityReservation
default CompletableFuture<DeleteCapacityReservationResponse> 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 ofListCapacityReservations
.- Parameters:
deleteCapacityReservationRequest
-- Returns:
- A Java Future containing the result of the DeleteCapacityReservation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCapacityReservation
default CompletableFuture<DeleteCapacityReservationResponse> deleteCapacityReservation(Consumer<DeleteCapacityReservationRequest.Builder> 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 ofListCapacityReservations
.
This is a convenience which creates an instance of the
DeleteCapacityReservationRequest.Builder
avoiding the need to create one manually viaDeleteCapacityReservationRequest.builder()
- Parameters:
deleteCapacityReservationRequest
- AConsumer
that will call methods onDeleteCapacityReservationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteCapacityReservation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDataCatalog
default CompletableFuture<DeleteDataCatalogResponse> deleteDataCatalog(DeleteDataCatalogRequest deleteDataCatalogRequest) Deletes a data catalog.
- Parameters:
deleteDataCatalogRequest
-- Returns:
- A Java Future containing the result of the DeleteDataCatalog operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDataCatalog
default CompletableFuture<DeleteDataCatalogResponse> deleteDataCatalog(Consumer<DeleteDataCatalogRequest.Builder> deleteDataCatalogRequest) Deletes a data catalog.
This is a convenience which creates an instance of the
DeleteDataCatalogRequest.Builder
avoiding the need to create one manually viaDeleteDataCatalogRequest.builder()
- Parameters:
deleteDataCatalogRequest
- AConsumer
that will call methods onDeleteDataCatalogRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDataCatalog operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteNamedQuery
default CompletableFuture<DeleteNamedQueryResponse> deleteNamedQuery(DeleteNamedQueryRequest deleteNamedQueryRequest) Deletes the named query if you have access to the workgroup in which the query was saved.
- Parameters:
deleteNamedQueryRequest
-- Returns:
- A Java Future containing the result of the DeleteNamedQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteNamedQuery
default CompletableFuture<DeleteNamedQueryResponse> deleteNamedQuery(Consumer<DeleteNamedQueryRequest.Builder> deleteNamedQueryRequest) Deletes the named query if you have access to the workgroup in which the query was saved.
This is a convenience which creates an instance of the
DeleteNamedQueryRequest.Builder
avoiding the need to create one manually viaDeleteNamedQueryRequest.builder()
- Parameters:
deleteNamedQueryRequest
- AConsumer
that will call methods onDeleteNamedQueryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteNamedQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteNotebook
default CompletableFuture<DeleteNotebookResponse> deleteNotebook(DeleteNotebookRequest deleteNotebookRequest) Deletes the specified notebook.
- Parameters:
deleteNotebookRequest
-- Returns:
- A Java Future containing the result of the DeleteNotebook operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteNotebook
default CompletableFuture<DeleteNotebookResponse> deleteNotebook(Consumer<DeleteNotebookRequest.Builder> deleteNotebookRequest) Deletes the specified notebook.
This is a convenience which creates an instance of the
DeleteNotebookRequest.Builder
avoiding the need to create one manually viaDeleteNotebookRequest.builder()
- Parameters:
deleteNotebookRequest
- AConsumer
that will call methods onDeleteNotebookRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteNotebook operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePreparedStatement
default CompletableFuture<DeletePreparedStatementResponse> deletePreparedStatement(DeletePreparedStatementRequest deletePreparedStatementRequest) Deletes the prepared statement with the specified name from the specified workgroup.
- Parameters:
deletePreparedStatementRequest
-- Returns:
- A Java Future containing the result of the DeletePreparedStatement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePreparedStatement
default CompletableFuture<DeletePreparedStatementResponse> deletePreparedStatement(Consumer<DeletePreparedStatementRequest.Builder> deletePreparedStatementRequest) Deletes the prepared statement with the specified name from the specified workgroup.
This is a convenience which creates an instance of the
DeletePreparedStatementRequest.Builder
avoiding the need to create one manually viaDeletePreparedStatementRequest.builder()
- Parameters:
deletePreparedStatementRequest
- AConsumer
that will call methods onDeletePreparedStatementRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeletePreparedStatement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteWorkGroup
default CompletableFuture<DeleteWorkGroupResponse> deleteWorkGroup(DeleteWorkGroupRequest deleteWorkGroupRequest) Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.
- Parameters:
deleteWorkGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteWorkGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteWorkGroup
default CompletableFuture<DeleteWorkGroupResponse> deleteWorkGroup(Consumer<DeleteWorkGroupRequest.Builder> deleteWorkGroupRequest) Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.
This is a convenience which creates an instance of the
DeleteWorkGroupRequest.Builder
avoiding the need to create one manually viaDeleteWorkGroupRequest.builder()
- Parameters:
deleteWorkGroupRequest
- AConsumer
that will call methods onDeleteWorkGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteWorkGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
exportNotebook
default CompletableFuture<ExportNotebookResponse> exportNotebook(ExportNotebookRequest exportNotebookRequest) Exports the specified notebook and its metadata.
- Parameters:
exportNotebookRequest
-- Returns:
- A Java Future containing the result of the ExportNotebook operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
exportNotebook
default CompletableFuture<ExportNotebookResponse> exportNotebook(Consumer<ExportNotebookRequest.Builder> exportNotebookRequest) Exports the specified notebook and its metadata.
This is a convenience which creates an instance of the
ExportNotebookRequest.Builder
avoiding the need to create one manually viaExportNotebookRequest.builder()
- Parameters:
exportNotebookRequest
- AConsumer
that will call methods onExportNotebookRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ExportNotebook operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCalculationExecution
default CompletableFuture<GetCalculationExecutionResponse> getCalculationExecution(GetCalculationExecutionRequest getCalculationExecutionRequest) Describes a previously submitted calculation execution.
- Parameters:
getCalculationExecutionRequest
-- Returns:
- A Java Future containing the result of the GetCalculationExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCalculationExecution
default CompletableFuture<GetCalculationExecutionResponse> getCalculationExecution(Consumer<GetCalculationExecutionRequest.Builder> getCalculationExecutionRequest) Describes a previously submitted calculation execution.
This is a convenience which creates an instance of the
GetCalculationExecutionRequest.Builder
avoiding the need to create one manually viaGetCalculationExecutionRequest.builder()
- Parameters:
getCalculationExecutionRequest
- AConsumer
that will call methods onGetCalculationExecutionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetCalculationExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCalculationExecutionCode
default CompletableFuture<GetCalculationExecutionCodeResponse> getCalculationExecutionCode(GetCalculationExecutionCodeRequest getCalculationExecutionCodeRequest) Retrieves the unencrypted code that was executed for the calculation.
- Parameters:
getCalculationExecutionCodeRequest
-- Returns:
- A Java Future containing the result of the GetCalculationExecutionCode operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCalculationExecutionCode
default CompletableFuture<GetCalculationExecutionCodeResponse> getCalculationExecutionCode(Consumer<GetCalculationExecutionCodeRequest.Builder> getCalculationExecutionCodeRequest) Retrieves the unencrypted code that was executed for the calculation.
This is a convenience which creates an instance of the
GetCalculationExecutionCodeRequest.Builder
avoiding the need to create one manually viaGetCalculationExecutionCodeRequest.builder()
- Parameters:
getCalculationExecutionCodeRequest
- AConsumer
that will call methods onGetCalculationExecutionCodeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetCalculationExecutionCode operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCalculationExecutionStatus
default CompletableFuture<GetCalculationExecutionStatusResponse> getCalculationExecutionStatus(GetCalculationExecutionStatusRequest getCalculationExecutionStatusRequest) Gets the status of a current calculation.
- Parameters:
getCalculationExecutionStatusRequest
-- Returns:
- A Java Future containing the result of the GetCalculationExecutionStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCalculationExecutionStatus
default CompletableFuture<GetCalculationExecutionStatusResponse> getCalculationExecutionStatus(Consumer<GetCalculationExecutionStatusRequest.Builder> getCalculationExecutionStatusRequest) Gets the status of a current calculation.
This is a convenience which creates an instance of the
GetCalculationExecutionStatusRequest.Builder
avoiding the need to create one manually viaGetCalculationExecutionStatusRequest.builder()
- Parameters:
getCalculationExecutionStatusRequest
- AConsumer
that will call methods onGetCalculationExecutionStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetCalculationExecutionStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCapacityAssignmentConfiguration
default CompletableFuture<GetCapacityAssignmentConfigurationResponse> getCapacityAssignmentConfiguration(GetCapacityAssignmentConfigurationRequest getCapacityAssignmentConfigurationRequest) Gets the capacity assignment configuration for a capacity reservation, if one exists.
- Parameters:
getCapacityAssignmentConfigurationRequest
-- Returns:
- A Java Future containing the result of the GetCapacityAssignmentConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCapacityAssignmentConfiguration
default CompletableFuture<GetCapacityAssignmentConfigurationResponse> getCapacityAssignmentConfiguration(Consumer<GetCapacityAssignmentConfigurationRequest.Builder> getCapacityAssignmentConfigurationRequest) Gets the capacity assignment configuration for a capacity reservation, if one exists.
This is a convenience which creates an instance of the
GetCapacityAssignmentConfigurationRequest.Builder
avoiding the need to create one manually viaGetCapacityAssignmentConfigurationRequest.builder()
- Parameters:
getCapacityAssignmentConfigurationRequest
- AConsumer
that will call methods onGetCapacityAssignmentConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetCapacityAssignmentConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCapacityReservation
default CompletableFuture<GetCapacityReservationResponse> getCapacityReservation(GetCapacityReservationRequest getCapacityReservationRequest) Returns information about the capacity reservation with the specified name.
- Parameters:
getCapacityReservationRequest
-- Returns:
- A Java Future containing the result of the GetCapacityReservation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCapacityReservation
default CompletableFuture<GetCapacityReservationResponse> getCapacityReservation(Consumer<GetCapacityReservationRequest.Builder> getCapacityReservationRequest) Returns information about the capacity reservation with the specified name.
This is a convenience which creates an instance of the
GetCapacityReservationRequest.Builder
avoiding the need to create one manually viaGetCapacityReservationRequest.builder()
- Parameters:
getCapacityReservationRequest
- AConsumer
that will call methods onGetCapacityReservationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetCapacityReservation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDataCatalog
default CompletableFuture<GetDataCatalogResponse> getDataCatalog(GetDataCatalogRequest getDataCatalogRequest) Returns the specified data catalog.
- Parameters:
getDataCatalogRequest
-- Returns:
- A Java Future containing the result of the GetDataCatalog operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDataCatalog
default CompletableFuture<GetDataCatalogResponse> getDataCatalog(Consumer<GetDataCatalogRequest.Builder> getDataCatalogRequest) Returns the specified data catalog.
This is a convenience which creates an instance of the
GetDataCatalogRequest.Builder
avoiding the need to create one manually viaGetDataCatalogRequest.builder()
- Parameters:
getDataCatalogRequest
- AConsumer
that will call methods onGetDataCatalogRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetDataCatalog operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDatabase
Returns a database object for the specified database and data catalog.
- Parameters:
getDatabaseRequest
-- Returns:
- A Java Future containing the result of the GetDatabase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 Lambda4XX
exception is returned in aMetadataException
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDatabase
default CompletableFuture<GetDatabaseResponse> getDatabase(Consumer<GetDatabaseRequest.Builder> getDatabaseRequest) Returns a database object for the specified database and data catalog.
This is a convenience which creates an instance of the
GetDatabaseRequest.Builder
avoiding the need to create one manually viaGetDatabaseRequest.builder()
- Parameters:
getDatabaseRequest
- AConsumer
that will call methods onGetDatabaseRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetDatabase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 Lambda4XX
exception is returned in aMetadataException
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getNamedQuery
default CompletableFuture<GetNamedQueryResponse> getNamedQuery(GetNamedQueryRequest getNamedQueryRequest) Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.
- Parameters:
getNamedQueryRequest
-- Returns:
- A Java Future containing the result of the GetNamedQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getNamedQuery
default CompletableFuture<GetNamedQueryResponse> getNamedQuery(Consumer<GetNamedQueryRequest.Builder> getNamedQueryRequest) Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.
This is a convenience which creates an instance of the
GetNamedQueryRequest.Builder
avoiding the need to create one manually viaGetNamedQueryRequest.builder()
- Parameters:
getNamedQueryRequest
- AConsumer
that will call methods onGetNamedQueryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetNamedQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getNotebookMetadata
default CompletableFuture<GetNotebookMetadataResponse> getNotebookMetadata(GetNotebookMetadataRequest getNotebookMetadataRequest) Retrieves notebook metadata for the specified notebook ID.
- Parameters:
getNotebookMetadataRequest
-- Returns:
- A Java Future containing the result of the GetNotebookMetadata operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getNotebookMetadata
default CompletableFuture<GetNotebookMetadataResponse> getNotebookMetadata(Consumer<GetNotebookMetadataRequest.Builder> getNotebookMetadataRequest) Retrieves notebook metadata for the specified notebook ID.
This is a convenience which creates an instance of the
GetNotebookMetadataRequest.Builder
avoiding the need to create one manually viaGetNotebookMetadataRequest.builder()
- Parameters:
getNotebookMetadataRequest
- AConsumer
that will call methods onGetNotebookMetadataRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetNotebookMetadata operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPreparedStatement
default CompletableFuture<GetPreparedStatementResponse> getPreparedStatement(GetPreparedStatementRequest getPreparedStatementRequest) Retrieves the prepared statement with the specified name from the specified workgroup.
- Parameters:
getPreparedStatementRequest
-- Returns:
- A Java Future containing the result of the GetPreparedStatement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPreparedStatement
default CompletableFuture<GetPreparedStatementResponse> getPreparedStatement(Consumer<GetPreparedStatementRequest.Builder> getPreparedStatementRequest) Retrieves the prepared statement with the specified name from the specified workgroup.
This is a convenience which creates an instance of the
GetPreparedStatementRequest.Builder
avoiding the need to create one manually viaGetPreparedStatementRequest.builder()
- Parameters:
getPreparedStatementRequest
- AConsumer
that will call methods onGetPreparedStatementRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetPreparedStatement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getQueryExecution
default CompletableFuture<GetQueryExecutionResponse> 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.
- Parameters:
getQueryExecutionRequest
-- Returns:
- A Java Future containing the result of the GetQueryExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getQueryExecution
default CompletableFuture<GetQueryExecutionResponse> getQueryExecution(Consumer<GetQueryExecutionRequest.Builder> 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.
This is a convenience which creates an instance of the
GetQueryExecutionRequest.Builder
avoiding the need to create one manually viaGetQueryExecutionRequest.builder()
- Parameters:
getQueryExecutionRequest
- AConsumer
that will call methods onGetQueryExecutionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetQueryExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getQueryResults
default CompletableFuture<GetQueryResultsResponse> 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 S3GetObject
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 theGetQueryResults
action is denied. To restrict user or role access, ensure that Amazon S3 permissions to the Athena query location are denied.- Parameters:
getQueryResultsRequest
-- Returns:
- A Java Future containing the result of the GetQueryResults operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getQueryResults
default CompletableFuture<GetQueryResultsResponse> getQueryResults(Consumer<GetQueryResultsRequest.Builder> 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 S3GetObject
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 theGetQueryResults
action is denied. To restrict user or role access, ensure that Amazon S3 permissions to the Athena query location are denied.
This is a convenience which creates an instance of the
GetQueryResultsRequest.Builder
avoiding the need to create one manually viaGetQueryResultsRequest.builder()
- Parameters:
getQueryResultsRequest
- AConsumer
that will call methods onGetQueryResultsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetQueryResults operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getQueryResultsPaginator
default GetQueryResultsPublisher getQueryResultsPaginator(GetQueryResultsRequest getQueryResultsRequest) This is a variant of
getQueryResults(software.amazon.awssdk.services.athena.model.GetQueryResultsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.GetQueryResultsPublisher publisher = client.getQueryResultsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.GetQueryResultsPublisher publisher = client.getQueryResultsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.GetQueryResultsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.GetQueryResultsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getQueryResults(software.amazon.awssdk.services.athena.model.GetQueryResultsRequest)
operation.- Parameters:
getQueryResultsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getQueryResultsPaginator
default GetQueryResultsPublisher getQueryResultsPaginator(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest) This is a variant of
getQueryResults(software.amazon.awssdk.services.athena.model.GetQueryResultsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.GetQueryResultsPublisher publisher = client.getQueryResultsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.GetQueryResultsPublisher publisher = client.getQueryResultsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.GetQueryResultsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.GetQueryResultsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getQueryResults(software.amazon.awssdk.services.athena.model.GetQueryResultsRequest)
operation.
This is a convenience which creates an instance of the
GetQueryResultsRequest.Builder
avoiding the need to create one manually viaGetQueryResultsRequest.builder()
- Parameters:
getQueryResultsRequest
- AConsumer
that will call methods onGetQueryResultsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getQueryRuntimeStatistics
default CompletableFuture<GetQueryRuntimeStatisticsResponse> 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 QueryExecutionStatusinvalid input: '$'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.
- Parameters:
getQueryRuntimeStatisticsRequest
-- Returns:
- A Java Future containing the result of the GetQueryRuntimeStatistics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getQueryRuntimeStatistics
default CompletableFuture<GetQueryRuntimeStatisticsResponse> getQueryRuntimeStatistics(Consumer<GetQueryRuntimeStatisticsRequest.Builder> 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 QueryExecutionStatusinvalid input: '$'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.
This is a convenience which creates an instance of the
GetQueryRuntimeStatisticsRequest.Builder
avoiding the need to create one manually viaGetQueryRuntimeStatisticsRequest.builder()
- Parameters:
getQueryRuntimeStatisticsRequest
- AConsumer
that will call methods onGetQueryRuntimeStatisticsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetQueryRuntimeStatistics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSession
Gets the full details of a previously created session, including the session status and configuration.
- Parameters:
getSessionRequest
-- Returns:
- A Java Future containing the result of the GetSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSession
default CompletableFuture<GetSessionResponse> getSession(Consumer<GetSessionRequest.Builder> getSessionRequest) Gets the full details of a previously created session, including the session status and configuration.
This is a convenience which creates an instance of the
GetSessionRequest.Builder
avoiding the need to create one manually viaGetSessionRequest.builder()
- Parameters:
getSessionRequest
- AConsumer
that will call methods onGetSessionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSessionStatus
default CompletableFuture<GetSessionStatusResponse> getSessionStatus(GetSessionStatusRequest getSessionStatusRequest) Gets the current status of a session.
- Parameters:
getSessionStatusRequest
-- Returns:
- A Java Future containing the result of the GetSessionStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSessionStatus
default CompletableFuture<GetSessionStatusResponse> getSessionStatus(Consumer<GetSessionStatusRequest.Builder> getSessionStatusRequest) Gets the current status of a session.
This is a convenience which creates an instance of the
GetSessionStatusRequest.Builder
avoiding the need to create one manually viaGetSessionStatusRequest.builder()
- Parameters:
getSessionStatusRequest
- AConsumer
that will call methods onGetSessionStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSessionStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTableMetadata
default CompletableFuture<GetTableMetadataResponse> getTableMetadata(GetTableMetadataRequest getTableMetadataRequest) Returns table metadata for the specified catalog, database, and table.
- Parameters:
getTableMetadataRequest
-- Returns:
- A Java Future containing the result of the GetTableMetadata operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 Lambda4XX
exception is returned in aMetadataException
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTableMetadata
default CompletableFuture<GetTableMetadataResponse> getTableMetadata(Consumer<GetTableMetadataRequest.Builder> getTableMetadataRequest) Returns table metadata for the specified catalog, database, and table.
This is a convenience which creates an instance of the
GetTableMetadataRequest.Builder
avoiding the need to create one manually viaGetTableMetadataRequest.builder()
- Parameters:
getTableMetadataRequest
- AConsumer
that will call methods onGetTableMetadataRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetTableMetadata operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 Lambda4XX
exception is returned in aMetadataException
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getWorkGroup
default CompletableFuture<GetWorkGroupResponse> getWorkGroup(GetWorkGroupRequest getWorkGroupRequest) Returns information about the workgroup with the specified name.
- Parameters:
getWorkGroupRequest
-- Returns:
- A Java Future containing the result of the GetWorkGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getWorkGroup
default CompletableFuture<GetWorkGroupResponse> getWorkGroup(Consumer<GetWorkGroupRequest.Builder> getWorkGroupRequest) Returns information about the workgroup with the specified name.
This is a convenience which creates an instance of the
GetWorkGroupRequest.Builder
avoiding the need to create one manually viaGetWorkGroupRequest.builder()
- Parameters:
getWorkGroupRequest
- AConsumer
that will call methods onGetWorkGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetWorkGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
importNotebook
default CompletableFuture<ImportNotebookResponse> importNotebook(ImportNotebookRequest importNotebookRequest) Imports a single
ipynb
file to a Spark enabled workgroup. To import the notebook, the request must specify a value for eitherPayload
orNoteBookS3LocationUri
. If neither is specified or both are specified, anInvalidRequestException
occurs. The maximum file size that can be imported is 10 megabytes. If anipynb
file with the same name already exists in the workgroup, throws an error.- Parameters:
importNotebookRequest
-- Returns:
- A Java Future containing the result of the ImportNotebook operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
importNotebook
default CompletableFuture<ImportNotebookResponse> importNotebook(Consumer<ImportNotebookRequest.Builder> importNotebookRequest) Imports a single
ipynb
file to a Spark enabled workgroup. To import the notebook, the request must specify a value for eitherPayload
orNoteBookS3LocationUri
. If neither is specified or both are specified, anInvalidRequestException
occurs. The maximum file size that can be imported is 10 megabytes. If anipynb
file with the same name already exists in the workgroup, throws an error.
This is a convenience which creates an instance of the
ImportNotebookRequest.Builder
avoiding the need to create one manually viaImportNotebookRequest.builder()
- Parameters:
importNotebookRequest
- AConsumer
that will call methods onImportNotebookRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ImportNotebook operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationDPUSizes
default CompletableFuture<ListApplicationDpuSizesResponse> listApplicationDPUSizes(ListApplicationDpuSizesRequest listApplicationDpuSizesRequest) Returns the supported DPU sizes for the supported application runtimes (for example,
Athena notebook version 1
).- Parameters:
listApplicationDpuSizesRequest
-- Returns:
- A Java Future containing the result of the ListApplicationDPUSizes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationDPUSizes
default CompletableFuture<ListApplicationDpuSizesResponse> listApplicationDPUSizes(Consumer<ListApplicationDpuSizesRequest.Builder> listApplicationDpuSizesRequest) Returns the supported DPU sizes for the supported application runtimes (for example,
Athena notebook version 1
).
This is a convenience which creates an instance of the
ListApplicationDpuSizesRequest.Builder
avoiding the need to create one manually viaListApplicationDpuSizesRequest.builder()
- Parameters:
listApplicationDpuSizesRequest
- AConsumer
that will call methods onListApplicationDpuSizesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListApplicationDPUSizes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationDPUSizesPaginator
default ListApplicationDPUSizesPublisher listApplicationDPUSizesPaginator(ListApplicationDpuSizesRequest listApplicationDpuSizesRequest) This is a variant of
listApplicationDPUSizes(software.amazon.awssdk.services.athena.model.ListApplicationDpuSizesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListApplicationDPUSizesPublisher publisher = client.listApplicationDPUSizesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListApplicationDPUSizesPublisher publisher = client.listApplicationDPUSizesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListApplicationDpuSizesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListApplicationDpuSizesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplicationDPUSizes(software.amazon.awssdk.services.athena.model.ListApplicationDpuSizesRequest)
operation.- Parameters:
listApplicationDpuSizesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationDPUSizesPaginator
default ListApplicationDPUSizesPublisher listApplicationDPUSizesPaginator(Consumer<ListApplicationDpuSizesRequest.Builder> listApplicationDpuSizesRequest) This is a variant of
listApplicationDPUSizes(software.amazon.awssdk.services.athena.model.ListApplicationDpuSizesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListApplicationDPUSizesPublisher publisher = client.listApplicationDPUSizesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListApplicationDPUSizesPublisher publisher = client.listApplicationDPUSizesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListApplicationDpuSizesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListApplicationDpuSizesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApplicationDPUSizes(software.amazon.awssdk.services.athena.model.ListApplicationDpuSizesRequest)
operation.
This is a convenience which creates an instance of the
ListApplicationDpuSizesRequest.Builder
avoiding the need to create one manually viaListApplicationDpuSizesRequest.builder()
- Parameters:
listApplicationDpuSizesRequest
- AConsumer
that will call methods onListApplicationDpuSizesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCalculationExecutions
default CompletableFuture<ListCalculationExecutionsResponse> 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.
- Parameters:
listCalculationExecutionsRequest
-- Returns:
- A Java Future containing the result of the ListCalculationExecutions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCalculationExecutions
default CompletableFuture<ListCalculationExecutionsResponse> listCalculationExecutions(Consumer<ListCalculationExecutionsRequest.Builder> listCalculationExecutionsRequest) Lists the calculations that have been submitted to a session in descending order. Newer calculations are listed first; older calculations are listed later.
This is a convenience which creates an instance of the
ListCalculationExecutionsRequest.Builder
avoiding the need to create one manually viaListCalculationExecutionsRequest.builder()
- Parameters:
listCalculationExecutionsRequest
- AConsumer
that will call methods onListCalculationExecutionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListCalculationExecutions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCalculationExecutionsPaginator
default ListCalculationExecutionsPublisher listCalculationExecutionsPaginator(ListCalculationExecutionsRequest listCalculationExecutionsRequest) This is a variant of
listCalculationExecutions(software.amazon.awssdk.services.athena.model.ListCalculationExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListCalculationExecutionsPublisher publisher = client.listCalculationExecutionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListCalculationExecutionsPublisher publisher = client.listCalculationExecutionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListCalculationExecutionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListCalculationExecutionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCalculationExecutions(software.amazon.awssdk.services.athena.model.ListCalculationExecutionsRequest)
operation.- Parameters:
listCalculationExecutionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCalculationExecutionsPaginator
default ListCalculationExecutionsPublisher listCalculationExecutionsPaginator(Consumer<ListCalculationExecutionsRequest.Builder> listCalculationExecutionsRequest) This is a variant of
listCalculationExecutions(software.amazon.awssdk.services.athena.model.ListCalculationExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListCalculationExecutionsPublisher publisher = client.listCalculationExecutionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListCalculationExecutionsPublisher publisher = client.listCalculationExecutionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListCalculationExecutionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListCalculationExecutionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCalculationExecutions(software.amazon.awssdk.services.athena.model.ListCalculationExecutionsRequest)
operation.
This is a convenience which creates an instance of the
ListCalculationExecutionsRequest.Builder
avoiding the need to create one manually viaListCalculationExecutionsRequest.builder()
- Parameters:
listCalculationExecutionsRequest
- AConsumer
that will call methods onListCalculationExecutionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCapacityReservations
default CompletableFuture<ListCapacityReservationsResponse> listCapacityReservations(ListCapacityReservationsRequest listCapacityReservationsRequest) Lists the capacity reservations for the current account.
- Parameters:
listCapacityReservationsRequest
-- Returns:
- A Java Future containing the result of the ListCapacityReservations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCapacityReservations
default CompletableFuture<ListCapacityReservationsResponse> listCapacityReservations(Consumer<ListCapacityReservationsRequest.Builder> listCapacityReservationsRequest) Lists the capacity reservations for the current account.
This is a convenience which creates an instance of the
ListCapacityReservationsRequest.Builder
avoiding the need to create one manually viaListCapacityReservationsRequest.builder()
- Parameters:
listCapacityReservationsRequest
- AConsumer
that will call methods onListCapacityReservationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListCapacityReservations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCapacityReservationsPaginator
default ListCapacityReservationsPublisher listCapacityReservationsPaginator(ListCapacityReservationsRequest listCapacityReservationsRequest) This is a variant of
listCapacityReservations(software.amazon.awssdk.services.athena.model.ListCapacityReservationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListCapacityReservationsPublisher publisher = client.listCapacityReservationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListCapacityReservationsPublisher publisher = client.listCapacityReservationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListCapacityReservationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListCapacityReservationsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCapacityReservations(software.amazon.awssdk.services.athena.model.ListCapacityReservationsRequest)
operation.- Parameters:
listCapacityReservationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCapacityReservationsPaginator
default ListCapacityReservationsPublisher listCapacityReservationsPaginator(Consumer<ListCapacityReservationsRequest.Builder> listCapacityReservationsRequest) This is a variant of
listCapacityReservations(software.amazon.awssdk.services.athena.model.ListCapacityReservationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListCapacityReservationsPublisher publisher = client.listCapacityReservationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListCapacityReservationsPublisher publisher = client.listCapacityReservationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListCapacityReservationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListCapacityReservationsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCapacityReservations(software.amazon.awssdk.services.athena.model.ListCapacityReservationsRequest)
operation.
This is a convenience which creates an instance of the
ListCapacityReservationsRequest.Builder
avoiding the need to create one manually viaListCapacityReservationsRequest.builder()
- Parameters:
listCapacityReservationsRequest
- AConsumer
that will call methods onListCapacityReservationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataCatalogs
default CompletableFuture<ListDataCatalogsResponse> 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.
- Parameters:
listDataCatalogsRequest
-- Returns:
- A Java Future containing the result of the ListDataCatalogs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataCatalogs
default CompletableFuture<ListDataCatalogsResponse> listDataCatalogs(Consumer<ListDataCatalogsRequest.Builder> 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.
This is a convenience which creates an instance of the
ListDataCatalogsRequest.Builder
avoiding the need to create one manually viaListDataCatalogsRequest.builder()
- Parameters:
listDataCatalogsRequest
- AConsumer
that will call methods onListDataCatalogsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDataCatalogs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataCatalogsPaginator
default ListDataCatalogsPublisher listDataCatalogsPaginator(ListDataCatalogsRequest listDataCatalogsRequest) This is a variant of
listDataCatalogs(software.amazon.awssdk.services.athena.model.ListDataCatalogsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListDataCatalogsPublisher publisher = client.listDataCatalogsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListDataCatalogsPublisher publisher = client.listDataCatalogsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListDataCatalogsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListDataCatalogsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataCatalogs(software.amazon.awssdk.services.athena.model.ListDataCatalogsRequest)
operation.- Parameters:
listDataCatalogsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataCatalogsPaginator
default ListDataCatalogsPublisher listDataCatalogsPaginator(Consumer<ListDataCatalogsRequest.Builder> listDataCatalogsRequest) This is a variant of
listDataCatalogs(software.amazon.awssdk.services.athena.model.ListDataCatalogsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListDataCatalogsPublisher publisher = client.listDataCatalogsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListDataCatalogsPublisher publisher = client.listDataCatalogsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListDataCatalogsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListDataCatalogsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataCatalogs(software.amazon.awssdk.services.athena.model.ListDataCatalogsRequest)
operation.
This is a convenience which creates an instance of the
ListDataCatalogsRequest.Builder
avoiding the need to create one manually viaListDataCatalogsRequest.builder()
- Parameters:
listDataCatalogsRequest
- AConsumer
that will call methods onListDataCatalogsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatabases
default CompletableFuture<ListDatabasesResponse> listDatabases(ListDatabasesRequest listDatabasesRequest) Lists the databases in the specified data catalog.
- Parameters:
listDatabasesRequest
-- Returns:
- A Java Future containing the result of the ListDatabases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 Lambda4XX
exception is returned in aMetadataException
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatabases
default CompletableFuture<ListDatabasesResponse> listDatabases(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest) Lists the databases in the specified data catalog.
This is a convenience which creates an instance of the
ListDatabasesRequest.Builder
avoiding the need to create one manually viaListDatabasesRequest.builder()
- Parameters:
listDatabasesRequest
- AConsumer
that will call methods onListDatabasesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDatabases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 Lambda4XX
exception is returned in aMetadataException
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatabasesPaginator
This is a variant of
listDatabases(software.amazon.awssdk.services.athena.model.ListDatabasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListDatabasesPublisher publisher = client.listDatabasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListDatabasesPublisher publisher = client.listDatabasesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListDatabasesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListDatabasesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatabases(software.amazon.awssdk.services.athena.model.ListDatabasesRequest)
operation.- Parameters:
listDatabasesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 Lambda4XX
exception is returned in aMetadataException
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatabasesPaginator
default ListDatabasesPublisher listDatabasesPaginator(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest) This is a variant of
listDatabases(software.amazon.awssdk.services.athena.model.ListDatabasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListDatabasesPublisher publisher = client.listDatabasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListDatabasesPublisher publisher = client.listDatabasesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListDatabasesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListDatabasesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatabases(software.amazon.awssdk.services.athena.model.ListDatabasesRequest)
operation.
This is a convenience which creates an instance of the
ListDatabasesRequest.Builder
avoiding the need to create one manually viaListDatabasesRequest.builder()
- Parameters:
listDatabasesRequest
- AConsumer
that will call methods onListDatabasesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 Lambda4XX
exception is returned in aMetadataException
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEngineVersions
default CompletableFuture<ListEngineVersionsResponse> listEngineVersions(ListEngineVersionsRequest listEngineVersionsRequest) Returns a list of engine versions that are available to choose from, including the Auto option.
- Parameters:
listEngineVersionsRequest
-- Returns:
- A Java Future containing the result of the ListEngineVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEngineVersions
default CompletableFuture<ListEngineVersionsResponse> listEngineVersions(Consumer<ListEngineVersionsRequest.Builder> listEngineVersionsRequest) Returns a list of engine versions that are available to choose from, including the Auto option.
This is a convenience which creates an instance of the
ListEngineVersionsRequest.Builder
avoiding the need to create one manually viaListEngineVersionsRequest.builder()
- Parameters:
listEngineVersionsRequest
- AConsumer
that will call methods onListEngineVersionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListEngineVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEngineVersionsPaginator
default ListEngineVersionsPublisher listEngineVersionsPaginator(ListEngineVersionsRequest listEngineVersionsRequest) This is a variant of
listEngineVersions(software.amazon.awssdk.services.athena.model.ListEngineVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListEngineVersionsPublisher publisher = client.listEngineVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListEngineVersionsPublisher publisher = client.listEngineVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListEngineVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListEngineVersionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEngineVersions(software.amazon.awssdk.services.athena.model.ListEngineVersionsRequest)
operation.- Parameters:
listEngineVersionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEngineVersionsPaginator
default ListEngineVersionsPublisher listEngineVersionsPaginator(Consumer<ListEngineVersionsRequest.Builder> listEngineVersionsRequest) This is a variant of
listEngineVersions(software.amazon.awssdk.services.athena.model.ListEngineVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListEngineVersionsPublisher publisher = client.listEngineVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListEngineVersionsPublisher publisher = client.listEngineVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListEngineVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListEngineVersionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEngineVersions(software.amazon.awssdk.services.athena.model.ListEngineVersionsRequest)
operation.
This is a convenience which creates an instance of the
ListEngineVersionsRequest.Builder
avoiding the need to create one manually viaListEngineVersionsRequest.builder()
- Parameters:
listEngineVersionsRequest
- AConsumer
that will call methods onListEngineVersionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listExecutors
default CompletableFuture<ListExecutorsResponse> 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.
- Parameters:
listExecutorsRequest
-- Returns:
- A Java Future containing the result of the ListExecutors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listExecutors
default CompletableFuture<ListExecutorsResponse> listExecutors(Consumer<ListExecutorsRequest.Builder> 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.
This is a convenience which creates an instance of the
ListExecutorsRequest.Builder
avoiding the need to create one manually viaListExecutorsRequest.builder()
- Parameters:
listExecutorsRequest
- AConsumer
that will call methods onListExecutorsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListExecutors operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listExecutorsPaginator
This is a variant of
listExecutors(software.amazon.awssdk.services.athena.model.ListExecutorsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListExecutorsPublisher publisher = client.listExecutorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListExecutorsPublisher publisher = client.listExecutorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListExecutorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListExecutorsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExecutors(software.amazon.awssdk.services.athena.model.ListExecutorsRequest)
operation.- Parameters:
listExecutorsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listExecutorsPaginator
default ListExecutorsPublisher listExecutorsPaginator(Consumer<ListExecutorsRequest.Builder> listExecutorsRequest) This is a variant of
listExecutors(software.amazon.awssdk.services.athena.model.ListExecutorsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListExecutorsPublisher publisher = client.listExecutorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListExecutorsPublisher publisher = client.listExecutorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListExecutorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListExecutorsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExecutors(software.amazon.awssdk.services.athena.model.ListExecutorsRequest)
operation.
This is a convenience which creates an instance of the
ListExecutorsRequest.Builder
avoiding the need to create one manually viaListExecutorsRequest.builder()
- Parameters:
listExecutorsRequest
- AConsumer
that will call methods onListExecutorsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNamedQueries
default CompletableFuture<ListNamedQueriesResponse> 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.
- Parameters:
listNamedQueriesRequest
-- Returns:
- A Java Future containing the result of the ListNamedQueries operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNamedQueries
default CompletableFuture<ListNamedQueriesResponse> listNamedQueries(Consumer<ListNamedQueriesRequest.Builder> 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.
This is a convenience which creates an instance of the
ListNamedQueriesRequest.Builder
avoiding the need to create one manually viaListNamedQueriesRequest.builder()
- Parameters:
listNamedQueriesRequest
- AConsumer
that will call methods onListNamedQueriesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListNamedQueries operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNamedQueries
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.
- Returns:
- A Java Future containing the result of the ListNamedQueries operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNamedQueriesPaginator
This is a variant of
listNamedQueries(software.amazon.awssdk.services.athena.model.ListNamedQueriesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListNamedQueriesPublisher publisher = client.listNamedQueriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListNamedQueriesPublisher publisher = client.listNamedQueriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListNamedQueriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListNamedQueriesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNamedQueries(software.amazon.awssdk.services.athena.model.ListNamedQueriesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNamedQueriesPaginator
default ListNamedQueriesPublisher listNamedQueriesPaginator(ListNamedQueriesRequest listNamedQueriesRequest) This is a variant of
listNamedQueries(software.amazon.awssdk.services.athena.model.ListNamedQueriesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListNamedQueriesPublisher publisher = client.listNamedQueriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListNamedQueriesPublisher publisher = client.listNamedQueriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListNamedQueriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListNamedQueriesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNamedQueries(software.amazon.awssdk.services.athena.model.ListNamedQueriesRequest)
operation.- Parameters:
listNamedQueriesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNamedQueriesPaginator
default ListNamedQueriesPublisher listNamedQueriesPaginator(Consumer<ListNamedQueriesRequest.Builder> listNamedQueriesRequest) This is a variant of
listNamedQueries(software.amazon.awssdk.services.athena.model.ListNamedQueriesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListNamedQueriesPublisher publisher = client.listNamedQueriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListNamedQueriesPublisher publisher = client.listNamedQueriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListNamedQueriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListNamedQueriesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNamedQueries(software.amazon.awssdk.services.athena.model.ListNamedQueriesRequest)
operation.
This is a convenience which creates an instance of the
ListNamedQueriesRequest.Builder
avoiding the need to create one manually viaListNamedQueriesRequest.builder()
- Parameters:
listNamedQueriesRequest
- AConsumer
that will call methods onListNamedQueriesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNotebookMetadata
default CompletableFuture<ListNotebookMetadataResponse> listNotebookMetadata(ListNotebookMetadataRequest listNotebookMetadataRequest) Displays the notebook files for the specified workgroup in paginated format.
- Parameters:
listNotebookMetadataRequest
-- Returns:
- A Java Future containing the result of the ListNotebookMetadata operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNotebookMetadata
default CompletableFuture<ListNotebookMetadataResponse> listNotebookMetadata(Consumer<ListNotebookMetadataRequest.Builder> listNotebookMetadataRequest) Displays the notebook files for the specified workgroup in paginated format.
This is a convenience which creates an instance of the
ListNotebookMetadataRequest.Builder
avoiding the need to create one manually viaListNotebookMetadataRequest.builder()
- Parameters:
listNotebookMetadataRequest
- AConsumer
that will call methods onListNotebookMetadataRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListNotebookMetadata operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNotebookSessions
default CompletableFuture<ListNotebookSessionsResponse> 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
orBUSY
. Newer sessions are listed first; older sessions are listed later.- Parameters:
listNotebookSessionsRequest
-- Returns:
- A Java Future containing the result of the ListNotebookSessions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listNotebookSessions
default CompletableFuture<ListNotebookSessionsResponse> listNotebookSessions(Consumer<ListNotebookSessionsRequest.Builder> listNotebookSessionsRequest) Lists, in descending order, the sessions that have been created in a notebook that are in an active state like
CREATING
,CREATED
,IDLE
orBUSY
. Newer sessions are listed first; older sessions are listed later.
This is a convenience which creates an instance of the
ListNotebookSessionsRequest.Builder
avoiding the need to create one manually viaListNotebookSessionsRequest.builder()
- Parameters:
listNotebookSessionsRequest
- AConsumer
that will call methods onListNotebookSessionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListNotebookSessions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPreparedStatements
default CompletableFuture<ListPreparedStatementsResponse> listPreparedStatements(ListPreparedStatementsRequest listPreparedStatementsRequest) Lists the prepared statements in the specified workgroup.
- Parameters:
listPreparedStatementsRequest
-- Returns:
- A Java Future containing the result of the ListPreparedStatements operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPreparedStatements
default CompletableFuture<ListPreparedStatementsResponse> listPreparedStatements(Consumer<ListPreparedStatementsRequest.Builder> listPreparedStatementsRequest) Lists the prepared statements in the specified workgroup.
This is a convenience which creates an instance of the
ListPreparedStatementsRequest.Builder
avoiding the need to create one manually viaListPreparedStatementsRequest.builder()
- Parameters:
listPreparedStatementsRequest
- AConsumer
that will call methods onListPreparedStatementsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPreparedStatements operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPreparedStatementsPaginator
default ListPreparedStatementsPublisher listPreparedStatementsPaginator(ListPreparedStatementsRequest listPreparedStatementsRequest) This is a variant of
listPreparedStatements(software.amazon.awssdk.services.athena.model.ListPreparedStatementsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListPreparedStatementsPublisher publisher = client.listPreparedStatementsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListPreparedStatementsPublisher publisher = client.listPreparedStatementsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListPreparedStatementsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListPreparedStatementsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPreparedStatements(software.amazon.awssdk.services.athena.model.ListPreparedStatementsRequest)
operation.- Parameters:
listPreparedStatementsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPreparedStatementsPaginator
default ListPreparedStatementsPublisher listPreparedStatementsPaginator(Consumer<ListPreparedStatementsRequest.Builder> listPreparedStatementsRequest) This is a variant of
listPreparedStatements(software.amazon.awssdk.services.athena.model.ListPreparedStatementsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListPreparedStatementsPublisher publisher = client.listPreparedStatementsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListPreparedStatementsPublisher publisher = client.listPreparedStatementsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListPreparedStatementsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListPreparedStatementsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPreparedStatements(software.amazon.awssdk.services.athena.model.ListPreparedStatementsRequest)
operation.
This is a convenience which creates an instance of the
ListPreparedStatementsRequest.Builder
avoiding the need to create one manually viaListPreparedStatementsRequest.builder()
- Parameters:
listPreparedStatementsRequest
- AConsumer
that will call methods onListPreparedStatementsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listQueryExecutions
default CompletableFuture<ListQueryExecutionsResponse> listQueryExecutions(ListQueryExecutionsRequest listQueryExecutionsRequest) Provides a list of available query execution IDs for the queries in the specified workgroup. Athena keeps a query history for 45 days. If a workgroup is not specified, returns a list of query execution IDs for the primary workgroup. Requires you to have access to the workgroup in which the queries ran.
- Parameters:
listQueryExecutionsRequest
-- Returns:
- A Java Future containing the result of the ListQueryExecutions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listQueryExecutions
default CompletableFuture<ListQueryExecutionsResponse> listQueryExecutions(Consumer<ListQueryExecutionsRequest.Builder> listQueryExecutionsRequest) Provides a list of available query execution IDs for the queries in the specified workgroup. Athena keeps a query history for 45 days. If a workgroup is not specified, returns a list of query execution IDs for the primary workgroup. Requires you to have access to the workgroup in which the queries ran.
This is a convenience which creates an instance of the
ListQueryExecutionsRequest.Builder
avoiding the need to create one manually viaListQueryExecutionsRequest.builder()
- Parameters:
listQueryExecutionsRequest
- AConsumer
that will call methods onListQueryExecutionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListQueryExecutions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listQueryExecutions
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.
- Returns:
- A Java Future containing the result of the ListQueryExecutions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listQueryExecutionsPaginator
This is a variant of
listQueryExecutions(software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListQueryExecutionsPublisher publisher = client.listQueryExecutionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListQueryExecutionsPublisher publisher = client.listQueryExecutionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListQueryExecutionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListQueryExecutionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQueryExecutions(software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listQueryExecutionsPaginator
default ListQueryExecutionsPublisher listQueryExecutionsPaginator(ListQueryExecutionsRequest listQueryExecutionsRequest) This is a variant of
listQueryExecutions(software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListQueryExecutionsPublisher publisher = client.listQueryExecutionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListQueryExecutionsPublisher publisher = client.listQueryExecutionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListQueryExecutionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListQueryExecutionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQueryExecutions(software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest)
operation.- Parameters:
listQueryExecutionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listQueryExecutionsPaginator
default ListQueryExecutionsPublisher listQueryExecutionsPaginator(Consumer<ListQueryExecutionsRequest.Builder> listQueryExecutionsRequest) This is a variant of
listQueryExecutions(software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListQueryExecutionsPublisher publisher = client.listQueryExecutionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListQueryExecutionsPublisher publisher = client.listQueryExecutionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListQueryExecutionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListQueryExecutionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQueryExecutions(software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest)
operation.
This is a convenience which creates an instance of the
ListQueryExecutionsRequest.Builder
avoiding the need to create one manually viaListQueryExecutionsRequest.builder()
- Parameters:
listQueryExecutionsRequest
- AConsumer
that will call methods onListQueryExecutionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSessions
default CompletableFuture<ListSessionsResponse> listSessions(ListSessionsRequest listSessionsRequest) Lists the sessions in a workgroup that are in an active state like
CREATING
,CREATED
,IDLE
, orBUSY
. Newer sessions are listed first; older sessions are listed later.- Parameters:
listSessionsRequest
-- Returns:
- A Java Future containing the result of the ListSessions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSessions
default CompletableFuture<ListSessionsResponse> listSessions(Consumer<ListSessionsRequest.Builder> listSessionsRequest) Lists the sessions in a workgroup that are in an active state like
CREATING
,CREATED
,IDLE
, orBUSY
. Newer sessions are listed first; older sessions are listed later.
This is a convenience which creates an instance of the
ListSessionsRequest.Builder
avoiding the need to create one manually viaListSessionsRequest.builder()
- Parameters:
listSessionsRequest
- AConsumer
that will call methods onListSessionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSessions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSessionsPaginator
This is a variant of
listSessions(software.amazon.awssdk.services.athena.model.ListSessionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListSessionsPublisher publisher = client.listSessionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListSessionsPublisher publisher = client.listSessionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListSessionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListSessionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSessions(software.amazon.awssdk.services.athena.model.ListSessionsRequest)
operation.- Parameters:
listSessionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSessionsPaginator
default ListSessionsPublisher listSessionsPaginator(Consumer<ListSessionsRequest.Builder> listSessionsRequest) This is a variant of
listSessions(software.amazon.awssdk.services.athena.model.ListSessionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListSessionsPublisher publisher = client.listSessionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListSessionsPublisher publisher = client.listSessionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListSessionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListSessionsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSessions(software.amazon.awssdk.services.athena.model.ListSessionsRequest)
operation.
This is a convenience which creates an instance of the
ListSessionsRequest.Builder
avoiding the need to create one manually viaListSessionsRequest.builder()
- Parameters:
listSessionsRequest
- AConsumer
that will call methods onListSessionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTableMetadata
default CompletableFuture<ListTableMetadataResponse> listTableMetadata(ListTableMetadataRequest listTableMetadataRequest) Lists the metadata for the tables in the specified data catalog database.
- Parameters:
listTableMetadataRequest
-- Returns:
- A Java Future containing the result of the ListTableMetadata operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 Lambda4XX
exception is returned in aMetadataException
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTableMetadata
default CompletableFuture<ListTableMetadataResponse> listTableMetadata(Consumer<ListTableMetadataRequest.Builder> listTableMetadataRequest) Lists the metadata for the tables in the specified data catalog database.
This is a convenience which creates an instance of the
ListTableMetadataRequest.Builder
avoiding the need to create one manually viaListTableMetadataRequest.builder()
- Parameters:
listTableMetadataRequest
- AConsumer
that will call methods onListTableMetadataRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTableMetadata operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 Lambda4XX
exception is returned in aMetadataException
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTableMetadataPaginator
default ListTableMetadataPublisher listTableMetadataPaginator(ListTableMetadataRequest listTableMetadataRequest) This is a variant of
listTableMetadata(software.amazon.awssdk.services.athena.model.ListTableMetadataRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListTableMetadataPublisher publisher = client.listTableMetadataPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListTableMetadataPublisher publisher = client.listTableMetadataPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListTableMetadataResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListTableMetadataResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTableMetadata(software.amazon.awssdk.services.athena.model.ListTableMetadataRequest)
operation.- Parameters:
listTableMetadataRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 Lambda4XX
exception is returned in aMetadataException
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTableMetadataPaginator
default ListTableMetadataPublisher listTableMetadataPaginator(Consumer<ListTableMetadataRequest.Builder> listTableMetadataRequest) This is a variant of
listTableMetadata(software.amazon.awssdk.services.athena.model.ListTableMetadataRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListTableMetadataPublisher publisher = client.listTableMetadataPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListTableMetadataPublisher publisher = client.listTableMetadataPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListTableMetadataResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListTableMetadataResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTableMetadata(software.amazon.awssdk.services.athena.model.ListTableMetadataRequest)
operation.
This is a convenience which creates an instance of the
ListTableMetadataRequest.Builder
avoiding the need to create one manually viaListTableMetadataRequest.builder()
- Parameters:
listTableMetadataRequest
- AConsumer
that will call methods onListTableMetadataRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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 Lambda4XX
exception is returned in aMetadataException
. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags associated with an Athena resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags associated with an Athena resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant of
listTagsForResource(software.amazon.awssdk.services.athena.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListTagsForResourceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListTagsForResourceResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.athena.model.ListTagsForResourceRequest)
operation.- Parameters:
listTagsForResourceRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourcePublisher listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is a variant of
listTagsForResource(software.amazon.awssdk.services.athena.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListTagsForResourceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListTagsForResourceResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.athena.model.ListTagsForResourceRequest)
operation.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkGroups
default CompletableFuture<ListWorkGroupsResponse> listWorkGroups(ListWorkGroupsRequest listWorkGroupsRequest) Lists available workgroups for the account.
- Parameters:
listWorkGroupsRequest
-- Returns:
- A Java Future containing the result of the ListWorkGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkGroups
default CompletableFuture<ListWorkGroupsResponse> listWorkGroups(Consumer<ListWorkGroupsRequest.Builder> listWorkGroupsRequest) Lists available workgroups for the account.
This is a convenience which creates an instance of the
ListWorkGroupsRequest.Builder
avoiding the need to create one manually viaListWorkGroupsRequest.builder()
- Parameters:
listWorkGroupsRequest
- AConsumer
that will call methods onListWorkGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListWorkGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkGroupsPaginator
default ListWorkGroupsPublisher listWorkGroupsPaginator(ListWorkGroupsRequest listWorkGroupsRequest) This is a variant of
listWorkGroups(software.amazon.awssdk.services.athena.model.ListWorkGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListWorkGroupsPublisher publisher = client.listWorkGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListWorkGroupsPublisher publisher = client.listWorkGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListWorkGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListWorkGroupsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkGroups(software.amazon.awssdk.services.athena.model.ListWorkGroupsRequest)
operation.- Parameters:
listWorkGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkGroupsPaginator
default ListWorkGroupsPublisher listWorkGroupsPaginator(Consumer<ListWorkGroupsRequest.Builder> listWorkGroupsRequest) This is a variant of
listWorkGroups(software.amazon.awssdk.services.athena.model.ListWorkGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.athena.paginators.ListWorkGroupsPublisher publisher = client.listWorkGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.athena.paginators.ListWorkGroupsPublisher publisher = client.listWorkGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListWorkGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.athena.model.ListWorkGroupsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkGroups(software.amazon.awssdk.services.athena.model.ListWorkGroupsRequest)
operation.
This is a convenience which creates an instance of the
ListWorkGroupsRequest.Builder
avoiding the need to create one manually viaListWorkGroupsRequest.builder()
- Parameters:
listWorkGroupsRequest
- AConsumer
that will call methods onListWorkGroupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putCapacityAssignmentConfiguration
default CompletableFuture<PutCapacityAssignmentConfigurationResponse> 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.
- Parameters:
putCapacityAssignmentConfigurationRequest
-- Returns:
- A Java Future containing the result of the PutCapacityAssignmentConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putCapacityAssignmentConfiguration
default CompletableFuture<PutCapacityAssignmentConfigurationResponse> putCapacityAssignmentConfiguration(Consumer<PutCapacityAssignmentConfigurationRequest.Builder> 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.
This is a convenience which creates an instance of the
PutCapacityAssignmentConfigurationRequest.Builder
avoiding the need to create one manually viaPutCapacityAssignmentConfigurationRequest.builder()
- Parameters:
putCapacityAssignmentConfigurationRequest
- AConsumer
that will call methods onPutCapacityAssignmentConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutCapacityAssignmentConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startCalculationExecution
default CompletableFuture<StartCalculationExecutionResponse> 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.
The request syntax requires the StartCalculationExecutionRequestinvalid input: '$'CodeBlock parameter or the CalculationConfigurationinvalid input: '$'CodeBlock parameter, but not both. Because CalculationConfigurationinvalid input: '$'CodeBlock is deprecated, use the StartCalculationExecutionRequestinvalid input: '$'CodeBlock parameter instead.
- Parameters:
startCalculationExecutionRequest
-- Returns:
- A Java Future containing the result of the StartCalculationExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startCalculationExecution
default CompletableFuture<StartCalculationExecutionResponse> startCalculationExecution(Consumer<StartCalculationExecutionRequest.Builder> startCalculationExecutionRequest) Submits calculations for execution within a session. You can supply the code to run as an inline code block within the request.
The request syntax requires the StartCalculationExecutionRequestinvalid input: '$'CodeBlock parameter or the CalculationConfigurationinvalid input: '$'CodeBlock parameter, but not both. Because CalculationConfigurationinvalid input: '$'CodeBlock is deprecated, use the StartCalculationExecutionRequestinvalid input: '$'CodeBlock parameter instead.
This is a convenience which creates an instance of the
StartCalculationExecutionRequest.Builder
avoiding the need to create one manually viaStartCalculationExecutionRequest.builder()
- Parameters:
startCalculationExecutionRequest
- AConsumer
that will call methods onStartCalculationExecutionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartCalculationExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startQueryExecution
default CompletableFuture<StartQueryExecutionResponse> 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.- Parameters:
startQueryExecutionRequest
-- Returns:
- A Java Future containing the result of the StartQueryExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startQueryExecution
default CompletableFuture<StartQueryExecutionResponse> startQueryExecution(Consumer<StartQueryExecutionRequest.Builder> 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.
This is a convenience which creates an instance of the
StartQueryExecutionRequest.Builder
avoiding the need to create one manually viaStartQueryExecutionRequest.builder()
- Parameters:
startQueryExecutionRequest
- AConsumer
that will call methods onStartQueryExecutionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartQueryExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startSession
default CompletableFuture<StartSessionResponse> startSession(StartSessionRequest startSessionRequest) Creates a session for running calculations within a workgroup. The session is ready when it reaches an
IDLE
state.- Parameters:
startSessionRequest
-- Returns:
- A Java Future containing the result of the StartSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startSession
default CompletableFuture<StartSessionResponse> startSession(Consumer<StartSessionRequest.Builder> startSessionRequest) Creates a session for running calculations within a workgroup. The session is ready when it reaches an
IDLE
state.
This is a convenience which creates an instance of the
StartSessionRequest.Builder
avoiding the need to create one manually viaStartSessionRequest.builder()
- Parameters:
startSessionRequest
- AConsumer
that will call methods onStartSessionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopCalculationExecution
default CompletableFuture<StopCalculationExecutionResponse> 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
, orCOMPLETED
) 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.
- Parameters:
stopCalculationExecutionRequest
-- Returns:
- A Java Future containing the result of the StopCalculationExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopCalculationExecution
default CompletableFuture<StopCalculationExecutionResponse> stopCalculationExecution(Consumer<StopCalculationExecutionRequest.Builder> stopCalculationExecutionRequest) Requests the cancellation of a calculation. A
StopCalculationExecution
call on a calculation that is already in a terminal state (for example,STOPPED
,FAILED
, orCOMPLETED
) 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.
This is a convenience which creates an instance of the
StopCalculationExecutionRequest.Builder
avoiding the need to create one manually viaStopCalculationExecutionRequest.builder()
- Parameters:
stopCalculationExecutionRequest
- AConsumer
that will call methods onStopCalculationExecutionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopCalculationExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopQueryExecution
default CompletableFuture<StopQueryExecutionResponse> stopQueryExecution(StopQueryExecutionRequest stopQueryExecutionRequest) Stops a query execution. Requires you to have access to the workgroup in which the query ran.
- Parameters:
stopQueryExecutionRequest
-- Returns:
- A Java Future containing the result of the StopQueryExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopQueryExecution
default CompletableFuture<StopQueryExecutionResponse> stopQueryExecution(Consumer<StopQueryExecutionRequest.Builder> stopQueryExecutionRequest) Stops a query execution. Requires you to have access to the workgroup in which the query ran.
This is a convenience which creates an instance of the
StopQueryExecutionRequest.Builder
avoiding the need to create one manually viaStopQueryExecutionRequest.builder()
- Parameters:
stopQueryExecutionRequest
- AConsumer
that will call methods onStopQueryExecutionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopQueryExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
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.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> 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.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
terminateSession
default CompletableFuture<TerminateSessionResponse> terminateSession(TerminateSessionRequest terminateSessionRequest) Terminates an active session. A
TerminateSession
call on a session that is already inactive (for example, in aFAILED
,TERMINATED
orTERMINATING
state) succeeds but has no effect. Calculations running in the session whenTerminateSession
is called are forcefully stopped, but may display asFAILED
instead ofSTOPPED
.- Parameters:
terminateSessionRequest
-- Returns:
- A Java Future containing the result of the TerminateSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
terminateSession
default CompletableFuture<TerminateSessionResponse> terminateSession(Consumer<TerminateSessionRequest.Builder> terminateSessionRequest) Terminates an active session. A
TerminateSession
call on a session that is already inactive (for example, in aFAILED
,TERMINATED
orTERMINATING
state) succeeds but has no effect. Calculations running in the session whenTerminateSession
is called are forcefully stopped, but may display asFAILED
instead ofSTOPPED
.
This is a convenience which creates an instance of the
TerminateSessionRequest.Builder
avoiding the need to create one manually viaTerminateSessionRequest.builder()
- Parameters:
terminateSessionRequest
- AConsumer
that will call methods onTerminateSessionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TerminateSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from an Athena resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from an Athena resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCapacityReservation
default CompletableFuture<UpdateCapacityReservationResponse> updateCapacityReservation(UpdateCapacityReservationRequest updateCapacityReservationRequest) Updates the number of requested data processing units for the capacity reservation with the specified name.
- Parameters:
updateCapacityReservationRequest
-- Returns:
- A Java Future containing the result of the UpdateCapacityReservation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCapacityReservation
default CompletableFuture<UpdateCapacityReservationResponse> updateCapacityReservation(Consumer<UpdateCapacityReservationRequest.Builder> updateCapacityReservationRequest) Updates the number of requested data processing units for the capacity reservation with the specified name.
This is a convenience which creates an instance of the
UpdateCapacityReservationRequest.Builder
avoiding the need to create one manually viaUpdateCapacityReservationRequest.builder()
- Parameters:
updateCapacityReservationRequest
- AConsumer
that will call methods onUpdateCapacityReservationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateCapacityReservation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDataCatalog
default CompletableFuture<UpdateDataCatalogResponse> updateDataCatalog(UpdateDataCatalogRequest updateDataCatalogRequest) Updates the data catalog that has the specified name.
- Parameters:
updateDataCatalogRequest
-- Returns:
- A Java Future containing the result of the UpdateDataCatalog operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDataCatalog
default CompletableFuture<UpdateDataCatalogResponse> updateDataCatalog(Consumer<UpdateDataCatalogRequest.Builder> updateDataCatalogRequest) Updates the data catalog that has the specified name.
This is a convenience which creates an instance of the
UpdateDataCatalogRequest.Builder
avoiding the need to create one manually viaUpdateDataCatalogRequest.builder()
- Parameters:
updateDataCatalogRequest
- AConsumer
that will call methods onUpdateDataCatalogRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateDataCatalog operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateNamedQuery
default CompletableFuture<UpdateNamedQueryResponse> updateNamedQuery(UpdateNamedQueryRequest updateNamedQueryRequest) Updates a NamedQuery object. The database or workgroup cannot be updated.
- Parameters:
updateNamedQueryRequest
-- Returns:
- A Java Future containing the result of the UpdateNamedQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateNamedQuery
default CompletableFuture<UpdateNamedQueryResponse> updateNamedQuery(Consumer<UpdateNamedQueryRequest.Builder> updateNamedQueryRequest) Updates a NamedQuery object. The database or workgroup cannot be updated.
This is a convenience which creates an instance of the
UpdateNamedQueryRequest.Builder
avoiding the need to create one manually viaUpdateNamedQueryRequest.builder()
- Parameters:
updateNamedQueryRequest
- AConsumer
that will call methods onUpdateNamedQueryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateNamedQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateNotebook
default CompletableFuture<UpdateNotebookResponse> updateNotebook(UpdateNotebookRequest updateNotebookRequest) Updates the contents of a Spark notebook.
- Parameters:
updateNotebookRequest
-- Returns:
- A Java Future containing the result of the UpdateNotebook operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateNotebook
default CompletableFuture<UpdateNotebookResponse> updateNotebook(Consumer<UpdateNotebookRequest.Builder> updateNotebookRequest) Updates the contents of a Spark notebook.
This is a convenience which creates an instance of the
UpdateNotebookRequest.Builder
avoiding the need to create one manually viaUpdateNotebookRequest.builder()
- Parameters:
updateNotebookRequest
- AConsumer
that will call methods onUpdateNotebookRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateNotebook operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateNotebookMetadata
default CompletableFuture<UpdateNotebookMetadataResponse> updateNotebookMetadata(UpdateNotebookMetadataRequest updateNotebookMetadataRequest) Updates the metadata for a notebook.
- Parameters:
updateNotebookMetadataRequest
-- Returns:
- A Java Future containing the result of the UpdateNotebookMetadata operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateNotebookMetadata
default CompletableFuture<UpdateNotebookMetadataResponse> updateNotebookMetadata(Consumer<UpdateNotebookMetadataRequest.Builder> updateNotebookMetadataRequest) Updates the metadata for a notebook.
This is a convenience which creates an instance of the
UpdateNotebookMetadataRequest.Builder
avoiding the need to create one manually viaUpdateNotebookMetadataRequest.builder()
- Parameters:
updateNotebookMetadataRequest
- AConsumer
that will call methods onUpdateNotebookMetadataRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateNotebookMetadata operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePreparedStatement
default CompletableFuture<UpdatePreparedStatementResponse> updatePreparedStatement(UpdatePreparedStatementRequest updatePreparedStatementRequest) Updates a prepared statement.
- Parameters:
updatePreparedStatementRequest
-- Returns:
- A Java Future containing the result of the UpdatePreparedStatement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePreparedStatement
default CompletableFuture<UpdatePreparedStatementResponse> updatePreparedStatement(Consumer<UpdatePreparedStatementRequest.Builder> updatePreparedStatementRequest) Updates a prepared statement.
This is a convenience which creates an instance of the
UpdatePreparedStatementRequest.Builder
avoiding the need to create one manually viaUpdatePreparedStatementRequest.builder()
- Parameters:
updatePreparedStatementRequest
- AConsumer
that will call methods onUpdatePreparedStatementRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdatePreparedStatement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateWorkGroup
default CompletableFuture<UpdateWorkGroupResponse> updateWorkGroup(UpdateWorkGroupRequest updateWorkGroupRequest) Updates the workgroup with the specified name. The workgroup's name cannot be changed. Only
ConfigurationUpdates
can be specified.- Parameters:
updateWorkGroupRequest
-- Returns:
- A Java Future containing the result of the UpdateWorkGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateWorkGroup
default CompletableFuture<UpdateWorkGroupResponse> updateWorkGroup(Consumer<UpdateWorkGroupRequest.Builder> updateWorkGroupRequest) Updates the workgroup with the specified name. The workgroup's name cannot be changed. Only
ConfigurationUpdates
can be specified.
This is a convenience which creates an instance of the
UpdateWorkGroupRequest.Builder
avoiding the need to create one manually viaUpdateWorkGroupRequest.builder()
- Parameters:
updateWorkGroupRequest
- AConsumer
that will call methods onUpdateWorkGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateWorkGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aAthenaAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aAthenaAsyncClient
.
-