Interface AthenaClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface AthenaClient extends AwsClient
Service client for accessing Amazon Athena. This can be created using the staticbuilder()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
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description default BatchGetNamedQueryResponsebatchGetNamedQuery(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.default BatchGetNamedQueryResponsebatchGetNamedQuery(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.default BatchGetPreparedStatementResponsebatchGetPreparedStatement(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.default BatchGetPreparedStatementResponsebatchGetPreparedStatement(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.default BatchGetQueryExecutionResponsebatchGetQueryExecution(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.default BatchGetQueryExecutionResponsebatchGetQueryExecution(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 AthenaClientBuilderbuilder()Create a builder that can be used to configure and create aAthenaClient.default CancelCapacityReservationResponsecancelCapacityReservation(Consumer<CancelCapacityReservationRequest.Builder> cancelCapacityReservationRequest)Cancels the capacity reservation with the specified name.default CancelCapacityReservationResponsecancelCapacityReservation(CancelCapacityReservationRequest cancelCapacityReservationRequest)Cancels the capacity reservation with the specified name.static AthenaClientcreate()Create aAthenaClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateCapacityReservationResponsecreateCapacityReservation(Consumer<CreateCapacityReservationRequest.Builder> createCapacityReservationRequest)Creates a capacity reservation with the specified name and number of requested data processing units.default CreateCapacityReservationResponsecreateCapacityReservation(CreateCapacityReservationRequest createCapacityReservationRequest)Creates a capacity reservation with the specified name and number of requested data processing units.default CreateDataCatalogResponsecreateDataCatalog(Consumer<CreateDataCatalogRequest.Builder> createDataCatalogRequest)Creates (registers) a data catalog with the specified name and properties.default CreateDataCatalogResponsecreateDataCatalog(CreateDataCatalogRequest createDataCatalogRequest)Creates (registers) a data catalog with the specified name and properties.default CreateNamedQueryResponsecreateNamedQuery(Consumer<CreateNamedQueryRequest.Builder> createNamedQueryRequest)Creates a named query in the specified workgroup.default CreateNamedQueryResponsecreateNamedQuery(CreateNamedQueryRequest createNamedQueryRequest)Creates a named query in the specified workgroup.default CreateNotebookResponsecreateNotebook(Consumer<CreateNotebookRequest.Builder> createNotebookRequest)Creates an emptyipynbfile in the specified Apache Spark enabled workgroup.default CreateNotebookResponsecreateNotebook(CreateNotebookRequest createNotebookRequest)Creates an emptyipynbfile in the specified Apache Spark enabled workgroup.default CreatePreparedStatementResponsecreatePreparedStatement(Consumer<CreatePreparedStatementRequest.Builder> createPreparedStatementRequest)Creates a prepared statement for use with SQL queries in Athena.default CreatePreparedStatementResponsecreatePreparedStatement(CreatePreparedStatementRequest createPreparedStatementRequest)Creates a prepared statement for use with SQL queries in Athena.default CreatePresignedNotebookUrlResponsecreatePresignedNotebookUrl(Consumer<CreatePresignedNotebookUrlRequest.Builder> createPresignedNotebookUrlRequest)Gets an authentication token and the URL at which the notebook can be accessed.default CreatePresignedNotebookUrlResponsecreatePresignedNotebookUrl(CreatePresignedNotebookUrlRequest createPresignedNotebookUrlRequest)Gets an authentication token and the URL at which the notebook can be accessed.default CreateWorkGroupResponsecreateWorkGroup(Consumer<CreateWorkGroupRequest.Builder> createWorkGroupRequest)Creates a workgroup with the specified name.default CreateWorkGroupResponsecreateWorkGroup(CreateWorkGroupRequest createWorkGroupRequest)Creates a workgroup with the specified name.default DeleteCapacityReservationResponsedeleteCapacityReservation(Consumer<DeleteCapacityReservationRequest.Builder> deleteCapacityReservationRequest)Deletes a cancelled capacity reservation.default DeleteCapacityReservationResponsedeleteCapacityReservation(DeleteCapacityReservationRequest deleteCapacityReservationRequest)Deletes a cancelled capacity reservation.default DeleteDataCatalogResponsedeleteDataCatalog(Consumer<DeleteDataCatalogRequest.Builder> deleteDataCatalogRequest)Deletes a data catalog.default DeleteDataCatalogResponsedeleteDataCatalog(DeleteDataCatalogRequest deleteDataCatalogRequest)Deletes a data catalog.default DeleteNamedQueryResponsedeleteNamedQuery(Consumer<DeleteNamedQueryRequest.Builder> deleteNamedQueryRequest)Deletes the named query if you have access to the workgroup in which the query was saved.default DeleteNamedQueryResponsedeleteNamedQuery(DeleteNamedQueryRequest deleteNamedQueryRequest)Deletes the named query if you have access to the workgroup in which the query was saved.default DeleteNotebookResponsedeleteNotebook(Consumer<DeleteNotebookRequest.Builder> deleteNotebookRequest)Deletes the specified notebook.default DeleteNotebookResponsedeleteNotebook(DeleteNotebookRequest deleteNotebookRequest)Deletes the specified notebook.default DeletePreparedStatementResponsedeletePreparedStatement(Consumer<DeletePreparedStatementRequest.Builder> deletePreparedStatementRequest)Deletes the prepared statement with the specified name from the specified workgroup.default DeletePreparedStatementResponsedeletePreparedStatement(DeletePreparedStatementRequest deletePreparedStatementRequest)Deletes the prepared statement with the specified name from the specified workgroup.default DeleteWorkGroupResponsedeleteWorkGroup(Consumer<DeleteWorkGroupRequest.Builder> deleteWorkGroupRequest)Deletes the workgroup with the specified name.default DeleteWorkGroupResponsedeleteWorkGroup(DeleteWorkGroupRequest deleteWorkGroupRequest)Deletes the workgroup with the specified name.default ExportNotebookResponseexportNotebook(Consumer<ExportNotebookRequest.Builder> exportNotebookRequest)Exports the specified notebook and its metadata.default ExportNotebookResponseexportNotebook(ExportNotebookRequest exportNotebookRequest)Exports the specified notebook and its metadata.default GetCalculationExecutionResponsegetCalculationExecution(Consumer<GetCalculationExecutionRequest.Builder> getCalculationExecutionRequest)Describes a previously submitted calculation execution.default GetCalculationExecutionResponsegetCalculationExecution(GetCalculationExecutionRequest getCalculationExecutionRequest)Describes a previously submitted calculation execution.default GetCalculationExecutionCodeResponsegetCalculationExecutionCode(Consumer<GetCalculationExecutionCodeRequest.Builder> getCalculationExecutionCodeRequest)Retrieves the unencrypted code that was executed for the calculation.default GetCalculationExecutionCodeResponsegetCalculationExecutionCode(GetCalculationExecutionCodeRequest getCalculationExecutionCodeRequest)Retrieves the unencrypted code that was executed for the calculation.default GetCalculationExecutionStatusResponsegetCalculationExecutionStatus(Consumer<GetCalculationExecutionStatusRequest.Builder> getCalculationExecutionStatusRequest)Gets the status of a current calculation.default GetCalculationExecutionStatusResponsegetCalculationExecutionStatus(GetCalculationExecutionStatusRequest getCalculationExecutionStatusRequest)Gets the status of a current calculation.default GetCapacityAssignmentConfigurationResponsegetCapacityAssignmentConfiguration(Consumer<GetCapacityAssignmentConfigurationRequest.Builder> getCapacityAssignmentConfigurationRequest)Gets the capacity assignment configuration for a capacity reservation, if one exists.default GetCapacityAssignmentConfigurationResponsegetCapacityAssignmentConfiguration(GetCapacityAssignmentConfigurationRequest getCapacityAssignmentConfigurationRequest)Gets the capacity assignment configuration for a capacity reservation, if one exists.default GetCapacityReservationResponsegetCapacityReservation(Consumer<GetCapacityReservationRequest.Builder> getCapacityReservationRequest)Returns information about the capacity reservation with the specified name.default GetCapacityReservationResponsegetCapacityReservation(GetCapacityReservationRequest getCapacityReservationRequest)Returns information about the capacity reservation with the specified name.default GetDatabaseResponsegetDatabase(Consumer<GetDatabaseRequest.Builder> getDatabaseRequest)Returns a database object for the specified database and data catalog.default GetDatabaseResponsegetDatabase(GetDatabaseRequest getDatabaseRequest)Returns a database object for the specified database and data catalog.default GetDataCatalogResponsegetDataCatalog(Consumer<GetDataCatalogRequest.Builder> getDataCatalogRequest)Returns the specified data catalog.default GetDataCatalogResponsegetDataCatalog(GetDataCatalogRequest getDataCatalogRequest)Returns the specified data catalog.default GetNamedQueryResponsegetNamedQuery(Consumer<GetNamedQueryRequest.Builder> getNamedQueryRequest)Returns information about a single query.default GetNamedQueryResponsegetNamedQuery(GetNamedQueryRequest getNamedQueryRequest)Returns information about a single query.default GetNotebookMetadataResponsegetNotebookMetadata(Consumer<GetNotebookMetadataRequest.Builder> getNotebookMetadataRequest)Retrieves notebook metadata for the specified notebook ID.default GetNotebookMetadataResponsegetNotebookMetadata(GetNotebookMetadataRequest getNotebookMetadataRequest)Retrieves notebook metadata for the specified notebook ID.default GetPreparedStatementResponsegetPreparedStatement(Consumer<GetPreparedStatementRequest.Builder> getPreparedStatementRequest)Retrieves the prepared statement with the specified name from the specified workgroup.default GetPreparedStatementResponsegetPreparedStatement(GetPreparedStatementRequest getPreparedStatementRequest)Retrieves the prepared statement with the specified name from the specified workgroup.default GetQueryExecutionResponsegetQueryExecution(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.default GetQueryExecutionResponsegetQueryExecution(GetQueryExecutionRequest getQueryExecutionRequest)Returns information about a single execution of a query if you have access to the workgroup in which the query ran.default GetQueryResultsResponsegetQueryResults(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest)Streams the results of a single query execution specified byQueryExecutionIdfrom the Athena query results location in Amazon S3.default GetQueryResultsResponsegetQueryResults(GetQueryResultsRequest getQueryResultsRequest)Streams the results of a single query execution specified byQueryExecutionIdfrom the Athena query results location in Amazon S3.default GetQueryResultsIterablegetQueryResultsPaginator(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest)This is a variant ofgetQueryResults(software.amazon.awssdk.services.athena.model.GetQueryResultsRequest)operation.default GetQueryResultsIterablegetQueryResultsPaginator(GetQueryResultsRequest getQueryResultsRequest)This is a variant ofgetQueryResults(software.amazon.awssdk.services.athena.model.GetQueryResultsRequest)operation.default GetQueryRuntimeStatisticsResponsegetQueryRuntimeStatistics(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.default GetQueryRuntimeStatisticsResponsegetQueryRuntimeStatistics(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 GetSessionResponsegetSession(Consumer<GetSessionRequest.Builder> getSessionRequest)Gets the full details of a previously created session, including the session status and configuration.default GetSessionResponsegetSession(GetSessionRequest getSessionRequest)Gets the full details of a previously created session, including the session status and configuration.default GetSessionStatusResponsegetSessionStatus(Consumer<GetSessionStatusRequest.Builder> getSessionStatusRequest)Gets the current status of a session.default GetSessionStatusResponsegetSessionStatus(GetSessionStatusRequest getSessionStatusRequest)Gets the current status of a session.default GetTableMetadataResponsegetTableMetadata(Consumer<GetTableMetadataRequest.Builder> getTableMetadataRequest)Returns table metadata for the specified catalog, database, and table.default GetTableMetadataResponsegetTableMetadata(GetTableMetadataRequest getTableMetadataRequest)Returns table metadata for the specified catalog, database, and table.default GetWorkGroupResponsegetWorkGroup(Consumer<GetWorkGroupRequest.Builder> getWorkGroupRequest)Returns information about the workgroup with the specified name.default GetWorkGroupResponsegetWorkGroup(GetWorkGroupRequest getWorkGroupRequest)Returns information about the workgroup with the specified name.default ImportNotebookResponseimportNotebook(Consumer<ImportNotebookRequest.Builder> importNotebookRequest)Imports a singleipynbfile to a Spark enabled workgroup.default ImportNotebookResponseimportNotebook(ImportNotebookRequest importNotebookRequest)Imports a singleipynbfile to a Spark enabled workgroup.default ListApplicationDpuSizesResponselistApplicationDPUSizes(Consumer<ListApplicationDpuSizesRequest.Builder> listApplicationDpuSizesRequest)Returns the supported DPU sizes for the supported application runtimes (for example,Athena notebook version 1).default ListApplicationDpuSizesResponselistApplicationDPUSizes(ListApplicationDpuSizesRequest listApplicationDpuSizesRequest)Returns the supported DPU sizes for the supported application runtimes (for example,Athena notebook version 1).default ListApplicationDPUSizesIterablelistApplicationDPUSizesPaginator(Consumer<ListApplicationDpuSizesRequest.Builder> listApplicationDpuSizesRequest)This is a variant oflistApplicationDPUSizes(software.amazon.awssdk.services.athena.model.ListApplicationDpuSizesRequest)operation.default ListApplicationDPUSizesIterablelistApplicationDPUSizesPaginator(ListApplicationDpuSizesRequest listApplicationDpuSizesRequest)This is a variant oflistApplicationDPUSizes(software.amazon.awssdk.services.athena.model.ListApplicationDpuSizesRequest)operation.default ListCalculationExecutionsResponselistCalculationExecutions(Consumer<ListCalculationExecutionsRequest.Builder> listCalculationExecutionsRequest)Lists the calculations that have been submitted to a session in descending order.default ListCalculationExecutionsResponselistCalculationExecutions(ListCalculationExecutionsRequest listCalculationExecutionsRequest)Lists the calculations that have been submitted to a session in descending order.default ListCalculationExecutionsIterablelistCalculationExecutionsPaginator(Consumer<ListCalculationExecutionsRequest.Builder> listCalculationExecutionsRequest)This is a variant oflistCalculationExecutions(software.amazon.awssdk.services.athena.model.ListCalculationExecutionsRequest)operation.default ListCalculationExecutionsIterablelistCalculationExecutionsPaginator(ListCalculationExecutionsRequest listCalculationExecutionsRequest)This is a variant oflistCalculationExecutions(software.amazon.awssdk.services.athena.model.ListCalculationExecutionsRequest)operation.default ListCapacityReservationsResponselistCapacityReservations(Consumer<ListCapacityReservationsRequest.Builder> listCapacityReservationsRequest)Lists the capacity reservations for the current account.default ListCapacityReservationsResponselistCapacityReservations(ListCapacityReservationsRequest listCapacityReservationsRequest)Lists the capacity reservations for the current account.default ListCapacityReservationsIterablelistCapacityReservationsPaginator(Consumer<ListCapacityReservationsRequest.Builder> listCapacityReservationsRequest)This is a variant oflistCapacityReservations(software.amazon.awssdk.services.athena.model.ListCapacityReservationsRequest)operation.default ListCapacityReservationsIterablelistCapacityReservationsPaginator(ListCapacityReservationsRequest listCapacityReservationsRequest)This is a variant oflistCapacityReservations(software.amazon.awssdk.services.athena.model.ListCapacityReservationsRequest)operation.default ListDatabasesResponselistDatabases(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest)Lists the databases in the specified data catalog.default ListDatabasesResponselistDatabases(ListDatabasesRequest listDatabasesRequest)Lists the databases in the specified data catalog.default ListDatabasesIterablelistDatabasesPaginator(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest)This is a variant oflistDatabases(software.amazon.awssdk.services.athena.model.ListDatabasesRequest)operation.default ListDatabasesIterablelistDatabasesPaginator(ListDatabasesRequest listDatabasesRequest)This is a variant oflistDatabases(software.amazon.awssdk.services.athena.model.ListDatabasesRequest)operation.default ListDataCatalogsResponselistDataCatalogs(Consumer<ListDataCatalogsRequest.Builder> listDataCatalogsRequest)Lists the data catalogs in the current Amazon Web Services account.default ListDataCatalogsResponselistDataCatalogs(ListDataCatalogsRequest listDataCatalogsRequest)Lists the data catalogs in the current Amazon Web Services account.default ListDataCatalogsIterablelistDataCatalogsPaginator(Consumer<ListDataCatalogsRequest.Builder> listDataCatalogsRequest)This is a variant oflistDataCatalogs(software.amazon.awssdk.services.athena.model.ListDataCatalogsRequest)operation.default ListDataCatalogsIterablelistDataCatalogsPaginator(ListDataCatalogsRequest listDataCatalogsRequest)This is a variant oflistDataCatalogs(software.amazon.awssdk.services.athena.model.ListDataCatalogsRequest)operation.default ListEngineVersionsResponselistEngineVersions(Consumer<ListEngineVersionsRequest.Builder> listEngineVersionsRequest)Returns a list of engine versions that are available to choose from, including the Auto option.default ListEngineVersionsResponselistEngineVersions(ListEngineVersionsRequest listEngineVersionsRequest)Returns a list of engine versions that are available to choose from, including the Auto option.default ListEngineVersionsIterablelistEngineVersionsPaginator(Consumer<ListEngineVersionsRequest.Builder> listEngineVersionsRequest)This is a variant oflistEngineVersions(software.amazon.awssdk.services.athena.model.ListEngineVersionsRequest)operation.default ListEngineVersionsIterablelistEngineVersionsPaginator(ListEngineVersionsRequest listEngineVersionsRequest)This is a variant oflistEngineVersions(software.amazon.awssdk.services.athena.model.ListEngineVersionsRequest)operation.default ListExecutorsResponselistExecutors(Consumer<ListExecutorsRequest.Builder> listExecutorsRequest)Lists, in descending order, the executors that joined a session.default ListExecutorsResponselistExecutors(ListExecutorsRequest listExecutorsRequest)Lists, in descending order, the executors that joined a session.default ListExecutorsIterablelistExecutorsPaginator(Consumer<ListExecutorsRequest.Builder> listExecutorsRequest)This is a variant oflistExecutors(software.amazon.awssdk.services.athena.model.ListExecutorsRequest)operation.default ListExecutorsIterablelistExecutorsPaginator(ListExecutorsRequest listExecutorsRequest)This is a variant oflistExecutors(software.amazon.awssdk.services.athena.model.ListExecutorsRequest)operation.default ListNamedQueriesResponselistNamedQueries()Provides a list of available query IDs only for queries saved in the specified workgroup.default ListNamedQueriesResponselistNamedQueries(Consumer<ListNamedQueriesRequest.Builder> listNamedQueriesRequest)Provides a list of available query IDs only for queries saved in the specified workgroup.default ListNamedQueriesResponselistNamedQueries(ListNamedQueriesRequest listNamedQueriesRequest)Provides a list of available query IDs only for queries saved in the specified workgroup.default ListNamedQueriesIterablelistNamedQueriesPaginator()This is a variant oflistNamedQueries(software.amazon.awssdk.services.athena.model.ListNamedQueriesRequest)operation.default ListNamedQueriesIterablelistNamedQueriesPaginator(Consumer<ListNamedQueriesRequest.Builder> listNamedQueriesRequest)This is a variant oflistNamedQueries(software.amazon.awssdk.services.athena.model.ListNamedQueriesRequest)operation.default ListNamedQueriesIterablelistNamedQueriesPaginator(ListNamedQueriesRequest listNamedQueriesRequest)This is a variant oflistNamedQueries(software.amazon.awssdk.services.athena.model.ListNamedQueriesRequest)operation.default ListNotebookMetadataResponselistNotebookMetadata(Consumer<ListNotebookMetadataRequest.Builder> listNotebookMetadataRequest)Displays the notebook files for the specified workgroup in paginated format.default ListNotebookMetadataResponselistNotebookMetadata(ListNotebookMetadataRequest listNotebookMetadataRequest)Displays the notebook files for the specified workgroup in paginated format.default ListNotebookSessionsResponselistNotebookSessions(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,IDLEorBUSY.default ListNotebookSessionsResponselistNotebookSessions(ListNotebookSessionsRequest listNotebookSessionsRequest)Lists, in descending order, the sessions that have been created in a notebook that are in an active state likeCREATING,CREATED,IDLEorBUSY.default ListPreparedStatementsResponselistPreparedStatements(Consumer<ListPreparedStatementsRequest.Builder> listPreparedStatementsRequest)Lists the prepared statements in the specified workgroup.default ListPreparedStatementsResponselistPreparedStatements(ListPreparedStatementsRequest listPreparedStatementsRequest)Lists the prepared statements in the specified workgroup.default ListPreparedStatementsIterablelistPreparedStatementsPaginator(Consumer<ListPreparedStatementsRequest.Builder> listPreparedStatementsRequest)This is a variant oflistPreparedStatements(software.amazon.awssdk.services.athena.model.ListPreparedStatementsRequest)operation.default ListPreparedStatementsIterablelistPreparedStatementsPaginator(ListPreparedStatementsRequest listPreparedStatementsRequest)This is a variant oflistPreparedStatements(software.amazon.awssdk.services.athena.model.ListPreparedStatementsRequest)operation.default ListQueryExecutionsResponselistQueryExecutions()Provides a list of available query execution IDs for the queries in the specified workgroup.default ListQueryExecutionsResponselistQueryExecutions(Consumer<ListQueryExecutionsRequest.Builder> listQueryExecutionsRequest)Provides a list of available query execution IDs for the queries in the specified workgroup.default ListQueryExecutionsResponselistQueryExecutions(ListQueryExecutionsRequest listQueryExecutionsRequest)Provides a list of available query execution IDs for the queries in the specified workgroup.default ListQueryExecutionsIterablelistQueryExecutionsPaginator()This is a variant oflistQueryExecutions(software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest)operation.default ListQueryExecutionsIterablelistQueryExecutionsPaginator(Consumer<ListQueryExecutionsRequest.Builder> listQueryExecutionsRequest)This is a variant oflistQueryExecutions(software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest)operation.default ListQueryExecutionsIterablelistQueryExecutionsPaginator(ListQueryExecutionsRequest listQueryExecutionsRequest)This is a variant oflistQueryExecutions(software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest)operation.default ListSessionsResponselistSessions(Consumer<ListSessionsRequest.Builder> listSessionsRequest)Lists the sessions in a workgroup that are in an active state likeCREATING,CREATED,IDLE, orBUSY.default ListSessionsResponselistSessions(ListSessionsRequest listSessionsRequest)Lists the sessions in a workgroup that are in an active state likeCREATING,CREATED,IDLE, orBUSY.default ListSessionsIterablelistSessionsPaginator(Consumer<ListSessionsRequest.Builder> listSessionsRequest)This is a variant oflistSessions(software.amazon.awssdk.services.athena.model.ListSessionsRequest)operation.default ListSessionsIterablelistSessionsPaginator(ListSessionsRequest listSessionsRequest)This is a variant oflistSessions(software.amazon.awssdk.services.athena.model.ListSessionsRequest)operation.default ListTableMetadataResponselistTableMetadata(Consumer<ListTableMetadataRequest.Builder> listTableMetadataRequest)Lists the metadata for the tables in the specified data catalog database.default ListTableMetadataResponselistTableMetadata(ListTableMetadataRequest listTableMetadataRequest)Lists the metadata for the tables in the specified data catalog database.default ListTableMetadataIterablelistTableMetadataPaginator(Consumer<ListTableMetadataRequest.Builder> listTableMetadataRequest)This is a variant oflistTableMetadata(software.amazon.awssdk.services.athena.model.ListTableMetadataRequest)operation.default ListTableMetadataIterablelistTableMetadataPaginator(ListTableMetadataRequest listTableMetadataRequest)This is a variant oflistTableMetadata(software.amazon.awssdk.services.athena.model.ListTableMetadataRequest)operation.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)Lists the tags associated with an Athena resource.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)Lists the tags associated with an Athena resource.default ListTagsForResourceIterablelistTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)This is a variant oflistTagsForResource(software.amazon.awssdk.services.athena.model.ListTagsForResourceRequest)operation.default ListTagsForResourceIterablelistTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)This is a variant oflistTagsForResource(software.amazon.awssdk.services.athena.model.ListTagsForResourceRequest)operation.default ListWorkGroupsResponselistWorkGroups(Consumer<ListWorkGroupsRequest.Builder> listWorkGroupsRequest)Lists available workgroups for the account.default ListWorkGroupsResponselistWorkGroups(ListWorkGroupsRequest listWorkGroupsRequest)Lists available workgroups for the account.default ListWorkGroupsIterablelistWorkGroupsPaginator(Consumer<ListWorkGroupsRequest.Builder> listWorkGroupsRequest)This is a variant oflistWorkGroups(software.amazon.awssdk.services.athena.model.ListWorkGroupsRequest)operation.default ListWorkGroupsIterablelistWorkGroupsPaginator(ListWorkGroupsRequest listWorkGroupsRequest)This is a variant oflistWorkGroups(software.amazon.awssdk.services.athena.model.ListWorkGroupsRequest)operation.default PutCapacityAssignmentConfigurationResponseputCapacityAssignmentConfiguration(Consumer<PutCapacityAssignmentConfigurationRequest.Builder> putCapacityAssignmentConfigurationRequest)Puts a new capacity assignment configuration for a specified capacity reservation.default PutCapacityAssignmentConfigurationResponseputCapacityAssignmentConfiguration(PutCapacityAssignmentConfigurationRequest putCapacityAssignmentConfigurationRequest)Puts a new capacity assignment configuration for a specified capacity reservation.default AthenaServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default StartCalculationExecutionResponsestartCalculationExecution(Consumer<StartCalculationExecutionRequest.Builder> startCalculationExecutionRequest)Submits calculations for execution within a session.default StartCalculationExecutionResponsestartCalculationExecution(StartCalculationExecutionRequest startCalculationExecutionRequest)Submits calculations for execution within a session.default StartQueryExecutionResponsestartQueryExecution(Consumer<StartQueryExecutionRequest.Builder> startQueryExecutionRequest)Runs the SQL query statements contained in theQuery.default StartQueryExecutionResponsestartQueryExecution(StartQueryExecutionRequest startQueryExecutionRequest)Runs the SQL query statements contained in theQuery.default StartSessionResponsestartSession(Consumer<StartSessionRequest.Builder> startSessionRequest)Creates a session for running calculations within a workgroup.default StartSessionResponsestartSession(StartSessionRequest startSessionRequest)Creates a session for running calculations within a workgroup.default StopCalculationExecutionResponsestopCalculationExecution(Consumer<StopCalculationExecutionRequest.Builder> stopCalculationExecutionRequest)Requests the cancellation of a calculation.default StopCalculationExecutionResponsestopCalculationExecution(StopCalculationExecutionRequest stopCalculationExecutionRequest)Requests the cancellation of a calculation.default StopQueryExecutionResponsestopQueryExecution(Consumer<StopQueryExecutionRequest.Builder> stopQueryExecutionRequest)Stops a query execution.default StopQueryExecutionResponsestopQueryExecution(StopQueryExecutionRequest stopQueryExecutionRequest)Stops a query execution.default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)Adds one or more tags to an Athena resource.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest)Adds one or more tags to an Athena resource.default TerminateSessionResponseterminateSession(Consumer<TerminateSessionRequest.Builder> terminateSessionRequest)Terminates an active session.default TerminateSessionResponseterminateSession(TerminateSessionRequest terminateSessionRequest)Terminates an active session.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)Removes one or more tags from an Athena resource.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest)Removes one or more tags from an Athena resource.default UpdateCapacityReservationResponseupdateCapacityReservation(Consumer<UpdateCapacityReservationRequest.Builder> updateCapacityReservationRequest)Updates the number of requested data processing units for the capacity reservation with the specified name.default UpdateCapacityReservationResponseupdateCapacityReservation(UpdateCapacityReservationRequest updateCapacityReservationRequest)Updates the number of requested data processing units for the capacity reservation with the specified name.default UpdateDataCatalogResponseupdateDataCatalog(Consumer<UpdateDataCatalogRequest.Builder> updateDataCatalogRequest)Updates the data catalog that has the specified name.default UpdateDataCatalogResponseupdateDataCatalog(UpdateDataCatalogRequest updateDataCatalogRequest)Updates the data catalog that has the specified name.default UpdateNamedQueryResponseupdateNamedQuery(Consumer<UpdateNamedQueryRequest.Builder> updateNamedQueryRequest)Updates a NamedQuery object.default UpdateNamedQueryResponseupdateNamedQuery(UpdateNamedQueryRequest updateNamedQueryRequest)Updates a NamedQuery object.default UpdateNotebookResponseupdateNotebook(Consumer<UpdateNotebookRequest.Builder> updateNotebookRequest)Updates the contents of a Spark notebook.default UpdateNotebookResponseupdateNotebook(UpdateNotebookRequest updateNotebookRequest)Updates the contents of a Spark notebook.default UpdateNotebookMetadataResponseupdateNotebookMetadata(Consumer<UpdateNotebookMetadataRequest.Builder> updateNotebookMetadataRequest)Updates the metadata for a notebook.default UpdateNotebookMetadataResponseupdateNotebookMetadata(UpdateNotebookMetadataRequest updateNotebookMetadataRequest)Updates the metadata for a notebook.default UpdatePreparedStatementResponseupdatePreparedStatement(Consumer<UpdatePreparedStatementRequest.Builder> updatePreparedStatementRequest)Updates a prepared statement.default UpdatePreparedStatementResponseupdatePreparedStatement(UpdatePreparedStatementRequest updatePreparedStatementRequest)Updates a prepared statement.default UpdateWorkGroupResponseupdateWorkGroup(Consumer<UpdateWorkGroupRequest.Builder> updateWorkGroupRequest)Updates the workgroup with the specified name.default UpdateWorkGroupResponseupdateWorkGroup(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 Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
batchGetNamedQuery
default BatchGetNamedQueryResponse batchGetNamedQuery(BatchGetNamedQueryRequest batchGetNamedQueryRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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:
- Result of the BatchGetNamedQuery operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetNamedQuery
default BatchGetNamedQueryResponse batchGetNamedQuery(Consumer<BatchGetNamedQueryRequest.Builder> batchGetNamedQueryRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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.Builderavoiding the need to create one manually viaBatchGetNamedQueryRequest.builder()- Parameters:
batchGetNamedQueryRequest- AConsumerthat will call methods onBatchGetNamedQueryRequest.Builderto create a request. Contains an array of named query IDs.- Returns:
- Result of the BatchGetNamedQuery operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetPreparedStatement
default BatchGetPreparedStatementResponse batchGetPreparedStatement(BatchGetPreparedStatementRequest batchGetPreparedStatementRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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:
- Result of the BatchGetPreparedStatement operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetPreparedStatement
default BatchGetPreparedStatementResponse batchGetPreparedStatement(Consumer<BatchGetPreparedStatementRequest.Builder> batchGetPreparedStatementRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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.Builderavoiding the need to create one manually viaBatchGetPreparedStatementRequest.builder()- Parameters:
batchGetPreparedStatementRequest- AConsumerthat will call methods onBatchGetPreparedStatementRequest.Builderto create a request.- Returns:
- Result of the BatchGetPreparedStatement operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetQueryExecution
default BatchGetQueryExecutionResponse batchGetQueryExecution(BatchGetQueryExecutionRequest batchGetQueryExecutionRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings. Requires you to have access to the workgroup in which the queries ran. To get a list of query execution IDs, use ListQueryExecutionsInput$WorkGroup. Query executions differ from named (saved) queries. Use BatchGetNamedQueryInput to get details about named queries.
- Parameters:
batchGetQueryExecutionRequest- Contains an array of query execution IDs.- Returns:
- Result of the BatchGetQueryExecution operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetQueryExecution
default BatchGetQueryExecutionResponse batchGetQueryExecution(Consumer<BatchGetQueryExecutionRequest.Builder> batchGetQueryExecutionRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings. Requires you to have access to the workgroup in which the queries ran. To get a list of query execution IDs, use ListQueryExecutionsInput$WorkGroup. Query executions differ from named (saved) queries. Use BatchGetNamedQueryInput to get details about named queries.
This is a convenience which creates an instance of the
BatchGetQueryExecutionRequest.Builderavoiding the need to create one manually viaBatchGetQueryExecutionRequest.builder()- Parameters:
batchGetQueryExecutionRequest- AConsumerthat will call methods onBatchGetQueryExecutionRequest.Builderto create a request. Contains an array of query execution IDs.- Returns:
- Result of the BatchGetQueryExecution operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
cancelCapacityReservation
default CancelCapacityReservationResponse cancelCapacityReservation(CancelCapacityReservationRequest cancelCapacityReservationRequest) throws InvalidRequestException, InternalServerException, AwsServiceException, SdkClientException, AthenaException
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:
- Result of the CancelCapacityReservation operation returned by the service.
- Throws:
InvalidRequestException- Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.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.AwsServiceException- See Also:
- AWS API Documentation
-
cancelCapacityReservation
default CancelCapacityReservationResponse cancelCapacityReservation(Consumer<CancelCapacityReservationRequest.Builder> cancelCapacityReservationRequest) throws InvalidRequestException, InternalServerException, AwsServiceException, SdkClientException, AthenaException
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.Builderavoiding the need to create one manually viaCancelCapacityReservationRequest.builder()- Parameters:
cancelCapacityReservationRequest- AConsumerthat will call methods onCancelCapacityReservationRequest.Builderto create a request.- Returns:
- Result of the CancelCapacityReservation operation returned by the service.
- Throws:
InvalidRequestException- Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.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.AwsServiceException- See Also:
- AWS API Documentation
-
createCapacityReservation
default CreateCapacityReservationResponse createCapacityReservation(CreateCapacityReservationRequest createCapacityReservationRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Creates a capacity reservation with the specified name and number of requested data processing units.
- Parameters:
createCapacityReservationRequest-- Returns:
- Result of the CreateCapacityReservation operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
createCapacityReservation
default CreateCapacityReservationResponse createCapacityReservation(Consumer<CreateCapacityReservationRequest.Builder> createCapacityReservationRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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.Builderavoiding the need to create one manually viaCreateCapacityReservationRequest.builder()- Parameters:
createCapacityReservationRequest- AConsumerthat will call methods onCreateCapacityReservationRequest.Builderto create a request.- Returns:
- Result of the CreateCapacityReservation operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
createDataCatalog
default CreateDataCatalogResponse createDataCatalog(CreateDataCatalogRequest createDataCatalogRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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 API operation creates the following resources.
-
CFN Stack Name with a maximum length of 128 characters and prefix
athenafederatedcatalog-CATALOG_NAME_SANITIZEDwith length 23 characters. -
Lambda Function Name with a maximum length of 64 characters and prefix
athenafederatedcatalog_CATALOG_NAME_SANITIZEDwith length 23 characters. -
Glue Connection Name with a maximum length of 255 characters and a prefix
athenafederatedcatalog_CATALOG_NAME_SANITIZEDwith length 23 characters.
- Parameters:
createDataCatalogRequest-- Returns:
- Result of the CreateDataCatalog operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
-
createDataCatalog
default CreateDataCatalogResponse createDataCatalog(Consumer<CreateDataCatalogRequest.Builder> createDataCatalogRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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 API operation creates the following resources.
-
CFN Stack Name with a maximum length of 128 characters and prefix
athenafederatedcatalog-CATALOG_NAME_SANITIZEDwith length 23 characters. -
Lambda Function Name with a maximum length of 64 characters and prefix
athenafederatedcatalog_CATALOG_NAME_SANITIZEDwith length 23 characters. -
Glue Connection Name with a maximum length of 255 characters and a prefix
athenafederatedcatalog_CATALOG_NAME_SANITIZEDwith length 23 characters.
This is a convenience which creates an instance of the
CreateDataCatalogRequest.Builderavoiding the need to create one manually viaCreateDataCatalogRequest.builder()- Parameters:
createDataCatalogRequest- AConsumerthat will call methods onCreateDataCatalogRequest.Builderto create a request.- Returns:
- Result of the CreateDataCatalog operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
-
createNamedQuery
default CreateNamedQueryResponse createNamedQuery(CreateNamedQueryRequest createNamedQueryRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Creates a named query in the specified workgroup. Requires that you have access to the workgroup.
- Parameters:
createNamedQueryRequest-- Returns:
- Result of the CreateNamedQuery operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
createNamedQuery
default CreateNamedQueryResponse createNamedQuery(Consumer<CreateNamedQueryRequest.Builder> createNamedQueryRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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.Builderavoiding the need to create one manually viaCreateNamedQueryRequest.builder()- Parameters:
createNamedQueryRequest- AConsumerthat will call methods onCreateNamedQueryRequest.Builderto create a request.- Returns:
- Result of the CreateNamedQuery operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
createNotebook
default CreateNotebookResponse createNotebook(CreateNotebookRequest createNotebookRequest) throws InternalServerException, InvalidRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
Creates an empty
ipynbfile 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:
- Result of the CreateNotebook operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
createNotebook
default CreateNotebookResponse createNotebook(Consumer<CreateNotebookRequest.Builder> createNotebookRequest) throws InternalServerException, InvalidRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
Creates an empty
ipynbfile 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.Builderavoiding the need to create one manually viaCreateNotebookRequest.builder()- Parameters:
createNotebookRequest- AConsumerthat will call methods onCreateNotebookRequest.Builderto create a request.- Returns:
- Result of the CreateNotebook operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
createPreparedStatement
default CreatePreparedStatementResponse createPreparedStatement(CreatePreparedStatementRequest createPreparedStatementRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Creates a prepared statement for use with SQL queries in Athena.
- Parameters:
createPreparedStatementRequest-- Returns:
- Result of the CreatePreparedStatement operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
createPreparedStatement
default CreatePreparedStatementResponse createPreparedStatement(Consumer<CreatePreparedStatementRequest.Builder> createPreparedStatementRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Creates a prepared statement for use with SQL queries in Athena.
This is a convenience which creates an instance of the
CreatePreparedStatementRequest.Builderavoiding the need to create one manually viaCreatePreparedStatementRequest.builder()- Parameters:
createPreparedStatementRequest- AConsumerthat will call methods onCreatePreparedStatementRequest.Builderto create a request.- Returns:
- Result of the CreatePreparedStatement operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
createPresignedNotebookUrl
default CreatePresignedNotebookUrlResponse createPresignedNotebookUrl(CreatePresignedNotebookUrlRequest createPresignedNotebookUrlRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Gets an authentication token and the URL at which the notebook can be accessed. During programmatic access,
CreatePresignedNotebookUrlmust be called every 10 minutes to refresh the authentication token. For information about granting programmatic access, see Grant programmatic access.- Parameters:
createPresignedNotebookUrlRequest-- Returns:
- Result of the CreatePresignedNotebookUrl operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
createPresignedNotebookUrl
default CreatePresignedNotebookUrlResponse createPresignedNotebookUrl(Consumer<CreatePresignedNotebookUrlRequest.Builder> createPresignedNotebookUrlRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Gets an authentication token and the URL at which the notebook can be accessed. During programmatic access,
CreatePresignedNotebookUrlmust 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.Builderavoiding the need to create one manually viaCreatePresignedNotebookUrlRequest.builder()- Parameters:
createPresignedNotebookUrlRequest- AConsumerthat will call methods onCreatePresignedNotebookUrlRequest.Builderto create a request.- Returns:
- Result of the CreatePresignedNotebookUrl operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
createWorkGroup
default CreateWorkGroupResponse createWorkGroup(CreateWorkGroupRequest createWorkGroupRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Creates a workgroup with the specified name. A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup.
- Parameters:
createWorkGroupRequest-- Returns:
- Result of the CreateWorkGroup operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
createWorkGroup
default CreateWorkGroupResponse createWorkGroup(Consumer<CreateWorkGroupRequest.Builder> createWorkGroupRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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.Builderavoiding the need to create one manually viaCreateWorkGroupRequest.builder()- Parameters:
createWorkGroupRequest- AConsumerthat will call methods onCreateWorkGroupRequest.Builderto create a request.- Returns:
- Result of the CreateWorkGroup operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteCapacityReservation
default DeleteCapacityReservationResponse deleteCapacityReservation(DeleteCapacityReservationRequest deleteCapacityReservationRequest) throws InvalidRequestException, InternalServerException, AwsServiceException, SdkClientException, AthenaException
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:
- Result of the DeleteCapacityReservation operation returned by the service.
- Throws:
InvalidRequestException- Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteCapacityReservation
default DeleteCapacityReservationResponse deleteCapacityReservation(Consumer<DeleteCapacityReservationRequest.Builder> deleteCapacityReservationRequest) throws InvalidRequestException, InternalServerException, AwsServiceException, SdkClientException, AthenaException
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.Builderavoiding the need to create one manually viaDeleteCapacityReservationRequest.builder()- Parameters:
deleteCapacityReservationRequest- AConsumerthat will call methods onDeleteCapacityReservationRequest.Builderto create a request.- Returns:
- Result of the DeleteCapacityReservation operation returned by the service.
- Throws:
InvalidRequestException- Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDataCatalog
default DeleteDataCatalogResponse deleteDataCatalog(DeleteDataCatalogRequest deleteDataCatalogRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Deletes a data catalog.
- Parameters:
deleteDataCatalogRequest-- Returns:
- Result of the DeleteDataCatalog operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDataCatalog
default DeleteDataCatalogResponse deleteDataCatalog(Consumer<DeleteDataCatalogRequest.Builder> deleteDataCatalogRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Deletes a data catalog.
This is a convenience which creates an instance of the
DeleteDataCatalogRequest.Builderavoiding the need to create one manually viaDeleteDataCatalogRequest.builder()- Parameters:
deleteDataCatalogRequest- AConsumerthat will call methods onDeleteDataCatalogRequest.Builderto create a request.- Returns:
- Result of the DeleteDataCatalog operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteNamedQuery
default DeleteNamedQueryResponse deleteNamedQuery(DeleteNamedQueryRequest deleteNamedQueryRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Deletes the named query if you have access to the workgroup in which the query was saved.
- Parameters:
deleteNamedQueryRequest-- Returns:
- Result of the DeleteNamedQuery operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteNamedQuery
default DeleteNamedQueryResponse deleteNamedQuery(Consumer<DeleteNamedQueryRequest.Builder> deleteNamedQueryRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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.Builderavoiding the need to create one manually viaDeleteNamedQueryRequest.builder()- Parameters:
deleteNamedQueryRequest- AConsumerthat will call methods onDeleteNamedQueryRequest.Builderto create a request.- Returns:
- Result of the DeleteNamedQuery operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteNotebook
default DeleteNotebookResponse deleteNotebook(DeleteNotebookRequest deleteNotebookRequest) throws InternalServerException, InvalidRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
Deletes the specified notebook.
- Parameters:
deleteNotebookRequest-- Returns:
- Result of the DeleteNotebook operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteNotebook
default DeleteNotebookResponse deleteNotebook(Consumer<DeleteNotebookRequest.Builder> deleteNotebookRequest) throws InternalServerException, InvalidRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
Deletes the specified notebook.
This is a convenience which creates an instance of the
DeleteNotebookRequest.Builderavoiding the need to create one manually viaDeleteNotebookRequest.builder()- Parameters:
deleteNotebookRequest- AConsumerthat will call methods onDeleteNotebookRequest.Builderto create a request.- Returns:
- Result of the DeleteNotebook operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
deletePreparedStatement
default DeletePreparedStatementResponse deletePreparedStatement(DeletePreparedStatementRequest deletePreparedStatementRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Deletes the prepared statement with the specified name from the specified workgroup.
- Parameters:
deletePreparedStatementRequest-- Returns:
- Result of the DeletePreparedStatement operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
deletePreparedStatement
default DeletePreparedStatementResponse deletePreparedStatement(Consumer<DeletePreparedStatementRequest.Builder> deletePreparedStatementRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Deletes the prepared statement with the specified name from the specified workgroup.
This is a convenience which creates an instance of the
DeletePreparedStatementRequest.Builderavoiding the need to create one manually viaDeletePreparedStatementRequest.builder()- Parameters:
deletePreparedStatementRequest- AConsumerthat will call methods onDeletePreparedStatementRequest.Builderto create a request.- Returns:
- Result of the DeletePreparedStatement operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWorkGroup
default DeleteWorkGroupResponse deleteWorkGroup(DeleteWorkGroupRequest deleteWorkGroupRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.
- Parameters:
deleteWorkGroupRequest-- Returns:
- Result of the DeleteWorkGroup operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWorkGroup
default DeleteWorkGroupResponse deleteWorkGroup(Consumer<DeleteWorkGroupRequest.Builder> deleteWorkGroupRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.
This is a convenience which creates an instance of the
DeleteWorkGroupRequest.Builderavoiding the need to create one manually viaDeleteWorkGroupRequest.builder()- Parameters:
deleteWorkGroupRequest- AConsumerthat will call methods onDeleteWorkGroupRequest.Builderto create a request.- Returns:
- Result of the DeleteWorkGroup operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
exportNotebook
default ExportNotebookResponse exportNotebook(ExportNotebookRequest exportNotebookRequest) throws InternalServerException, InvalidRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
Exports the specified notebook and its metadata.
- Parameters:
exportNotebookRequest-- Returns:
- Result of the ExportNotebook operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
exportNotebook
default ExportNotebookResponse exportNotebook(Consumer<ExportNotebookRequest.Builder> exportNotebookRequest) throws InternalServerException, InvalidRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
Exports the specified notebook and its metadata.
This is a convenience which creates an instance of the
ExportNotebookRequest.Builderavoiding the need to create one manually viaExportNotebookRequest.builder()- Parameters:
exportNotebookRequest- AConsumerthat will call methods onExportNotebookRequest.Builderto create a request.- Returns:
- Result of the ExportNotebook operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
getCalculationExecution
default GetCalculationExecutionResponse getCalculationExecution(GetCalculationExecutionRequest getCalculationExecutionRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Describes a previously submitted calculation execution.
- Parameters:
getCalculationExecutionRequest-- Returns:
- Result of the GetCalculationExecution operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
getCalculationExecution
default GetCalculationExecutionResponse getCalculationExecution(Consumer<GetCalculationExecutionRequest.Builder> getCalculationExecutionRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Describes a previously submitted calculation execution.
This is a convenience which creates an instance of the
GetCalculationExecutionRequest.Builderavoiding the need to create one manually viaGetCalculationExecutionRequest.builder()- Parameters:
getCalculationExecutionRequest- AConsumerthat will call methods onGetCalculationExecutionRequest.Builderto create a request.- Returns:
- Result of the GetCalculationExecution operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
getCalculationExecutionCode
default GetCalculationExecutionCodeResponse getCalculationExecutionCode(GetCalculationExecutionCodeRequest getCalculationExecutionCodeRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Retrieves the unencrypted code that was executed for the calculation.
- Parameters:
getCalculationExecutionCodeRequest-- Returns:
- Result of the GetCalculationExecutionCode operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
getCalculationExecutionCode
default GetCalculationExecutionCodeResponse getCalculationExecutionCode(Consumer<GetCalculationExecutionCodeRequest.Builder> getCalculationExecutionCodeRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Retrieves the unencrypted code that was executed for the calculation.
This is a convenience which creates an instance of the
GetCalculationExecutionCodeRequest.Builderavoiding the need to create one manually viaGetCalculationExecutionCodeRequest.builder()- Parameters:
getCalculationExecutionCodeRequest- AConsumerthat will call methods onGetCalculationExecutionCodeRequest.Builderto create a request.- Returns:
- Result of the GetCalculationExecutionCode operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
getCalculationExecutionStatus
default GetCalculationExecutionStatusResponse getCalculationExecutionStatus(GetCalculationExecutionStatusRequest getCalculationExecutionStatusRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Gets the status of a current calculation.
- Parameters:
getCalculationExecutionStatusRequest-- Returns:
- Result of the GetCalculationExecutionStatus operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
getCalculationExecutionStatus
default GetCalculationExecutionStatusResponse getCalculationExecutionStatus(Consumer<GetCalculationExecutionStatusRequest.Builder> getCalculationExecutionStatusRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Gets the status of a current calculation.
This is a convenience which creates an instance of the
GetCalculationExecutionStatusRequest.Builderavoiding the need to create one manually viaGetCalculationExecutionStatusRequest.builder()- Parameters:
getCalculationExecutionStatusRequest- AConsumerthat will call methods onGetCalculationExecutionStatusRequest.Builderto create a request.- Returns:
- Result of the GetCalculationExecutionStatus operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
getCapacityAssignmentConfiguration
default GetCapacityAssignmentConfigurationResponse getCapacityAssignmentConfiguration(GetCapacityAssignmentConfigurationRequest getCapacityAssignmentConfigurationRequest) throws InvalidRequestException, InternalServerException, AwsServiceException, SdkClientException, AthenaException
Gets the capacity assignment configuration for a capacity reservation, if one exists.
- Parameters:
getCapacityAssignmentConfigurationRequest-- Returns:
- Result of the GetCapacityAssignmentConfiguration operation returned by the service.
- Throws:
InvalidRequestException- Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.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.AwsServiceException- See Also:
- AWS API Documentation
-
getCapacityAssignmentConfiguration
default GetCapacityAssignmentConfigurationResponse getCapacityAssignmentConfiguration(Consumer<GetCapacityAssignmentConfigurationRequest.Builder> getCapacityAssignmentConfigurationRequest) throws InvalidRequestException, InternalServerException, AwsServiceException, SdkClientException, AthenaException
Gets the capacity assignment configuration for a capacity reservation, if one exists.
This is a convenience which creates an instance of the
GetCapacityAssignmentConfigurationRequest.Builderavoiding the need to create one manually viaGetCapacityAssignmentConfigurationRequest.builder()- Parameters:
getCapacityAssignmentConfigurationRequest- AConsumerthat will call methods onGetCapacityAssignmentConfigurationRequest.Builderto create a request.- Returns:
- Result of the GetCapacityAssignmentConfiguration operation returned by the service.
- Throws:
InvalidRequestException- Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.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.AwsServiceException- See Also:
- AWS API Documentation
-
getCapacityReservation
default GetCapacityReservationResponse getCapacityReservation(GetCapacityReservationRequest getCapacityReservationRequest) throws InvalidRequestException, InternalServerException, AwsServiceException, SdkClientException, AthenaException
Returns information about the capacity reservation with the specified name.
- Parameters:
getCapacityReservationRequest-- Returns:
- Result of the GetCapacityReservation operation returned by the service.
- Throws:
InvalidRequestException- Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.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.AwsServiceException- See Also:
- AWS API Documentation
-
getCapacityReservation
default GetCapacityReservationResponse getCapacityReservation(Consumer<GetCapacityReservationRequest.Builder> getCapacityReservationRequest) throws InvalidRequestException, InternalServerException, AwsServiceException, SdkClientException, AthenaException
Returns information about the capacity reservation with the specified name.
This is a convenience which creates an instance of the
GetCapacityReservationRequest.Builderavoiding the need to create one manually viaGetCapacityReservationRequest.builder()- Parameters:
getCapacityReservationRequest- AConsumerthat will call methods onGetCapacityReservationRequest.Builderto create a request.- Returns:
- Result of the GetCapacityReservation operation returned by the service.
- Throws:
InvalidRequestException- Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.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.AwsServiceException- See Also:
- AWS API Documentation
-
getDataCatalog
default GetDataCatalogResponse getDataCatalog(GetDataCatalogRequest getDataCatalogRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Returns the specified data catalog.
- Parameters:
getDataCatalogRequest-- Returns:
- Result of the GetDataCatalog operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
getDataCatalog
default GetDataCatalogResponse getDataCatalog(Consumer<GetDataCatalogRequest.Builder> getDataCatalogRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Returns the specified data catalog.
This is a convenience which creates an instance of the
GetDataCatalogRequest.Builderavoiding the need to create one manually viaGetDataCatalogRequest.builder()- Parameters:
getDataCatalogRequest- AConsumerthat will call methods onGetDataCatalogRequest.Builderto create a request.- Returns:
- Result of the GetDataCatalog operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
getDatabase
default GetDatabaseResponse getDatabase(GetDatabaseRequest getDatabaseRequest) throws InternalServerException, InvalidRequestException, MetadataException, AwsServiceException, SdkClientException, AthenaException
Returns a database object for the specified database and data catalog.
- Parameters:
getDatabaseRequest-- Returns:
- Result of the GetDatabase operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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 Lambda4XXexception 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.AwsServiceException- See Also:
- AWS API Documentation
-
getDatabase
default GetDatabaseResponse getDatabase(Consumer<GetDatabaseRequest.Builder> getDatabaseRequest) throws InternalServerException, InvalidRequestException, MetadataException, AwsServiceException, SdkClientException, AthenaException
Returns a database object for the specified database and data catalog.
This is a convenience which creates an instance of the
GetDatabaseRequest.Builderavoiding the need to create one manually viaGetDatabaseRequest.builder()- Parameters:
getDatabaseRequest- AConsumerthat will call methods onGetDatabaseRequest.Builderto create a request.- Returns:
- Result of the GetDatabase operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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 Lambda4XXexception 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.AwsServiceException- See Also:
- AWS API Documentation
-
getNamedQuery
default GetNamedQueryResponse getNamedQuery(GetNamedQueryRequest getNamedQueryRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.
- Parameters:
getNamedQueryRequest-- Returns:
- Result of the GetNamedQuery operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
getNamedQuery
default GetNamedQueryResponse getNamedQuery(Consumer<GetNamedQueryRequest.Builder> getNamedQueryRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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.Builderavoiding the need to create one manually viaGetNamedQueryRequest.builder()- Parameters:
getNamedQueryRequest- AConsumerthat will call methods onGetNamedQueryRequest.Builderto create a request.- Returns:
- Result of the GetNamedQuery operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
getNotebookMetadata
default GetNotebookMetadataResponse getNotebookMetadata(GetNotebookMetadataRequest getNotebookMetadataRequest) throws InternalServerException, InvalidRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
Retrieves notebook metadata for the specified notebook ID.
- Parameters:
getNotebookMetadataRequest-- Returns:
- Result of the GetNotebookMetadata operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
getNotebookMetadata
default GetNotebookMetadataResponse getNotebookMetadata(Consumer<GetNotebookMetadataRequest.Builder> getNotebookMetadataRequest) throws InternalServerException, InvalidRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
Retrieves notebook metadata for the specified notebook ID.
This is a convenience which creates an instance of the
GetNotebookMetadataRequest.Builderavoiding the need to create one manually viaGetNotebookMetadataRequest.builder()- Parameters:
getNotebookMetadataRequest- AConsumerthat will call methods onGetNotebookMetadataRequest.Builderto create a request.- Returns:
- Result of the GetNotebookMetadata operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
getPreparedStatement
default GetPreparedStatementResponse getPreparedStatement(GetPreparedStatementRequest getPreparedStatementRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Retrieves the prepared statement with the specified name from the specified workgroup.
- Parameters:
getPreparedStatementRequest-- Returns:
- Result of the GetPreparedStatement operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
getPreparedStatement
default GetPreparedStatementResponse getPreparedStatement(Consumer<GetPreparedStatementRequest.Builder> getPreparedStatementRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Retrieves the prepared statement with the specified name from the specified workgroup.
This is a convenience which creates an instance of the
GetPreparedStatementRequest.Builderavoiding the need to create one manually viaGetPreparedStatementRequest.builder()- Parameters:
getPreparedStatementRequest- AConsumerthat will call methods onGetPreparedStatementRequest.Builderto create a request.- Returns:
- Result of the GetPreparedStatement operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
getQueryExecution
default GetQueryExecutionResponse getQueryExecution(GetQueryExecutionRequest getQueryExecutionRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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:
- Result of the GetQueryExecution operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
getQueryExecution
default GetQueryExecutionResponse getQueryExecution(Consumer<GetQueryExecutionRequest.Builder> getQueryExecutionRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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.Builderavoiding the need to create one manually viaGetQueryExecutionRequest.builder()- Parameters:
getQueryExecutionRequest- AConsumerthat will call methods onGetQueryExecutionRequest.Builderto create a request.- Returns:
- Result of the GetQueryExecution operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
getQueryResults
default GetQueryResultsResponse getQueryResults(GetQueryResultsRequest getQueryResultsRequest) throws InternalServerException, InvalidRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
Streams the results of a single query execution specified by
QueryExecutionIdfrom 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
GetQueryResultsalso must have permissions to the Amazon S3GetObjectaction for the Athena query results location.IAM principals with permission to the Amazon S3
GetObjectaction for the query results location are able to retrieve query results from Amazon S3 even if permission to theGetQueryResultsaction is denied. To restrict user or role access, ensure that Amazon S3 permissions to the Athena query location are denied.- Parameters:
getQueryResultsRequest-- Returns:
- Result of the GetQueryResults operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
getQueryResults
default GetQueryResultsResponse getQueryResults(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest) throws InternalServerException, InvalidRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
Streams the results of a single query execution specified by
QueryExecutionIdfrom 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
GetQueryResultsalso must have permissions to the Amazon S3GetObjectaction for the Athena query results location.IAM principals with permission to the Amazon S3
GetObjectaction for the query results location are able to retrieve query results from Amazon S3 even if permission to theGetQueryResultsaction 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.Builderavoiding the need to create one manually viaGetQueryResultsRequest.builder()- Parameters:
getQueryResultsRequest- AConsumerthat will call methods onGetQueryResultsRequest.Builderto create a request.- Returns:
- Result of the GetQueryResults operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
getQueryResultsPaginator
default GetQueryResultsIterable getQueryResultsPaginator(GetQueryResultsRequest getQueryResultsRequest) throws InternalServerException, InvalidRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
getQueryResults(software.amazon.awssdk.services.athena.model.GetQueryResultsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.GetQueryResultsIterable responses = client.getQueryResultsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.GetQueryResultsIterable responses = client .getQueryResultsPaginator(request); for (software.amazon.awssdk.services.athena.model.GetQueryResultsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.GetQueryResultsIterable responses = client.getQueryResultsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getQueryResultsPaginator
default GetQueryResultsIterable getQueryResultsPaginator(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest) throws InternalServerException, InvalidRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
getQueryResults(software.amazon.awssdk.services.athena.model.GetQueryResultsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.GetQueryResultsIterable responses = client.getQueryResultsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.GetQueryResultsIterable responses = client .getQueryResultsPaginator(request); for (software.amazon.awssdk.services.athena.model.GetQueryResultsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.GetQueryResultsIterable responses = client.getQueryResultsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaGetQueryResultsRequest.builder()- Parameters:
getQueryResultsRequest- AConsumerthat will call methods onGetQueryResultsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getQueryRuntimeStatistics
default GetQueryRuntimeStatisticsResponse getQueryRuntimeStatistics(GetQueryRuntimeStatisticsRequest getQueryRuntimeStatisticsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Returns query execution runtime statistics related to a single execution of a query if you have access to the workgroup in which the query ran. Statistics from the
Timelinesection of the response object are available as soon as QueryExecutionStatus$State is in a SUCCEEDED or FAILED state. The remaining non-timeline statistics in the response (like stage-level input and output row count and data size) are updated asynchronously and may not be available immediately after a query completes. The non-timeline statistics are also not included when a query has row-level filters defined in Lake Formation.- Parameters:
getQueryRuntimeStatisticsRequest-- Returns:
- Result of the GetQueryRuntimeStatistics operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
getQueryRuntimeStatistics
default GetQueryRuntimeStatisticsResponse getQueryRuntimeStatistics(Consumer<GetQueryRuntimeStatisticsRequest.Builder> getQueryRuntimeStatisticsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Returns query execution runtime statistics related to a single execution of a query if you have access to the workgroup in which the query ran. Statistics from the
Timelinesection of the response object are available as soon as QueryExecutionStatus$State is in a SUCCEEDED or FAILED state. The remaining non-timeline statistics in the response (like stage-level input and output row count and data size) are updated asynchronously and may not be available immediately after a query completes. The non-timeline statistics are also not included when a query has row-level filters defined in Lake Formation.
This is a convenience which creates an instance of the
GetQueryRuntimeStatisticsRequest.Builderavoiding the need to create one manually viaGetQueryRuntimeStatisticsRequest.builder()- Parameters:
getQueryRuntimeStatisticsRequest- AConsumerthat will call methods onGetQueryRuntimeStatisticsRequest.Builderto create a request.- Returns:
- Result of the GetQueryRuntimeStatistics operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
getSession
default GetSessionResponse getSession(GetSessionRequest getSessionRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Gets the full details of a previously created session, including the session status and configuration.
- Parameters:
getSessionRequest-- Returns:
- Result of the GetSession operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
getSession
default GetSessionResponse getSession(Consumer<GetSessionRequest.Builder> getSessionRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
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.Builderavoiding the need to create one manually viaGetSessionRequest.builder()- Parameters:
getSessionRequest- AConsumerthat will call methods onGetSessionRequest.Builderto create a request.- Returns:
- Result of the GetSession operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
getSessionStatus
default GetSessionStatusResponse getSessionStatus(GetSessionStatusRequest getSessionStatusRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Gets the current status of a session.
- Parameters:
getSessionStatusRequest-- Returns:
- Result of the GetSessionStatus operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
getSessionStatus
default GetSessionStatusResponse getSessionStatus(Consumer<GetSessionStatusRequest.Builder> getSessionStatusRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Gets the current status of a session.
This is a convenience which creates an instance of the
GetSessionStatusRequest.Builderavoiding the need to create one manually viaGetSessionStatusRequest.builder()- Parameters:
getSessionStatusRequest- AConsumerthat will call methods onGetSessionStatusRequest.Builderto create a request.- Returns:
- Result of the GetSessionStatus operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
getTableMetadata
default GetTableMetadataResponse getTableMetadata(GetTableMetadataRequest getTableMetadataRequest) throws InternalServerException, InvalidRequestException, MetadataException, AwsServiceException, SdkClientException, AthenaException
Returns table metadata for the specified catalog, database, and table.
- Parameters:
getTableMetadataRequest-- Returns:
- Result of the GetTableMetadata operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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 Lambda4XXexception 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.AwsServiceException- See Also:
- AWS API Documentation
-
getTableMetadata
default GetTableMetadataResponse getTableMetadata(Consumer<GetTableMetadataRequest.Builder> getTableMetadataRequest) throws InternalServerException, InvalidRequestException, MetadataException, AwsServiceException, SdkClientException, AthenaException
Returns table metadata for the specified catalog, database, and table.
This is a convenience which creates an instance of the
GetTableMetadataRequest.Builderavoiding the need to create one manually viaGetTableMetadataRequest.builder()- Parameters:
getTableMetadataRequest- AConsumerthat will call methods onGetTableMetadataRequest.Builderto create a request.- Returns:
- Result of the GetTableMetadata operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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 Lambda4XXexception 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.AwsServiceException- See Also:
- AWS API Documentation
-
getWorkGroup
default GetWorkGroupResponse getWorkGroup(GetWorkGroupRequest getWorkGroupRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Returns information about the workgroup with the specified name.
- Parameters:
getWorkGroupRequest-- Returns:
- Result of the GetWorkGroup operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
getWorkGroup
default GetWorkGroupResponse getWorkGroup(Consumer<GetWorkGroupRequest.Builder> getWorkGroupRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Returns information about the workgroup with the specified name.
This is a convenience which creates an instance of the
GetWorkGroupRequest.Builderavoiding the need to create one manually viaGetWorkGroupRequest.builder()- Parameters:
getWorkGroupRequest- AConsumerthat will call methods onGetWorkGroupRequest.Builderto create a request.- Returns:
- Result of the GetWorkGroup operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
importNotebook
default ImportNotebookResponse importNotebook(ImportNotebookRequest importNotebookRequest) throws InternalServerException, InvalidRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
Imports a single
ipynbfile to a Spark enabled workgroup. To import the notebook, the request must specify a value for eitherPayloadorNoteBookS3LocationUri. If neither is specified or both are specified, anInvalidRequestExceptionoccurs. The maximum file size that can be imported is 10 megabytes. If anipynbfile with the same name already exists in the workgroup, throws an error.- Parameters:
importNotebookRequest-- Returns:
- Result of the ImportNotebook operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
importNotebook
default ImportNotebookResponse importNotebook(Consumer<ImportNotebookRequest.Builder> importNotebookRequest) throws InternalServerException, InvalidRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
Imports a single
ipynbfile to a Spark enabled workgroup. To import the notebook, the request must specify a value for eitherPayloadorNoteBookS3LocationUri. If neither is specified or both are specified, anInvalidRequestExceptionoccurs. The maximum file size that can be imported is 10 megabytes. If anipynbfile with the same name already exists in the workgroup, throws an error.
This is a convenience which creates an instance of the
ImportNotebookRequest.Builderavoiding the need to create one manually viaImportNotebookRequest.builder()- Parameters:
importNotebookRequest- AConsumerthat will call methods onImportNotebookRequest.Builderto create a request.- Returns:
- Result of the ImportNotebook operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationDPUSizes
default ListApplicationDpuSizesResponse listApplicationDPUSizes(ListApplicationDpuSizesRequest listApplicationDpuSizesRequest) throws InternalServerException, InvalidRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
Returns the supported DPU sizes for the supported application runtimes (for example,
Athena notebook version 1).- Parameters:
listApplicationDpuSizesRequest-- Returns:
- Result of the ListApplicationDPUSizes operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationDPUSizes
default ListApplicationDpuSizesResponse listApplicationDPUSizes(Consumer<ListApplicationDpuSizesRequest.Builder> listApplicationDpuSizesRequest) throws InternalServerException, InvalidRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
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.Builderavoiding the need to create one manually viaListApplicationDpuSizesRequest.builder()- Parameters:
listApplicationDpuSizesRequest- AConsumerthat will call methods onListApplicationDpuSizesRequest.Builderto create a request.- Returns:
- Result of the ListApplicationDPUSizes operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationDPUSizesPaginator
default ListApplicationDPUSizesIterable listApplicationDPUSizesPaginator(ListApplicationDpuSizesRequest listApplicationDpuSizesRequest) throws InternalServerException, InvalidRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listApplicationDPUSizes(software.amazon.awssdk.services.athena.model.ListApplicationDpuSizesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListApplicationDPUSizesIterable responses = client.listApplicationDPUSizesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListApplicationDPUSizesIterable responses = client .listApplicationDPUSizesPaginator(request); for (software.amazon.awssdk.services.athena.model.ListApplicationDpuSizesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListApplicationDPUSizesIterable responses = client.listApplicationDPUSizesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationDPUSizesPaginator
default ListApplicationDPUSizesIterable listApplicationDPUSizesPaginator(Consumer<ListApplicationDpuSizesRequest.Builder> listApplicationDpuSizesRequest) throws InternalServerException, InvalidRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listApplicationDPUSizes(software.amazon.awssdk.services.athena.model.ListApplicationDpuSizesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListApplicationDPUSizesIterable responses = client.listApplicationDPUSizesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListApplicationDPUSizesIterable responses = client .listApplicationDPUSizesPaginator(request); for (software.amazon.awssdk.services.athena.model.ListApplicationDpuSizesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListApplicationDPUSizesIterable responses = client.listApplicationDPUSizesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListApplicationDpuSizesRequest.builder()- Parameters:
listApplicationDpuSizesRequest- AConsumerthat will call methods onListApplicationDpuSizesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listCalculationExecutions
default ListCalculationExecutionsResponse listCalculationExecutions(ListCalculationExecutionsRequest listCalculationExecutionsRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
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:
- Result of the ListCalculationExecutions operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
listCalculationExecutions
default ListCalculationExecutionsResponse listCalculationExecutions(Consumer<ListCalculationExecutionsRequest.Builder> listCalculationExecutionsRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
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.Builderavoiding the need to create one manually viaListCalculationExecutionsRequest.builder()- Parameters:
listCalculationExecutionsRequest- AConsumerthat will call methods onListCalculationExecutionsRequest.Builderto create a request.- Returns:
- Result of the ListCalculationExecutions operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
listCalculationExecutionsPaginator
default ListCalculationExecutionsIterable listCalculationExecutionsPaginator(ListCalculationExecutionsRequest listCalculationExecutionsRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listCalculationExecutions(software.amazon.awssdk.services.athena.model.ListCalculationExecutionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListCalculationExecutionsIterable responses = client.listCalculationExecutionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListCalculationExecutionsIterable responses = client .listCalculationExecutionsPaginator(request); for (software.amazon.awssdk.services.athena.model.ListCalculationExecutionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListCalculationExecutionsIterable responses = client.listCalculationExecutionsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listCalculationExecutionsPaginator
default ListCalculationExecutionsIterable listCalculationExecutionsPaginator(Consumer<ListCalculationExecutionsRequest.Builder> listCalculationExecutionsRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listCalculationExecutions(software.amazon.awssdk.services.athena.model.ListCalculationExecutionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListCalculationExecutionsIterable responses = client.listCalculationExecutionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListCalculationExecutionsIterable responses = client .listCalculationExecutionsPaginator(request); for (software.amazon.awssdk.services.athena.model.ListCalculationExecutionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListCalculationExecutionsIterable responses = client.listCalculationExecutionsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListCalculationExecutionsRequest.builder()- Parameters:
listCalculationExecutionsRequest- AConsumerthat will call methods onListCalculationExecutionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listCapacityReservations
default ListCapacityReservationsResponse listCapacityReservations(ListCapacityReservationsRequest listCapacityReservationsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Lists the capacity reservations for the current account.
- Parameters:
listCapacityReservationsRequest-- Returns:
- Result of the ListCapacityReservations operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
listCapacityReservations
default ListCapacityReservationsResponse listCapacityReservations(Consumer<ListCapacityReservationsRequest.Builder> listCapacityReservationsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Lists the capacity reservations for the current account.
This is a convenience which creates an instance of the
ListCapacityReservationsRequest.Builderavoiding the need to create one manually viaListCapacityReservationsRequest.builder()- Parameters:
listCapacityReservationsRequest- AConsumerthat will call methods onListCapacityReservationsRequest.Builderto create a request.- Returns:
- Result of the ListCapacityReservations operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
listCapacityReservationsPaginator
default ListCapacityReservationsIterable listCapacityReservationsPaginator(ListCapacityReservationsRequest listCapacityReservationsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listCapacityReservations(software.amazon.awssdk.services.athena.model.ListCapacityReservationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListCapacityReservationsIterable responses = client.listCapacityReservationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListCapacityReservationsIterable responses = client .listCapacityReservationsPaginator(request); for (software.amazon.awssdk.services.athena.model.ListCapacityReservationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListCapacityReservationsIterable responses = client.listCapacityReservationsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listCapacityReservationsPaginator
default ListCapacityReservationsIterable listCapacityReservationsPaginator(Consumer<ListCapacityReservationsRequest.Builder> listCapacityReservationsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listCapacityReservations(software.amazon.awssdk.services.athena.model.ListCapacityReservationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListCapacityReservationsIterable responses = client.listCapacityReservationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListCapacityReservationsIterable responses = client .listCapacityReservationsPaginator(request); for (software.amazon.awssdk.services.athena.model.ListCapacityReservationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListCapacityReservationsIterable responses = client.listCapacityReservationsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListCapacityReservationsRequest.builder()- Parameters:
listCapacityReservationsRequest- AConsumerthat will call methods onListCapacityReservationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDataCatalogs
default ListDataCatalogsResponse listDataCatalogs(ListDataCatalogsRequest listDataCatalogsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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:
- Result of the ListDataCatalogs operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
listDataCatalogs
default ListDataCatalogsResponse listDataCatalogs(Consumer<ListDataCatalogsRequest.Builder> listDataCatalogsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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.Builderavoiding the need to create one manually viaListDataCatalogsRequest.builder()- Parameters:
listDataCatalogsRequest- AConsumerthat will call methods onListDataCatalogsRequest.Builderto create a request.- Returns:
- Result of the ListDataCatalogs operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
listDataCatalogsPaginator
default ListDataCatalogsIterable listDataCatalogsPaginator(ListDataCatalogsRequest listDataCatalogsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listDataCatalogs(software.amazon.awssdk.services.athena.model.ListDataCatalogsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListDataCatalogsIterable responses = client.listDataCatalogsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListDataCatalogsIterable responses = client .listDataCatalogsPaginator(request); for (software.amazon.awssdk.services.athena.model.ListDataCatalogsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListDataCatalogsIterable responses = client.listDataCatalogsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDataCatalogsPaginator
default ListDataCatalogsIterable listDataCatalogsPaginator(Consumer<ListDataCatalogsRequest.Builder> listDataCatalogsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listDataCatalogs(software.amazon.awssdk.services.athena.model.ListDataCatalogsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListDataCatalogsIterable responses = client.listDataCatalogsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListDataCatalogsIterable responses = client .listDataCatalogsPaginator(request); for (software.amazon.awssdk.services.athena.model.ListDataCatalogsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListDataCatalogsIterable responses = client.listDataCatalogsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListDataCatalogsRequest.builder()- Parameters:
listDataCatalogsRequest- AConsumerthat will call methods onListDataCatalogsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDatabases
default ListDatabasesResponse listDatabases(ListDatabasesRequest listDatabasesRequest) throws InternalServerException, InvalidRequestException, MetadataException, AwsServiceException, SdkClientException, AthenaException
Lists the databases in the specified data catalog.
- Parameters:
listDatabasesRequest-- Returns:
- Result of the ListDatabases operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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 Lambda4XXexception 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.AwsServiceException- See Also:
- AWS API Documentation
-
listDatabases
default ListDatabasesResponse listDatabases(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest) throws InternalServerException, InvalidRequestException, MetadataException, AwsServiceException, SdkClientException, AthenaException
Lists the databases in the specified data catalog.
This is a convenience which creates an instance of the
ListDatabasesRequest.Builderavoiding the need to create one manually viaListDatabasesRequest.builder()- Parameters:
listDatabasesRequest- AConsumerthat will call methods onListDatabasesRequest.Builderto create a request.- Returns:
- Result of the ListDatabases operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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 Lambda4XXexception 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.AwsServiceException- See Also:
- AWS API Documentation
-
listDatabasesPaginator
default ListDatabasesIterable listDatabasesPaginator(ListDatabasesRequest listDatabasesRequest) throws InternalServerException, InvalidRequestException, MetadataException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listDatabases(software.amazon.awssdk.services.athena.model.ListDatabasesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListDatabasesIterable responses = client.listDatabasesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListDatabasesIterable responses = client.listDatabasesPaginator(request); for (software.amazon.awssdk.services.athena.model.ListDatabasesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListDatabasesIterable responses = client.listDatabasesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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 Lambda4XXexception 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.AwsServiceException- See Also:
- AWS API Documentation
-
listDatabasesPaginator
default ListDatabasesIterable listDatabasesPaginator(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest) throws InternalServerException, InvalidRequestException, MetadataException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listDatabases(software.amazon.awssdk.services.athena.model.ListDatabasesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListDatabasesIterable responses = client.listDatabasesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListDatabasesIterable responses = client.listDatabasesPaginator(request); for (software.amazon.awssdk.services.athena.model.ListDatabasesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListDatabasesIterable responses = client.listDatabasesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListDatabasesRequest.builder()- Parameters:
listDatabasesRequest- AConsumerthat will call methods onListDatabasesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 Lambda4XXexception 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.AwsServiceException- See Also:
- AWS API Documentation
-
listEngineVersions
default ListEngineVersionsResponse listEngineVersions(ListEngineVersionsRequest listEngineVersionsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Returns a list of engine versions that are available to choose from, including the Auto option.
- Parameters:
listEngineVersionsRequest-- Returns:
- Result of the ListEngineVersions operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
listEngineVersions
default ListEngineVersionsResponse listEngineVersions(Consumer<ListEngineVersionsRequest.Builder> listEngineVersionsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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.Builderavoiding the need to create one manually viaListEngineVersionsRequest.builder()- Parameters:
listEngineVersionsRequest- AConsumerthat will call methods onListEngineVersionsRequest.Builderto create a request.- Returns:
- Result of the ListEngineVersions operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
listEngineVersionsPaginator
default ListEngineVersionsIterable listEngineVersionsPaginator(ListEngineVersionsRequest listEngineVersionsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listEngineVersions(software.amazon.awssdk.services.athena.model.ListEngineVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListEngineVersionsIterable responses = client.listEngineVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListEngineVersionsIterable responses = client .listEngineVersionsPaginator(request); for (software.amazon.awssdk.services.athena.model.ListEngineVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListEngineVersionsIterable responses = client.listEngineVersionsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listEngineVersionsPaginator
default ListEngineVersionsIterable listEngineVersionsPaginator(Consumer<ListEngineVersionsRequest.Builder> listEngineVersionsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listEngineVersions(software.amazon.awssdk.services.athena.model.ListEngineVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListEngineVersionsIterable responses = client.listEngineVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListEngineVersionsIterable responses = client .listEngineVersionsPaginator(request); for (software.amazon.awssdk.services.athena.model.ListEngineVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListEngineVersionsIterable responses = client.listEngineVersionsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListEngineVersionsRequest.builder()- Parameters:
listEngineVersionsRequest- AConsumerthat will call methods onListEngineVersionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listExecutors
default ListExecutorsResponse listExecutors(ListExecutorsRequest listExecutorsRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
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:
- Result of the ListExecutors operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
listExecutors
default ListExecutorsResponse listExecutors(Consumer<ListExecutorsRequest.Builder> listExecutorsRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
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.Builderavoiding the need to create one manually viaListExecutorsRequest.builder()- Parameters:
listExecutorsRequest- AConsumerthat will call methods onListExecutorsRequest.Builderto create a request.- Returns:
- Result of the ListExecutors operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
listExecutorsPaginator
default ListExecutorsIterable listExecutorsPaginator(ListExecutorsRequest listExecutorsRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listExecutors(software.amazon.awssdk.services.athena.model.ListExecutorsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListExecutorsIterable responses = client.listExecutorsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListExecutorsIterable responses = client.listExecutorsPaginator(request); for (software.amazon.awssdk.services.athena.model.ListExecutorsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListExecutorsIterable responses = client.listExecutorsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listExecutorsPaginator
default ListExecutorsIterable listExecutorsPaginator(Consumer<ListExecutorsRequest.Builder> listExecutorsRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listExecutors(software.amazon.awssdk.services.athena.model.ListExecutorsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListExecutorsIterable responses = client.listExecutorsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListExecutorsIterable responses = client.listExecutorsPaginator(request); for (software.amazon.awssdk.services.athena.model.ListExecutorsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListExecutorsIterable responses = client.listExecutorsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListExecutorsRequest.builder()- Parameters:
listExecutorsRequest- AConsumerthat will call methods onListExecutorsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listNamedQueries
default ListNamedQueriesResponse listNamedQueries(ListNamedQueriesRequest listNamedQueriesRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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:
- Result of the ListNamedQueries operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
listNamedQueries
default ListNamedQueriesResponse listNamedQueries(Consumer<ListNamedQueriesRequest.Builder> listNamedQueriesRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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.Builderavoiding the need to create one manually viaListNamedQueriesRequest.builder()- Parameters:
listNamedQueriesRequest- AConsumerthat will call methods onListNamedQueriesRequest.Builderto create a request.- Returns:
- Result of the ListNamedQueries operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
listNamedQueries
default ListNamedQueriesResponse listNamedQueries() throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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:
- Result of the ListNamedQueries operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
listNamedQueries(ListNamedQueriesRequest), AWS API Documentation
-
listNamedQueriesPaginator
default ListNamedQueriesIterable listNamedQueriesPaginator() throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listNamedQueries(software.amazon.awssdk.services.athena.model.ListNamedQueriesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListNamedQueriesIterable responses = client.listNamedQueriesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListNamedQueriesIterable responses = client .listNamedQueriesPaginator(request); for (software.amazon.awssdk.services.athena.model.ListNamedQueriesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListNamedQueriesIterable responses = client.listNamedQueriesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
listNamedQueriesPaginator(ListNamedQueriesRequest), AWS API Documentation
-
listNamedQueriesPaginator
default ListNamedQueriesIterable listNamedQueriesPaginator(ListNamedQueriesRequest listNamedQueriesRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listNamedQueries(software.amazon.awssdk.services.athena.model.ListNamedQueriesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListNamedQueriesIterable responses = client.listNamedQueriesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListNamedQueriesIterable responses = client .listNamedQueriesPaginator(request); for (software.amazon.awssdk.services.athena.model.ListNamedQueriesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListNamedQueriesIterable responses = client.listNamedQueriesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listNamedQueriesPaginator
default ListNamedQueriesIterable listNamedQueriesPaginator(Consumer<ListNamedQueriesRequest.Builder> listNamedQueriesRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listNamedQueries(software.amazon.awssdk.services.athena.model.ListNamedQueriesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListNamedQueriesIterable responses = client.listNamedQueriesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListNamedQueriesIterable responses = client .listNamedQueriesPaginator(request); for (software.amazon.awssdk.services.athena.model.ListNamedQueriesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListNamedQueriesIterable responses = client.listNamedQueriesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListNamedQueriesRequest.builder()- Parameters:
listNamedQueriesRequest- AConsumerthat will call methods onListNamedQueriesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listNotebookMetadata
default ListNotebookMetadataResponse listNotebookMetadata(ListNotebookMetadataRequest listNotebookMetadataRequest) throws InternalServerException, InvalidRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
Displays the notebook files for the specified workgroup in paginated format.
- Parameters:
listNotebookMetadataRequest-- Returns:
- Result of the ListNotebookMetadata operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
listNotebookMetadata
default ListNotebookMetadataResponse listNotebookMetadata(Consumer<ListNotebookMetadataRequest.Builder> listNotebookMetadataRequest) throws InternalServerException, InvalidRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
Displays the notebook files for the specified workgroup in paginated format.
This is a convenience which creates an instance of the
ListNotebookMetadataRequest.Builderavoiding the need to create one manually viaListNotebookMetadataRequest.builder()- Parameters:
listNotebookMetadataRequest- AConsumerthat will call methods onListNotebookMetadataRequest.Builderto create a request.- Returns:
- Result of the ListNotebookMetadata operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
listNotebookSessions
default ListNotebookSessionsResponse listNotebookSessions(ListNotebookSessionsRequest listNotebookSessionsRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Lists, in descending order, the sessions that have been created in a notebook that are in an active state like
CREATING,CREATED,IDLEorBUSY. Newer sessions are listed first; older sessions are listed later.- Parameters:
listNotebookSessionsRequest-- Returns:
- Result of the ListNotebookSessions operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
listNotebookSessions
default ListNotebookSessionsResponse listNotebookSessions(Consumer<ListNotebookSessionsRequest.Builder> listNotebookSessionsRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Lists, in descending order, the sessions that have been created in a notebook that are in an active state like
CREATING,CREATED,IDLEorBUSY. Newer sessions are listed first; older sessions are listed later.
This is a convenience which creates an instance of the
ListNotebookSessionsRequest.Builderavoiding the need to create one manually viaListNotebookSessionsRequest.builder()- Parameters:
listNotebookSessionsRequest- AConsumerthat will call methods onListNotebookSessionsRequest.Builderto create a request.- Returns:
- Result of the ListNotebookSessions operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
listPreparedStatements
default ListPreparedStatementsResponse listPreparedStatements(ListPreparedStatementsRequest listPreparedStatementsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Lists the prepared statements in the specified workgroup.
- Parameters:
listPreparedStatementsRequest-- Returns:
- Result of the ListPreparedStatements operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
listPreparedStatements
default ListPreparedStatementsResponse listPreparedStatements(Consumer<ListPreparedStatementsRequest.Builder> listPreparedStatementsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Lists the prepared statements in the specified workgroup.
This is a convenience which creates an instance of the
ListPreparedStatementsRequest.Builderavoiding the need to create one manually viaListPreparedStatementsRequest.builder()- Parameters:
listPreparedStatementsRequest- AConsumerthat will call methods onListPreparedStatementsRequest.Builderto create a request.- Returns:
- Result of the ListPreparedStatements operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
listPreparedStatementsPaginator
default ListPreparedStatementsIterable listPreparedStatementsPaginator(ListPreparedStatementsRequest listPreparedStatementsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listPreparedStatements(software.amazon.awssdk.services.athena.model.ListPreparedStatementsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListPreparedStatementsIterable responses = client.listPreparedStatementsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListPreparedStatementsIterable responses = client .listPreparedStatementsPaginator(request); for (software.amazon.awssdk.services.athena.model.ListPreparedStatementsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListPreparedStatementsIterable responses = client.listPreparedStatementsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listPreparedStatementsPaginator
default ListPreparedStatementsIterable listPreparedStatementsPaginator(Consumer<ListPreparedStatementsRequest.Builder> listPreparedStatementsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listPreparedStatements(software.amazon.awssdk.services.athena.model.ListPreparedStatementsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListPreparedStatementsIterable responses = client.listPreparedStatementsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListPreparedStatementsIterable responses = client .listPreparedStatementsPaginator(request); for (software.amazon.awssdk.services.athena.model.ListPreparedStatementsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListPreparedStatementsIterable responses = client.listPreparedStatementsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListPreparedStatementsRequest.builder()- Parameters:
listPreparedStatementsRequest- AConsumerthat will call methods onListPreparedStatementsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listQueryExecutions
default ListQueryExecutionsResponse listQueryExecutions(ListQueryExecutionsRequest listQueryExecutionsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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:
- Result of the ListQueryExecutions operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
listQueryExecutions
default ListQueryExecutionsResponse listQueryExecutions(Consumer<ListQueryExecutionsRequest.Builder> listQueryExecutionsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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.Builderavoiding the need to create one manually viaListQueryExecutionsRequest.builder()- Parameters:
listQueryExecutionsRequest- AConsumerthat will call methods onListQueryExecutionsRequest.Builderto create a request.- Returns:
- Result of the ListQueryExecutions operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
listQueryExecutions
default ListQueryExecutionsResponse listQueryExecutions() throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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:
- Result of the ListQueryExecutions operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
listQueryExecutions(ListQueryExecutionsRequest), AWS API Documentation
-
listQueryExecutionsPaginator
default ListQueryExecutionsIterable listQueryExecutionsPaginator() throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listQueryExecutions(software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListQueryExecutionsIterable responses = client.listQueryExecutionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListQueryExecutionsIterable responses = client .listQueryExecutionsPaginator(request); for (software.amazon.awssdk.services.athena.model.ListQueryExecutionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListQueryExecutionsIterable responses = client.listQueryExecutionsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
listQueryExecutionsPaginator(ListQueryExecutionsRequest), AWS API Documentation
-
listQueryExecutionsPaginator
default ListQueryExecutionsIterable listQueryExecutionsPaginator(ListQueryExecutionsRequest listQueryExecutionsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listQueryExecutions(software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListQueryExecutionsIterable responses = client.listQueryExecutionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListQueryExecutionsIterable responses = client .listQueryExecutionsPaginator(request); for (software.amazon.awssdk.services.athena.model.ListQueryExecutionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListQueryExecutionsIterable responses = client.listQueryExecutionsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listQueryExecutionsPaginator
default ListQueryExecutionsIterable listQueryExecutionsPaginator(Consumer<ListQueryExecutionsRequest.Builder> listQueryExecutionsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listQueryExecutions(software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListQueryExecutionsIterable responses = client.listQueryExecutionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListQueryExecutionsIterable responses = client .listQueryExecutionsPaginator(request); for (software.amazon.awssdk.services.athena.model.ListQueryExecutionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListQueryExecutionsIterable responses = client.listQueryExecutionsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListQueryExecutionsRequest.builder()- Parameters:
listQueryExecutionsRequest- AConsumerthat will call methods onListQueryExecutionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listSessions
default ListSessionsResponse listSessions(ListSessionsRequest listSessionsRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
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:
- Result of the ListSessions operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
listSessions
default ListSessionsResponse listSessions(Consumer<ListSessionsRequest.Builder> listSessionsRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
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.Builderavoiding the need to create one manually viaListSessionsRequest.builder()- Parameters:
listSessionsRequest- AConsumerthat will call methods onListSessionsRequest.Builderto create a request.- Returns:
- Result of the ListSessions operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
listSessionsPaginator
default ListSessionsIterable listSessionsPaginator(ListSessionsRequest listSessionsRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listSessions(software.amazon.awssdk.services.athena.model.ListSessionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListSessionsIterable responses = client.listSessionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListSessionsIterable responses = client.listSessionsPaginator(request); for (software.amazon.awssdk.services.athena.model.ListSessionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListSessionsIterable responses = client.listSessionsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listSessionsPaginator
default ListSessionsIterable listSessionsPaginator(Consumer<ListSessionsRequest.Builder> listSessionsRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listSessions(software.amazon.awssdk.services.athena.model.ListSessionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListSessionsIterable responses = client.listSessionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListSessionsIterable responses = client.listSessionsPaginator(request); for (software.amazon.awssdk.services.athena.model.ListSessionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListSessionsIterable responses = client.listSessionsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListSessionsRequest.builder()- Parameters:
listSessionsRequest- AConsumerthat will call methods onListSessionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTableMetadata
default ListTableMetadataResponse listTableMetadata(ListTableMetadataRequest listTableMetadataRequest) throws InternalServerException, InvalidRequestException, MetadataException, AwsServiceException, SdkClientException, AthenaException
Lists the metadata for the tables in the specified data catalog database.
- Parameters:
listTableMetadataRequest-- Returns:
- Result of the ListTableMetadata operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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 Lambda4XXexception 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTableMetadata
default ListTableMetadataResponse listTableMetadata(Consumer<ListTableMetadataRequest.Builder> listTableMetadataRequest) throws InternalServerException, InvalidRequestException, MetadataException, AwsServiceException, SdkClientException, AthenaException
Lists the metadata for the tables in the specified data catalog database.
This is a convenience which creates an instance of the
ListTableMetadataRequest.Builderavoiding the need to create one manually viaListTableMetadataRequest.builder()- Parameters:
listTableMetadataRequest- AConsumerthat will call methods onListTableMetadataRequest.Builderto create a request.- Returns:
- Result of the ListTableMetadata operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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 Lambda4XXexception 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTableMetadataPaginator
default ListTableMetadataIterable listTableMetadataPaginator(ListTableMetadataRequest listTableMetadataRequest) throws InternalServerException, InvalidRequestException, MetadataException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listTableMetadata(software.amazon.awssdk.services.athena.model.ListTableMetadataRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListTableMetadataIterable responses = client.listTableMetadataPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListTableMetadataIterable responses = client .listTableMetadataPaginator(request); for (software.amazon.awssdk.services.athena.model.ListTableMetadataResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListTableMetadataIterable responses = client.listTableMetadataPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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 Lambda4XXexception 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTableMetadataPaginator
default ListTableMetadataIterable listTableMetadataPaginator(Consumer<ListTableMetadataRequest.Builder> listTableMetadataRequest) throws InternalServerException, InvalidRequestException, MetadataException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listTableMetadata(software.amazon.awssdk.services.athena.model.ListTableMetadataRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListTableMetadataIterable responses = client.listTableMetadataPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListTableMetadataIterable responses = client .listTableMetadataPaginator(request); for (software.amazon.awssdk.services.athena.model.ListTableMetadataResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListTableMetadataIterable responses = client.listTableMetadataPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListTableMetadataRequest.builder()- Parameters:
listTableMetadataRequest- AConsumerthat will call methods onListTableMetadataRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 Lambda4XXexception 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Lists the tags associated with an Athena resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Lists the tags associated with an Athena resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResourcePaginator
default ListTagsForResourceIterable listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listTagsForResource(software.amazon.awssdk.services.athena.model.ListTagsForResourceRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListTagsForResourceIterable responses = client .listTagsForResourcePaginator(request); for (software.amazon.awssdk.services.athena.model.ListTagsForResourceResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResourcePaginator
default ListTagsForResourceIterable listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listTagsForResource(software.amazon.awssdk.services.athena.model.ListTagsForResourceRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListTagsForResourceIterable responses = client .listTagsForResourcePaginator(request); for (software.amazon.awssdk.services.athena.model.ListTagsForResourceResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkGroups
default ListWorkGroupsResponse listWorkGroups(ListWorkGroupsRequest listWorkGroupsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Lists available workgroups for the account.
- Parameters:
listWorkGroupsRequest-- Returns:
- Result of the ListWorkGroups operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkGroups
default ListWorkGroupsResponse listWorkGroups(Consumer<ListWorkGroupsRequest.Builder> listWorkGroupsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Lists available workgroups for the account.
This is a convenience which creates an instance of the
ListWorkGroupsRequest.Builderavoiding the need to create one manually viaListWorkGroupsRequest.builder()- Parameters:
listWorkGroupsRequest- AConsumerthat will call methods onListWorkGroupsRequest.Builderto create a request.- Returns:
- Result of the ListWorkGroups operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkGroupsPaginator
default ListWorkGroupsIterable listWorkGroupsPaginator(ListWorkGroupsRequest listWorkGroupsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listWorkGroups(software.amazon.awssdk.services.athena.model.ListWorkGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListWorkGroupsIterable responses = client.listWorkGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListWorkGroupsIterable responses = client.listWorkGroupsPaginator(request); for (software.amazon.awssdk.services.athena.model.ListWorkGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListWorkGroupsIterable responses = client.listWorkGroupsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listWorkGroupsPaginator
default ListWorkGroupsIterable listWorkGroupsPaginator(Consumer<ListWorkGroupsRequest.Builder> listWorkGroupsRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
This is a variant of
listWorkGroups(software.amazon.awssdk.services.athena.model.ListWorkGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.athena.paginators.ListWorkGroupsIterable responses = client.listWorkGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.athena.paginators.ListWorkGroupsIterable responses = client.listWorkGroupsPaginator(request); for (software.amazon.awssdk.services.athena.model.ListWorkGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.athena.paginators.ListWorkGroupsIterable responses = client.listWorkGroupsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListWorkGroupsRequest.builder()- Parameters:
listWorkGroupsRequest- AConsumerthat will call methods onListWorkGroupsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putCapacityAssignmentConfiguration
default PutCapacityAssignmentConfigurationResponse putCapacityAssignmentConfiguration(PutCapacityAssignmentConfigurationRequest putCapacityAssignmentConfigurationRequest) throws InvalidRequestException, InternalServerException, AwsServiceException, SdkClientException, AthenaException
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:
- Result of the PutCapacityAssignmentConfiguration operation returned by the service.
- Throws:
InvalidRequestException- Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.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.AwsServiceException- See Also:
- AWS API Documentation
-
putCapacityAssignmentConfiguration
default PutCapacityAssignmentConfigurationResponse putCapacityAssignmentConfiguration(Consumer<PutCapacityAssignmentConfigurationRequest.Builder> putCapacityAssignmentConfigurationRequest) throws InvalidRequestException, InternalServerException, AwsServiceException, SdkClientException, AthenaException
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.Builderavoiding the need to create one manually viaPutCapacityAssignmentConfigurationRequest.builder()- Parameters:
putCapacityAssignmentConfigurationRequest- AConsumerthat will call methods onPutCapacityAssignmentConfigurationRequest.Builderto create a request.- Returns:
- Result of the PutCapacityAssignmentConfiguration operation returned by the service.
- Throws:
InvalidRequestException- Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.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.AwsServiceException- See Also:
- AWS API Documentation
-
startCalculationExecution
default StartCalculationExecutionResponse startCalculationExecution(StartCalculationExecutionRequest startCalculationExecutionRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Submits calculations for execution within a session. You can supply the code to run as an inline code block within the request.
The request syntax requires the StartCalculationExecutionRequest$CodeBlock parameter or the CalculationConfiguration$CodeBlock parameter, but not both. Because CalculationConfiguration$CodeBlock is deprecated, use the StartCalculationExecutionRequest$CodeBlock parameter instead.
- Parameters:
startCalculationExecutionRequest-- Returns:
- Result of the StartCalculationExecution operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
startCalculationExecution
default StartCalculationExecutionResponse startCalculationExecution(Consumer<StartCalculationExecutionRequest.Builder> startCalculationExecutionRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Submits calculations for execution within a session. You can supply the code to run as an inline code block within the request.
The request syntax requires the StartCalculationExecutionRequest$CodeBlock parameter or the CalculationConfiguration$CodeBlock parameter, but not both. Because CalculationConfiguration$CodeBlock is deprecated, use the StartCalculationExecutionRequest$CodeBlock parameter instead.
This is a convenience which creates an instance of the
StartCalculationExecutionRequest.Builderavoiding the need to create one manually viaStartCalculationExecutionRequest.builder()- Parameters:
startCalculationExecutionRequest- AConsumerthat will call methods onStartCalculationExecutionRequest.Builderto create a request.- Returns:
- Result of the StartCalculationExecution operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
startQueryExecution
default StartQueryExecutionResponse startQueryExecution(StartQueryExecutionRequest startQueryExecutionRequest) throws InternalServerException, InvalidRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
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:
- Result of the StartQueryExecution operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
startQueryExecution
default StartQueryExecutionResponse startQueryExecution(Consumer<StartQueryExecutionRequest.Builder> startQueryExecutionRequest) throws InternalServerException, InvalidRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
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.Builderavoiding the need to create one manually viaStartQueryExecutionRequest.builder()- Parameters:
startQueryExecutionRequest- AConsumerthat will call methods onStartQueryExecutionRequest.Builderto create a request.- Returns:
- Result of the StartQueryExecution operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
startSession
default StartSessionResponse startSession(StartSessionRequest startSessionRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, SessionAlreadyExistsException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
Creates a session for running calculations within a workgroup. The session is ready when it reaches an
IDLEstate.- Parameters:
startSessionRequest-- Returns:
- Result of the StartSession operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
startSession
default StartSessionResponse startSession(Consumer<StartSessionRequest.Builder> startSessionRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, SessionAlreadyExistsException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
Creates a session for running calculations within a workgroup. The session is ready when it reaches an
IDLEstate.
This is a convenience which creates an instance of the
StartSessionRequest.Builderavoiding the need to create one manually viaStartSessionRequest.builder()- Parameters:
startSessionRequest- AConsumerthat will call methods onStartSessionRequest.Builderto create a request.- Returns:
- Result of the StartSession operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
stopCalculationExecution
default StopCalculationExecutionResponse stopCalculationExecution(StopCalculationExecutionRequest stopCalculationExecutionRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Requests the cancellation of a calculation. A
StopCalculationExecutioncall 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:
- Result of the StopCalculationExecution operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
stopCalculationExecution
default StopCalculationExecutionResponse stopCalculationExecution(Consumer<StopCalculationExecutionRequest.Builder> stopCalculationExecutionRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Requests the cancellation of a calculation. A
StopCalculationExecutioncall 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.Builderavoiding the need to create one manually viaStopCalculationExecutionRequest.builder()- Parameters:
stopCalculationExecutionRequest- AConsumerthat will call methods onStopCalculationExecutionRequest.Builderto create a request.- Returns:
- Result of the StopCalculationExecution operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
stopQueryExecution
default StopQueryExecutionResponse stopQueryExecution(StopQueryExecutionRequest stopQueryExecutionRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Stops a query execution. Requires you to have access to the workgroup in which the query ran.
- Parameters:
stopQueryExecutionRequest-- Returns:
- Result of the StopQueryExecution operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
stopQueryExecution
default StopQueryExecutionResponse stopQueryExecution(Consumer<StopQueryExecutionRequest.Builder> stopQueryExecutionRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
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.Builderavoiding the need to create one manually viaStopQueryExecutionRequest.builder()- Parameters:
stopQueryExecutionRequest- AConsumerthat will call methods onStopQueryExecutionRequest.Builderto create a request.- Returns:
- Result of the StopQueryExecution operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
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:
- Result of the TagResource operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
terminateSession
default TerminateSessionResponse terminateSession(TerminateSessionRequest terminateSessionRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Terminates an active session. A
TerminateSessioncall on a session that is already inactive (for example, in aFAILED,TERMINATEDorTERMINATINGstate) succeeds but has no effect. Calculations running in the session whenTerminateSessionis called are forcefully stopped, but may display asFAILEDinstead ofSTOPPED.- Parameters:
terminateSessionRequest-- Returns:
- Result of the TerminateSession operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
terminateSession
default TerminateSessionResponse terminateSession(Consumer<TerminateSessionRequest.Builder> terminateSessionRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Terminates an active session. A
TerminateSessioncall on a session that is already inactive (for example, in aFAILED,TERMINATEDorTERMINATINGstate) succeeds but has no effect. Calculations running in the session whenTerminateSessionis called are forcefully stopped, but may display asFAILEDinstead ofSTOPPED.
This is a convenience which creates an instance of the
TerminateSessionRequest.Builderavoiding the need to create one manually viaTerminateSessionRequest.builder()- Parameters:
terminateSessionRequest- AConsumerthat will call methods onTerminateSessionRequest.Builderto create a request.- Returns:
- Result of the TerminateSession operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Removes one or more tags from an Athena resource.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Removes one or more tags from an Athena resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateCapacityReservation
default UpdateCapacityReservationResponse updateCapacityReservation(UpdateCapacityReservationRequest updateCapacityReservationRequest) throws InvalidRequestException, InternalServerException, AwsServiceException, SdkClientException, AthenaException
Updates the number of requested data processing units for the capacity reservation with the specified name.
- Parameters:
updateCapacityReservationRequest-- Returns:
- Result of the UpdateCapacityReservation operation returned by the service.
- Throws:
InvalidRequestException- Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateCapacityReservation
default UpdateCapacityReservationResponse updateCapacityReservation(Consumer<UpdateCapacityReservationRequest.Builder> updateCapacityReservationRequest) throws InvalidRequestException, InternalServerException, AwsServiceException, SdkClientException, AthenaException
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.Builderavoiding the need to create one manually viaUpdateCapacityReservationRequest.builder()- Parameters:
updateCapacityReservationRequest- AConsumerthat will call methods onUpdateCapacityReservationRequest.Builderto create a request.- Returns:
- Result of the UpdateCapacityReservation operation returned by the service.
- Throws:
InvalidRequestException- Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateDataCatalog
default UpdateDataCatalogResponse updateDataCatalog(UpdateDataCatalogRequest updateDataCatalogRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Updates the data catalog that has the specified name.
- Parameters:
updateDataCatalogRequest-- Returns:
- Result of the UpdateDataCatalog operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateDataCatalog
default UpdateDataCatalogResponse updateDataCatalog(Consumer<UpdateDataCatalogRequest.Builder> updateDataCatalogRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Updates the data catalog that has the specified name.
This is a convenience which creates an instance of the
UpdateDataCatalogRequest.Builderavoiding the need to create one manually viaUpdateDataCatalogRequest.builder()- Parameters:
updateDataCatalogRequest- AConsumerthat will call methods onUpdateDataCatalogRequest.Builderto create a request.- Returns:
- Result of the UpdateDataCatalog operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateNamedQuery
default UpdateNamedQueryResponse updateNamedQuery(UpdateNamedQueryRequest updateNamedQueryRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Updates a NamedQuery object. The database or workgroup cannot be updated.
- Parameters:
updateNamedQueryRequest-- Returns:
- Result of the UpdateNamedQuery operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateNamedQuery
default UpdateNamedQueryResponse updateNamedQuery(Consumer<UpdateNamedQueryRequest.Builder> updateNamedQueryRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Updates a NamedQuery object. The database or workgroup cannot be updated.
This is a convenience which creates an instance of the
UpdateNamedQueryRequest.Builderavoiding the need to create one manually viaUpdateNamedQueryRequest.builder()- Parameters:
updateNamedQueryRequest- AConsumerthat will call methods onUpdateNamedQueryRequest.Builderto create a request.- Returns:
- Result of the UpdateNamedQuery operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateNotebook
default UpdateNotebookResponse updateNotebook(UpdateNotebookRequest updateNotebookRequest) throws InternalServerException, InvalidRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
Updates the contents of a Spark notebook.
- Parameters:
updateNotebookRequest-- Returns:
- Result of the UpdateNotebook operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateNotebook
default UpdateNotebookResponse updateNotebook(Consumer<UpdateNotebookRequest.Builder> updateNotebookRequest) throws InternalServerException, InvalidRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
Updates the contents of a Spark notebook.
This is a convenience which creates an instance of the
UpdateNotebookRequest.Builderavoiding the need to create one manually viaUpdateNotebookRequest.builder()- Parameters:
updateNotebookRequest- AConsumerthat will call methods onUpdateNotebookRequest.Builderto create a request.- Returns:
- Result of the UpdateNotebook operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateNotebookMetadata
default UpdateNotebookMetadataResponse updateNotebookMetadata(UpdateNotebookMetadataRequest updateNotebookMetadataRequest) throws InternalServerException, InvalidRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
Updates the metadata for a notebook.
- Parameters:
updateNotebookMetadataRequest-- Returns:
- Result of the UpdateNotebookMetadata operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateNotebookMetadata
default UpdateNotebookMetadataResponse updateNotebookMetadata(Consumer<UpdateNotebookMetadataRequest.Builder> updateNotebookMetadataRequest) throws InternalServerException, InvalidRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, AthenaException
Updates the metadata for a notebook.
This is a convenience which creates an instance of the
UpdateNotebookMetadataRequest.Builderavoiding the need to create one manually viaUpdateNotebookMetadataRequest.builder()- Parameters:
updateNotebookMetadataRequest- AConsumerthat will call methods onUpdateNotebookMetadataRequest.Builderto create a request.- Returns:
- Result of the UpdateNotebookMetadata operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
updatePreparedStatement
default UpdatePreparedStatementResponse updatePreparedStatement(UpdatePreparedStatementRequest updatePreparedStatementRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Updates a prepared statement.
- Parameters:
updatePreparedStatementRequest-- Returns:
- Result of the UpdatePreparedStatement operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
updatePreparedStatement
default UpdatePreparedStatementResponse updatePreparedStatement(Consumer<UpdatePreparedStatementRequest.Builder> updatePreparedStatementRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, AthenaException
Updates a prepared statement.
This is a convenience which creates an instance of the
UpdatePreparedStatementRequest.Builderavoiding the need to create one manually viaUpdatePreparedStatementRequest.builder()- Parameters:
updatePreparedStatementRequest- AConsumerthat will call methods onUpdatePreparedStatementRequest.Builderto create a request.- Returns:
- Result of the UpdatePreparedStatement operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateWorkGroup
default UpdateWorkGroupResponse updateWorkGroup(UpdateWorkGroupRequest updateWorkGroupRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Updates the workgroup with the specified name. The workgroup's name cannot be changed. Only
ConfigurationUpdatescan be specified.- Parameters:
updateWorkGroupRequest-- Returns:
- Result of the UpdateWorkGroup operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateWorkGroup
default UpdateWorkGroupResponse updateWorkGroup(Consumer<UpdateWorkGroupRequest.Builder> updateWorkGroupRequest) throws InternalServerException, InvalidRequestException, AwsServiceException, SdkClientException, AthenaException
Updates the workgroup with the specified name. The workgroup's name cannot be changed. Only
ConfigurationUpdatescan be specified.
This is a convenience which creates an instance of the
UpdateWorkGroupRequest.Builderavoiding the need to create one manually viaUpdateWorkGroupRequest.builder()- Parameters:
updateWorkGroupRequest- AConsumerthat will call methods onUpdateWorkGroupRequest.Builderto create a request.- Returns:
- Result of the UpdateWorkGroup operation returned by the service.
- Throws:
InternalServerException- Indicates a platform issue, which may be due to a transient condition or outage.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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static AthenaClient create()
Create aAthenaClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static AthenaClientBuilder builder()
Create a builder that can be used to configure and create aAthenaClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default AthenaServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-