Interface AthenaAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface AthenaAsyncClient extends AwsClient
Service client for accessing Amazon Athena asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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 Details

  • Method Details

    • batchGetNamedQuery

      default CompletableFuture<BatchGetNamedQueryResponse> batchGetNamedQuery(BatchGetNamedQueryRequest batchGetNamedQueryRequest)

      Returns the details of a single named query or a list of up to 50 queries, which you provide as an array of query ID strings. Requires you to have access to the workgroup in which the queries were saved. Use ListNamedQueriesInput to get the list of named query IDs in the specified workgroup. If information could not be retrieved for a submitted query ID, information about the query ID submitted is listed under UnprocessedNamedQueryId. Named queries differ from executed queries. Use BatchGetQueryExecutionInput to get details about each unique query execution, and ListQueryExecutionsInput to get a list of query execution IDs.

      Parameters:
      batchGetNamedQueryRequest - Contains an array of named query IDs.
      Returns:
      A Java Future containing the result of the BatchGetNamedQuery operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetNamedQuery

      default CompletableFuture<BatchGetNamedQueryResponse> batchGetNamedQuery(Consumer<BatchGetNamedQueryRequest.Builder> batchGetNamedQueryRequest)

      Returns the details of a single named query or a list of up to 50 queries, which you provide as an array of query ID strings. Requires you to have access to the workgroup in which the queries were saved. Use ListNamedQueriesInput to get the list of named query IDs in the specified workgroup. If information could not be retrieved for a submitted query ID, information about the query ID submitted is listed under UnprocessedNamedQueryId. Named queries differ from executed queries. Use BatchGetQueryExecutionInput to get details about each unique query execution, and ListQueryExecutionsInput to get a list of query execution IDs.


      This is a convenience which creates an instance of the BatchGetNamedQueryRequest.Builder avoiding the need to create one manually via BatchGetNamedQueryRequest.builder()

      Parameters:
      batchGetNamedQueryRequest - A Consumer that will call methods on BatchGetNamedQueryRequest.Builder to create a request. Contains an array of named query IDs.
      Returns:
      A Java Future containing the result of the BatchGetNamedQuery operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetPreparedStatement

      default CompletableFuture<BatchGetPreparedStatementResponse> batchGetPreparedStatement(BatchGetPreparedStatementRequest batchGetPreparedStatementRequest)

      Returns the details of a single prepared statement or a list of up to 256 prepared statements for the array of prepared statement names that you provide. Requires you to have access to the workgroup to which the prepared statements belong. If a prepared statement cannot be retrieved for the name specified, the statement is listed in UnprocessedPreparedStatementNames.

      Parameters:
      batchGetPreparedStatementRequest -
      Returns:
      A Java Future containing the result of the BatchGetPreparedStatement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetPreparedStatement

      default CompletableFuture<BatchGetPreparedStatementResponse> batchGetPreparedStatement(Consumer<BatchGetPreparedStatementRequest.Builder> batchGetPreparedStatementRequest)

      Returns the details of a single prepared statement or a list of up to 256 prepared statements for the array of prepared statement names that you provide. Requires you to have access to the workgroup to which the prepared statements belong. If a prepared statement cannot be retrieved for the name specified, the statement is listed in UnprocessedPreparedStatementNames.


      This is a convenience which creates an instance of the BatchGetPreparedStatementRequest.Builder avoiding the need to create one manually via BatchGetPreparedStatementRequest.builder()

      Parameters:
      batchGetPreparedStatementRequest - A Consumer that will call methods on BatchGetPreparedStatementRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchGetPreparedStatement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetQueryExecution

      default CompletableFuture<BatchGetQueryExecutionResponse> batchGetQueryExecution(BatchGetQueryExecutionRequest batchGetQueryExecutionRequest)

      Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings. Requires you to have access to the workgroup in which the queries ran. To get a list of query execution IDs, use ListQueryExecutionsInputinvalid input: '&#36'WorkGroup. Query executions differ from named (saved) queries. Use BatchGetNamedQueryInput to get details about named queries.

      Parameters:
      batchGetQueryExecutionRequest - Contains an array of query execution IDs.
      Returns:
      A Java Future containing the result of the BatchGetQueryExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetQueryExecution

      default CompletableFuture<BatchGetQueryExecutionResponse> batchGetQueryExecution(Consumer<BatchGetQueryExecutionRequest.Builder> batchGetQueryExecutionRequest)

      Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings. Requires you to have access to the workgroup in which the queries ran. To get a list of query execution IDs, use ListQueryExecutionsInputinvalid input: '&#36'WorkGroup. Query executions differ from named (saved) queries. Use BatchGetNamedQueryInput to get details about named queries.


      This is a convenience which creates an instance of the BatchGetQueryExecutionRequest.Builder avoiding the need to create one manually via BatchGetQueryExecutionRequest.builder()

      Parameters:
      batchGetQueryExecutionRequest - A Consumer that will call methods on BatchGetQueryExecutionRequest.Builder to create a request. Contains an array of query execution IDs.
      Returns:
      A Java Future containing the result of the BatchGetQueryExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelCapacityReservation

      default CompletableFuture<CancelCapacityReservationResponse> cancelCapacityReservation(CancelCapacityReservationRequest cancelCapacityReservationRequest)

      Cancels the capacity reservation with the specified name. Cancelled reservations remain in your account and will be deleted 45 days after cancellation. During the 45 days, you cannot re-purpose or reuse a reservation that has been cancelled, but you can refer to its tags and view it for historical reference.

      Parameters:
      cancelCapacityReservationRequest -
      Returns:
      A Java Future containing the result of the CancelCapacityReservation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelCapacityReservation

      default CompletableFuture<CancelCapacityReservationResponse> cancelCapacityReservation(Consumer<CancelCapacityReservationRequest.Builder> cancelCapacityReservationRequest)

      Cancels the capacity reservation with the specified name. Cancelled reservations remain in your account and will be deleted 45 days after cancellation. During the 45 days, you cannot re-purpose or reuse a reservation that has been cancelled, but you can refer to its tags and view it for historical reference.


      This is a convenience which creates an instance of the CancelCapacityReservationRequest.Builder avoiding the need to create one manually via CancelCapacityReservationRequest.builder()

      Parameters:
      cancelCapacityReservationRequest - A Consumer that will call methods on CancelCapacityReservationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CancelCapacityReservation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createCapacityReservation

      default CompletableFuture<CreateCapacityReservationResponse> createCapacityReservation(CreateCapacityReservationRequest createCapacityReservationRequest)

      Creates a capacity reservation with the specified name and number of requested data processing units.

      Parameters:
      createCapacityReservationRequest -
      Returns:
      A Java Future containing the result of the CreateCapacityReservation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createCapacityReservation

      default CompletableFuture<CreateCapacityReservationResponse> createCapacityReservation(Consumer<CreateCapacityReservationRequest.Builder> createCapacityReservationRequest)

      Creates a capacity reservation with the specified name and number of requested data processing units.


      This is a convenience which creates an instance of the CreateCapacityReservationRequest.Builder avoiding the need to create one manually via CreateCapacityReservationRequest.builder()

      Parameters:
      createCapacityReservationRequest - A Consumer that will call methods on CreateCapacityReservationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateCapacityReservation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDataCatalog

      default CompletableFuture<CreateDataCatalogResponse> createDataCatalog(CreateDataCatalogRequest createDataCatalogRequest)

      Creates (registers) a data catalog with the specified name and properties. Catalogs created are visible to all users of the same Amazon Web Services account.

      Parameters:
      createDataCatalogRequest -
      Returns:
      A Java Future containing the result of the CreateDataCatalog operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDataCatalog

      default CompletableFuture<CreateDataCatalogResponse> createDataCatalog(Consumer<CreateDataCatalogRequest.Builder> createDataCatalogRequest)

      Creates (registers) a data catalog with the specified name and properties. Catalogs created are visible to all users of the same Amazon Web Services account.


      This is a convenience which creates an instance of the CreateDataCatalogRequest.Builder avoiding the need to create one manually via CreateDataCatalogRequest.builder()

      Parameters:
      createDataCatalogRequest - A Consumer that will call methods on CreateDataCatalogRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateDataCatalog operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createNamedQuery

      default CompletableFuture<CreateNamedQueryResponse> createNamedQuery(CreateNamedQueryRequest createNamedQueryRequest)

      Creates a named query in the specified workgroup. Requires that you have access to the workgroup.

      Parameters:
      createNamedQueryRequest -
      Returns:
      A Java Future containing the result of the CreateNamedQuery operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createNamedQuery

      default CompletableFuture<CreateNamedQueryResponse> createNamedQuery(Consumer<CreateNamedQueryRequest.Builder> createNamedQueryRequest)

      Creates a named query in the specified workgroup. Requires that you have access to the workgroup.


      This is a convenience which creates an instance of the CreateNamedQueryRequest.Builder avoiding the need to create one manually via CreateNamedQueryRequest.builder()

      Parameters:
      createNamedQueryRequest - A Consumer that will call methods on CreateNamedQueryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateNamedQuery operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createNotebook

      default CompletableFuture<CreateNotebookResponse> createNotebook(CreateNotebookRequest createNotebookRequest)

      Creates an empty ipynb file in the specified Apache Spark enabled workgroup. Throws an error if a file in the workgroup with the same name already exists.

      Parameters:
      createNotebookRequest -
      Returns:
      A Java Future containing the result of the CreateNotebook operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • TooManyRequestsException Indicates that the request was throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createNotebook

      default CompletableFuture<CreateNotebookResponse> createNotebook(Consumer<CreateNotebookRequest.Builder> createNotebookRequest)

      Creates an empty ipynb file in the specified Apache Spark enabled workgroup. Throws an error if a file in the workgroup with the same name already exists.


      This is a convenience which creates an instance of the CreateNotebookRequest.Builder avoiding the need to create one manually via CreateNotebookRequest.builder()

      Parameters:
      createNotebookRequest - A Consumer that will call methods on CreateNotebookRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateNotebook operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • TooManyRequestsException Indicates that the request was throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPreparedStatement

      default CompletableFuture<CreatePreparedStatementResponse> createPreparedStatement(CreatePreparedStatementRequest createPreparedStatementRequest)

      Creates a prepared statement for use with SQL queries in Athena.

      Parameters:
      createPreparedStatementRequest -
      Returns:
      A Java Future containing the result of the CreatePreparedStatement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPreparedStatement

      default CompletableFuture<CreatePreparedStatementResponse> createPreparedStatement(Consumer<CreatePreparedStatementRequest.Builder> createPreparedStatementRequest)

      Creates a prepared statement for use with SQL queries in Athena.


      This is a convenience which creates an instance of the CreatePreparedStatementRequest.Builder avoiding the need to create one manually via CreatePreparedStatementRequest.builder()

      Parameters:
      createPreparedStatementRequest - A Consumer that will call methods on CreatePreparedStatementRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreatePreparedStatement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPresignedNotebookUrl

      default CompletableFuture<CreatePresignedNotebookUrlResponse> createPresignedNotebookUrl(CreatePresignedNotebookUrlRequest createPresignedNotebookUrlRequest)

      Gets an authentication token and the URL at which the notebook can be accessed. During programmatic access, CreatePresignedNotebookUrl must be called every 10 minutes to refresh the authentication token. For information about granting programmatic access, see Grant programmatic access.

      Parameters:
      createPresignedNotebookUrlRequest -
      Returns:
      A Java Future containing the result of the CreatePresignedNotebookUrl operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPresignedNotebookUrl

      default CompletableFuture<CreatePresignedNotebookUrlResponse> createPresignedNotebookUrl(Consumer<CreatePresignedNotebookUrlRequest.Builder> createPresignedNotebookUrlRequest)

      Gets an authentication token and the URL at which the notebook can be accessed. During programmatic access, CreatePresignedNotebookUrl must be called every 10 minutes to refresh the authentication token. For information about granting programmatic access, see Grant programmatic access.


      This is a convenience which creates an instance of the CreatePresignedNotebookUrlRequest.Builder avoiding the need to create one manually via CreatePresignedNotebookUrlRequest.builder()

      Parameters:
      createPresignedNotebookUrlRequest - A Consumer that will call methods on CreatePresignedNotebookUrlRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreatePresignedNotebookUrl operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createWorkGroup

      default CompletableFuture<CreateWorkGroupResponse> createWorkGroup(CreateWorkGroupRequest createWorkGroupRequest)

      Creates a workgroup with the specified name. A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup.

      Parameters:
      createWorkGroupRequest -
      Returns:
      A Java Future containing the result of the CreateWorkGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createWorkGroup

      default CompletableFuture<CreateWorkGroupResponse> createWorkGroup(Consumer<CreateWorkGroupRequest.Builder> createWorkGroupRequest)

      Creates a workgroup with the specified name. A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup.


      This is a convenience which creates an instance of the CreateWorkGroupRequest.Builder avoiding the need to create one manually via CreateWorkGroupRequest.builder()

      Parameters:
      createWorkGroupRequest - A Consumer that will call methods on CreateWorkGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateWorkGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteCapacityReservation

      default CompletableFuture<DeleteCapacityReservationResponse> deleteCapacityReservation(DeleteCapacityReservationRequest deleteCapacityReservationRequest)

      Deletes a cancelled capacity reservation. A reservation must be cancelled before it can be deleted. A deleted reservation is immediately removed from your account and can no longer be referenced, including by its ARN. A deleted reservation cannot be called by GetCapacityReservation, and deleted reservations do not appear in the output of ListCapacityReservations.

      Parameters:
      deleteCapacityReservationRequest -
      Returns:
      A Java Future containing the result of the DeleteCapacityReservation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteCapacityReservation

      default CompletableFuture<DeleteCapacityReservationResponse> deleteCapacityReservation(Consumer<DeleteCapacityReservationRequest.Builder> deleteCapacityReservationRequest)

      Deletes a cancelled capacity reservation. A reservation must be cancelled before it can be deleted. A deleted reservation is immediately removed from your account and can no longer be referenced, including by its ARN. A deleted reservation cannot be called by GetCapacityReservation, and deleted reservations do not appear in the output of ListCapacityReservations.


      This is a convenience which creates an instance of the DeleteCapacityReservationRequest.Builder avoiding the need to create one manually via DeleteCapacityReservationRequest.builder()

      Parameters:
      deleteCapacityReservationRequest - A Consumer that will call methods on DeleteCapacityReservationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteCapacityReservation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDataCatalog

      default CompletableFuture<DeleteDataCatalogResponse> deleteDataCatalog(DeleteDataCatalogRequest deleteDataCatalogRequest)

      Deletes a data catalog.

      Parameters:
      deleteDataCatalogRequest -
      Returns:
      A Java Future containing the result of the DeleteDataCatalog operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDataCatalog

      default CompletableFuture<DeleteDataCatalogResponse> deleteDataCatalog(Consumer<DeleteDataCatalogRequest.Builder> deleteDataCatalogRequest)

      Deletes a data catalog.


      This is a convenience which creates an instance of the DeleteDataCatalogRequest.Builder avoiding the need to create one manually via DeleteDataCatalogRequest.builder()

      Parameters:
      deleteDataCatalogRequest - A Consumer that will call methods on DeleteDataCatalogRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteDataCatalog operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteNamedQuery

      default CompletableFuture<DeleteNamedQueryResponse> deleteNamedQuery(DeleteNamedQueryRequest deleteNamedQueryRequest)

      Deletes the named query if you have access to the workgroup in which the query was saved.

      Parameters:
      deleteNamedQueryRequest -
      Returns:
      A Java Future containing the result of the DeleteNamedQuery operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteNamedQuery

      default CompletableFuture<DeleteNamedQueryResponse> deleteNamedQuery(Consumer<DeleteNamedQueryRequest.Builder> deleteNamedQueryRequest)

      Deletes the named query if you have access to the workgroup in which the query was saved.


      This is a convenience which creates an instance of the DeleteNamedQueryRequest.Builder avoiding the need to create one manually via DeleteNamedQueryRequest.builder()

      Parameters:
      deleteNamedQueryRequest - A Consumer that will call methods on DeleteNamedQueryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteNamedQuery operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteNotebook

      default CompletableFuture<DeleteNotebookResponse> deleteNotebook(DeleteNotebookRequest deleteNotebookRequest)

      Deletes the specified notebook.

      Parameters:
      deleteNotebookRequest -
      Returns:
      A Java Future containing the result of the DeleteNotebook operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • TooManyRequestsException Indicates that the request was throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteNotebook

      default CompletableFuture<DeleteNotebookResponse> deleteNotebook(Consumer<DeleteNotebookRequest.Builder> deleteNotebookRequest)

      Deletes the specified notebook.


      This is a convenience which creates an instance of the DeleteNotebookRequest.Builder avoiding the need to create one manually via DeleteNotebookRequest.builder()

      Parameters:
      deleteNotebookRequest - A Consumer that will call methods on DeleteNotebookRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteNotebook operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • TooManyRequestsException Indicates that the request was throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePreparedStatement

      default CompletableFuture<DeletePreparedStatementResponse> deletePreparedStatement(DeletePreparedStatementRequest deletePreparedStatementRequest)

      Deletes the prepared statement with the specified name from the specified workgroup.

      Parameters:
      deletePreparedStatementRequest -
      Returns:
      A Java Future containing the result of the DeletePreparedStatement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePreparedStatement

      default CompletableFuture<DeletePreparedStatementResponse> deletePreparedStatement(Consumer<DeletePreparedStatementRequest.Builder> deletePreparedStatementRequest)

      Deletes the prepared statement with the specified name from the specified workgroup.


      This is a convenience which creates an instance of the DeletePreparedStatementRequest.Builder avoiding the need to create one manually via DeletePreparedStatementRequest.builder()

      Parameters:
      deletePreparedStatementRequest - A Consumer that will call methods on DeletePreparedStatementRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeletePreparedStatement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteWorkGroup

      default CompletableFuture<DeleteWorkGroupResponse> deleteWorkGroup(DeleteWorkGroupRequest deleteWorkGroupRequest)

      Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.

      Parameters:
      deleteWorkGroupRequest -
      Returns:
      A Java Future containing the result of the DeleteWorkGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteWorkGroup

      default CompletableFuture<DeleteWorkGroupResponse> deleteWorkGroup(Consumer<DeleteWorkGroupRequest.Builder> deleteWorkGroupRequest)

      Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.


      This is a convenience which creates an instance of the DeleteWorkGroupRequest.Builder avoiding the need to create one manually via DeleteWorkGroupRequest.builder()

      Parameters:
      deleteWorkGroupRequest - A Consumer that will call methods on DeleteWorkGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteWorkGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • exportNotebook

      default CompletableFuture<ExportNotebookResponse> exportNotebook(ExportNotebookRequest exportNotebookRequest)

      Exports the specified notebook and its metadata.

      Parameters:
      exportNotebookRequest -
      Returns:
      A Java Future containing the result of the ExportNotebook operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • TooManyRequestsException Indicates that the request was throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • exportNotebook

      default CompletableFuture<ExportNotebookResponse> exportNotebook(Consumer<ExportNotebookRequest.Builder> exportNotebookRequest)

      Exports the specified notebook and its metadata.


      This is a convenience which creates an instance of the ExportNotebookRequest.Builder avoiding the need to create one manually via ExportNotebookRequest.builder()

      Parameters:
      exportNotebookRequest - A Consumer that will call methods on ExportNotebookRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ExportNotebook operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • TooManyRequestsException Indicates that the request was throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCalculationExecution

      default CompletableFuture<GetCalculationExecutionResponse> getCalculationExecution(GetCalculationExecutionRequest getCalculationExecutionRequest)

      Describes a previously submitted calculation execution.

      Parameters:
      getCalculationExecutionRequest -
      Returns:
      A Java Future containing the result of the GetCalculationExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCalculationExecution

      default CompletableFuture<GetCalculationExecutionResponse> getCalculationExecution(Consumer<GetCalculationExecutionRequest.Builder> getCalculationExecutionRequest)

      Describes a previously submitted calculation execution.


      This is a convenience which creates an instance of the GetCalculationExecutionRequest.Builder avoiding the need to create one manually via GetCalculationExecutionRequest.builder()

      Parameters:
      getCalculationExecutionRequest - A Consumer that will call methods on GetCalculationExecutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetCalculationExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCalculationExecutionCode

      default CompletableFuture<GetCalculationExecutionCodeResponse> getCalculationExecutionCode(GetCalculationExecutionCodeRequest getCalculationExecutionCodeRequest)

      Retrieves the unencrypted code that was executed for the calculation.

      Parameters:
      getCalculationExecutionCodeRequest -
      Returns:
      A Java Future containing the result of the GetCalculationExecutionCode operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCalculationExecutionCode

      default CompletableFuture<GetCalculationExecutionCodeResponse> getCalculationExecutionCode(Consumer<GetCalculationExecutionCodeRequest.Builder> getCalculationExecutionCodeRequest)

      Retrieves the unencrypted code that was executed for the calculation.


      This is a convenience which creates an instance of the GetCalculationExecutionCodeRequest.Builder avoiding the need to create one manually via GetCalculationExecutionCodeRequest.builder()

      Parameters:
      getCalculationExecutionCodeRequest - A Consumer that will call methods on GetCalculationExecutionCodeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetCalculationExecutionCode operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCalculationExecutionStatus

      default CompletableFuture<GetCalculationExecutionStatusResponse> getCalculationExecutionStatus(GetCalculationExecutionStatusRequest getCalculationExecutionStatusRequest)

      Gets the status of a current calculation.

      Parameters:
      getCalculationExecutionStatusRequest -
      Returns:
      A Java Future containing the result of the GetCalculationExecutionStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCalculationExecutionStatus

      default CompletableFuture<GetCalculationExecutionStatusResponse> getCalculationExecutionStatus(Consumer<GetCalculationExecutionStatusRequest.Builder> getCalculationExecutionStatusRequest)

      Gets the status of a current calculation.


      This is a convenience which creates an instance of the GetCalculationExecutionStatusRequest.Builder avoiding the need to create one manually via GetCalculationExecutionStatusRequest.builder()

      Parameters:
      getCalculationExecutionStatusRequest - A Consumer that will call methods on GetCalculationExecutionStatusRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetCalculationExecutionStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCapacityAssignmentConfiguration

      default CompletableFuture<GetCapacityAssignmentConfigurationResponse> getCapacityAssignmentConfiguration(GetCapacityAssignmentConfigurationRequest getCapacityAssignmentConfigurationRequest)

      Gets the capacity assignment configuration for a capacity reservation, if one exists.

      Parameters:
      getCapacityAssignmentConfigurationRequest -
      Returns:
      A Java Future containing the result of the GetCapacityAssignmentConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCapacityAssignmentConfiguration

      default CompletableFuture<GetCapacityAssignmentConfigurationResponse> getCapacityAssignmentConfiguration(Consumer<GetCapacityAssignmentConfigurationRequest.Builder> getCapacityAssignmentConfigurationRequest)

      Gets the capacity assignment configuration for a capacity reservation, if one exists.


      This is a convenience which creates an instance of the GetCapacityAssignmentConfigurationRequest.Builder avoiding the need to create one manually via GetCapacityAssignmentConfigurationRequest.builder()

      Parameters:
      getCapacityAssignmentConfigurationRequest - A Consumer that will call methods on GetCapacityAssignmentConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetCapacityAssignmentConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCapacityReservation

      default CompletableFuture<GetCapacityReservationResponse> getCapacityReservation(GetCapacityReservationRequest getCapacityReservationRequest)

      Returns information about the capacity reservation with the specified name.

      Parameters:
      getCapacityReservationRequest -
      Returns:
      A Java Future containing the result of the GetCapacityReservation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCapacityReservation

      default CompletableFuture<GetCapacityReservationResponse> getCapacityReservation(Consumer<GetCapacityReservationRequest.Builder> getCapacityReservationRequest)

      Returns information about the capacity reservation with the specified name.


      This is a convenience which creates an instance of the GetCapacityReservationRequest.Builder avoiding the need to create one manually via GetCapacityReservationRequest.builder()

      Parameters:
      getCapacityReservationRequest - A Consumer that will call methods on GetCapacityReservationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetCapacityReservation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDataCatalog

      default CompletableFuture<GetDataCatalogResponse> getDataCatalog(GetDataCatalogRequest getDataCatalogRequest)

      Returns the specified data catalog.

      Parameters:
      getDataCatalogRequest -
      Returns:
      A Java Future containing the result of the GetDataCatalog operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDataCatalog

      default CompletableFuture<GetDataCatalogResponse> getDataCatalog(Consumer<GetDataCatalogRequest.Builder> getDataCatalogRequest)

      Returns the specified data catalog.


      This is a convenience which creates an instance of the GetDataCatalogRequest.Builder avoiding the need to create one manually via GetDataCatalogRequest.builder()

      Parameters:
      getDataCatalogRequest - A Consumer that will call methods on GetDataCatalogRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDataCatalog operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDatabase

      default CompletableFuture<GetDatabaseResponse> getDatabase(GetDatabaseRequest getDatabaseRequest)

      Returns a database object for the specified database and data catalog.

      Parameters:
      getDatabaseRequest -
      Returns:
      A Java Future containing the result of the GetDatabase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • MetadataException An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (InvalidRequestException) or from the Athena platform ( InternalServerException). For example, if a user-created Lambda function is missing permissions, the Lambda 4XX exception is returned in a MetadataException.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDatabase

      default CompletableFuture<GetDatabaseResponse> getDatabase(Consumer<GetDatabaseRequest.Builder> getDatabaseRequest)

      Returns a database object for the specified database and data catalog.


      This is a convenience which creates an instance of the GetDatabaseRequest.Builder avoiding the need to create one manually via GetDatabaseRequest.builder()

      Parameters:
      getDatabaseRequest - A Consumer that will call methods on GetDatabaseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDatabase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • MetadataException An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (InvalidRequestException) or from the Athena platform ( InternalServerException). For example, if a user-created Lambda function is missing permissions, the Lambda 4XX exception is returned in a MetadataException.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getNamedQuery

      default CompletableFuture<GetNamedQueryResponse> getNamedQuery(GetNamedQueryRequest getNamedQueryRequest)

      Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.

      Parameters:
      getNamedQueryRequest -
      Returns:
      A Java Future containing the result of the GetNamedQuery operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getNamedQuery

      default CompletableFuture<GetNamedQueryResponse> getNamedQuery(Consumer<GetNamedQueryRequest.Builder> getNamedQueryRequest)

      Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.


      This is a convenience which creates an instance of the GetNamedQueryRequest.Builder avoiding the need to create one manually via GetNamedQueryRequest.builder()

      Parameters:
      getNamedQueryRequest - A Consumer that will call methods on GetNamedQueryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetNamedQuery operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getNotebookMetadata

      default CompletableFuture<GetNotebookMetadataResponse> getNotebookMetadata(GetNotebookMetadataRequest getNotebookMetadataRequest)

      Retrieves notebook metadata for the specified notebook ID.

      Parameters:
      getNotebookMetadataRequest -
      Returns:
      A Java Future containing the result of the GetNotebookMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • TooManyRequestsException Indicates that the request was throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getNotebookMetadata

      default CompletableFuture<GetNotebookMetadataResponse> getNotebookMetadata(Consumer<GetNotebookMetadataRequest.Builder> getNotebookMetadataRequest)

      Retrieves notebook metadata for the specified notebook ID.


      This is a convenience which creates an instance of the GetNotebookMetadataRequest.Builder avoiding the need to create one manually via GetNotebookMetadataRequest.builder()

      Parameters:
      getNotebookMetadataRequest - A Consumer that will call methods on GetNotebookMetadataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetNotebookMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • TooManyRequestsException Indicates that the request was throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPreparedStatement

      default CompletableFuture<GetPreparedStatementResponse> getPreparedStatement(GetPreparedStatementRequest getPreparedStatementRequest)

      Retrieves the prepared statement with the specified name from the specified workgroup.

      Parameters:
      getPreparedStatementRequest -
      Returns:
      A Java Future containing the result of the GetPreparedStatement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPreparedStatement

      default CompletableFuture<GetPreparedStatementResponse> getPreparedStatement(Consumer<GetPreparedStatementRequest.Builder> getPreparedStatementRequest)

      Retrieves the prepared statement with the specified name from the specified workgroup.


      This is a convenience which creates an instance of the GetPreparedStatementRequest.Builder avoiding the need to create one manually via GetPreparedStatementRequest.builder()

      Parameters:
      getPreparedStatementRequest - A Consumer that will call methods on GetPreparedStatementRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetPreparedStatement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getQueryExecution

      default CompletableFuture<GetQueryExecutionResponse> getQueryExecution(GetQueryExecutionRequest getQueryExecutionRequest)

      Returns information about a single execution of a query if you have access to the workgroup in which the query ran. Each time a query executes, information about the query execution is saved with a unique ID.

      Parameters:
      getQueryExecutionRequest -
      Returns:
      A Java Future containing the result of the GetQueryExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getQueryExecution

      default CompletableFuture<GetQueryExecutionResponse> getQueryExecution(Consumer<GetQueryExecutionRequest.Builder> getQueryExecutionRequest)

      Returns information about a single execution of a query if you have access to the workgroup in which the query ran. Each time a query executes, information about the query execution is saved with a unique ID.


      This is a convenience which creates an instance of the GetQueryExecutionRequest.Builder avoiding the need to create one manually via GetQueryExecutionRequest.builder()

      Parameters:
      getQueryExecutionRequest - A Consumer that will call methods on GetQueryExecutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetQueryExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getQueryResults

      default CompletableFuture<GetQueryResultsResponse> getQueryResults(GetQueryResultsRequest getQueryResultsRequest)

      Streams the results of a single query execution specified by QueryExecutionId from the Athena query results location in Amazon S3. For more information, see Working with query results, recent queries, and output files in the Amazon Athena User Guide. This request does not execute the query but returns results. Use StartQueryExecution to run a query.

      To stream query results successfully, the IAM principal with permission to call GetQueryResults also must have permissions to the Amazon S3 GetObject action for the Athena query results location.

      IAM principals with permission to the Amazon S3 GetObject action for the query results location are able to retrieve query results from Amazon S3 even if permission to the GetQueryResults action is denied. To restrict user or role access, ensure that Amazon S3 permissions to the Athena query location are denied.

      Parameters:
      getQueryResultsRequest -
      Returns:
      A Java Future containing the result of the GetQueryResults operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • TooManyRequestsException Indicates that the request was throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getQueryResults

      default CompletableFuture<GetQueryResultsResponse> getQueryResults(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest)

      Streams the results of a single query execution specified by QueryExecutionId from the Athena query results location in Amazon S3. For more information, see Working with query results, recent queries, and output files in the Amazon Athena User Guide. This request does not execute the query but returns results. Use StartQueryExecution to run a query.

      To stream query results successfully, the IAM principal with permission to call GetQueryResults also must have permissions to the Amazon S3 GetObject action for the Athena query results location.

      IAM principals with permission to the Amazon S3 GetObject action for the query results location are able to retrieve query results from Amazon S3 even if permission to the GetQueryResults action is denied. To restrict user or role access, ensure that Amazon S3 permissions to the Athena query location are denied.


      This is a convenience which creates an instance of the GetQueryResultsRequest.Builder avoiding the need to create one manually via GetQueryResultsRequest.builder()

      Parameters:
      getQueryResultsRequest - A Consumer that will call methods on GetQueryResultsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetQueryResults operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • TooManyRequestsException Indicates that the request was throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getQueryResultsPaginator

      default GetQueryResultsPublisher getQueryResultsPaginator(GetQueryResultsRequest getQueryResultsRequest)

      This is a variant of getQueryResults(software.amazon.awssdk.services.athena.model.GetQueryResultsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.GetQueryResultsPublisher publisher = client.getQueryResultsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.GetQueryResultsPublisher publisher = client.getQueryResultsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.GetQueryResultsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.GetQueryResultsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getQueryResults(software.amazon.awssdk.services.athena.model.GetQueryResultsRequest) operation.

      Parameters:
      getQueryResultsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • TooManyRequestsException Indicates that the request was throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getQueryResultsPaginator

      default GetQueryResultsPublisher getQueryResultsPaginator(Consumer<GetQueryResultsRequest.Builder> getQueryResultsRequest)

      This is a variant of getQueryResults(software.amazon.awssdk.services.athena.model.GetQueryResultsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.GetQueryResultsPublisher publisher = client.getQueryResultsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.GetQueryResultsPublisher publisher = client.getQueryResultsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.GetQueryResultsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.GetQueryResultsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getQueryResults(software.amazon.awssdk.services.athena.model.GetQueryResultsRequest) operation.


      This is a convenience which creates an instance of the GetQueryResultsRequest.Builder avoiding the need to create one manually via GetQueryResultsRequest.builder()

      Parameters:
      getQueryResultsRequest - A Consumer that will call methods on GetQueryResultsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • TooManyRequestsException Indicates that the request was throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getQueryRuntimeStatistics

      default CompletableFuture<GetQueryRuntimeStatisticsResponse> getQueryRuntimeStatistics(GetQueryRuntimeStatisticsRequest getQueryRuntimeStatisticsRequest)

      Returns query execution runtime statistics related to a single execution of a query if you have access to the workgroup in which the query ran. Statistics from the Timeline section of the response object are available as soon as QueryExecutionStatusinvalid input: '&#36'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:
      A Java Future containing the result of the GetQueryRuntimeStatistics operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getQueryRuntimeStatistics

      default CompletableFuture<GetQueryRuntimeStatisticsResponse> getQueryRuntimeStatistics(Consumer<GetQueryRuntimeStatisticsRequest.Builder> getQueryRuntimeStatisticsRequest)

      Returns query execution runtime statistics related to a single execution of a query if you have access to the workgroup in which the query ran. Statistics from the Timeline section of the response object are available as soon as QueryExecutionStatusinvalid input: '&#36'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.Builder avoiding the need to create one manually via GetQueryRuntimeStatisticsRequest.builder()

      Parameters:
      getQueryRuntimeStatisticsRequest - A Consumer that will call methods on GetQueryRuntimeStatisticsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetQueryRuntimeStatistics operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSession

      default CompletableFuture<GetSessionResponse> getSession(GetSessionRequest getSessionRequest)

      Gets the full details of a previously created session, including the session status and configuration.

      Parameters:
      getSessionRequest -
      Returns:
      A Java Future containing the result of the GetSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSession

      default CompletableFuture<GetSessionResponse> getSession(Consumer<GetSessionRequest.Builder> getSessionRequest)

      Gets the full details of a previously created session, including the session status and configuration.


      This is a convenience which creates an instance of the GetSessionRequest.Builder avoiding the need to create one manually via GetSessionRequest.builder()

      Parameters:
      getSessionRequest - A Consumer that will call methods on GetSessionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSessionStatus

      default CompletableFuture<GetSessionStatusResponse> getSessionStatus(GetSessionStatusRequest getSessionStatusRequest)

      Gets the current status of a session.

      Parameters:
      getSessionStatusRequest -
      Returns:
      A Java Future containing the result of the GetSessionStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSessionStatus

      default CompletableFuture<GetSessionStatusResponse> getSessionStatus(Consumer<GetSessionStatusRequest.Builder> getSessionStatusRequest)

      Gets the current status of a session.


      This is a convenience which creates an instance of the GetSessionStatusRequest.Builder avoiding the need to create one manually via GetSessionStatusRequest.builder()

      Parameters:
      getSessionStatusRequest - A Consumer that will call methods on GetSessionStatusRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSessionStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTableMetadata

      default CompletableFuture<GetTableMetadataResponse> getTableMetadata(GetTableMetadataRequest getTableMetadataRequest)

      Returns table metadata for the specified catalog, database, and table.

      Parameters:
      getTableMetadataRequest -
      Returns:
      A Java Future containing the result of the GetTableMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • MetadataException An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (InvalidRequestException) or from the Athena platform ( InternalServerException). For example, if a user-created Lambda function is missing permissions, the Lambda 4XX exception is returned in a MetadataException.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTableMetadata

      default CompletableFuture<GetTableMetadataResponse> getTableMetadata(Consumer<GetTableMetadataRequest.Builder> getTableMetadataRequest)

      Returns table metadata for the specified catalog, database, and table.


      This is a convenience which creates an instance of the GetTableMetadataRequest.Builder avoiding the need to create one manually via GetTableMetadataRequest.builder()

      Parameters:
      getTableMetadataRequest - A Consumer that will call methods on GetTableMetadataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetTableMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • MetadataException An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (InvalidRequestException) or from the Athena platform ( InternalServerException). For example, if a user-created Lambda function is missing permissions, the Lambda 4XX exception is returned in a MetadataException.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getWorkGroup

      default CompletableFuture<GetWorkGroupResponse> getWorkGroup(GetWorkGroupRequest getWorkGroupRequest)

      Returns information about the workgroup with the specified name.

      Parameters:
      getWorkGroupRequest -
      Returns:
      A Java Future containing the result of the GetWorkGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getWorkGroup

      default CompletableFuture<GetWorkGroupResponse> getWorkGroup(Consumer<GetWorkGroupRequest.Builder> getWorkGroupRequest)

      Returns information about the workgroup with the specified name.


      This is a convenience which creates an instance of the GetWorkGroupRequest.Builder avoiding the need to create one manually via GetWorkGroupRequest.builder()

      Parameters:
      getWorkGroupRequest - A Consumer that will call methods on GetWorkGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetWorkGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • importNotebook

      default CompletableFuture<ImportNotebookResponse> importNotebook(ImportNotebookRequest importNotebookRequest)

      Imports a single ipynb file to a Spark enabled workgroup. To import the notebook, the request must specify a value for either Payload or NoteBookS3LocationUri. If neither is specified or both are specified, an InvalidRequestException occurs. The maximum file size that can be imported is 10 megabytes. If an ipynb file with the same name already exists in the workgroup, throws an error.

      Parameters:
      importNotebookRequest -
      Returns:
      A Java Future containing the result of the ImportNotebook operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • TooManyRequestsException Indicates that the request was throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • importNotebook

      default CompletableFuture<ImportNotebookResponse> importNotebook(Consumer<ImportNotebookRequest.Builder> importNotebookRequest)

      Imports a single ipynb file to a Spark enabled workgroup. To import the notebook, the request must specify a value for either Payload or NoteBookS3LocationUri. If neither is specified or both are specified, an InvalidRequestException occurs. The maximum file size that can be imported is 10 megabytes. If an ipynb file with the same name already exists in the workgroup, throws an error.


      This is a convenience which creates an instance of the ImportNotebookRequest.Builder avoiding the need to create one manually via ImportNotebookRequest.builder()

      Parameters:
      importNotebookRequest - A Consumer that will call methods on ImportNotebookRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ImportNotebook operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • TooManyRequestsException Indicates that the request was throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listApplicationDPUSizes

      default CompletableFuture<ListApplicationDpuSizesResponse> listApplicationDPUSizes(ListApplicationDpuSizesRequest listApplicationDpuSizesRequest)

      Returns the supported DPU sizes for the supported application runtimes (for example, Athena notebook version 1).

      Parameters:
      listApplicationDpuSizesRequest -
      Returns:
      A Java Future containing the result of the ListApplicationDPUSizes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • TooManyRequestsException Indicates that the request was throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listApplicationDPUSizes

      default CompletableFuture<ListApplicationDpuSizesResponse> listApplicationDPUSizes(Consumer<ListApplicationDpuSizesRequest.Builder> listApplicationDpuSizesRequest)

      Returns the supported DPU sizes for the supported application runtimes (for example, Athena notebook version 1).


      This is a convenience which creates an instance of the ListApplicationDpuSizesRequest.Builder avoiding the need to create one manually via ListApplicationDpuSizesRequest.builder()

      Parameters:
      listApplicationDpuSizesRequest - A Consumer that will call methods on ListApplicationDpuSizesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListApplicationDPUSizes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • TooManyRequestsException Indicates that the request was throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listApplicationDPUSizesPaginator

      default ListApplicationDPUSizesPublisher listApplicationDPUSizesPaginator(ListApplicationDpuSizesRequest listApplicationDpuSizesRequest)

      This is a variant of listApplicationDPUSizes(software.amazon.awssdk.services.athena.model.ListApplicationDpuSizesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListApplicationDPUSizesPublisher publisher = client.listApplicationDPUSizesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListApplicationDPUSizesPublisher publisher = client.listApplicationDPUSizesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListApplicationDpuSizesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListApplicationDpuSizesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listApplicationDPUSizes(software.amazon.awssdk.services.athena.model.ListApplicationDpuSizesRequest) operation.

      Parameters:
      listApplicationDpuSizesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • TooManyRequestsException Indicates that the request was throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listApplicationDPUSizesPaginator

      default ListApplicationDPUSizesPublisher listApplicationDPUSizesPaginator(Consumer<ListApplicationDpuSizesRequest.Builder> listApplicationDpuSizesRequest)

      This is a variant of listApplicationDPUSizes(software.amazon.awssdk.services.athena.model.ListApplicationDpuSizesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListApplicationDPUSizesPublisher publisher = client.listApplicationDPUSizesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListApplicationDPUSizesPublisher publisher = client.listApplicationDPUSizesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListApplicationDpuSizesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListApplicationDpuSizesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listApplicationDPUSizes(software.amazon.awssdk.services.athena.model.ListApplicationDpuSizesRequest) operation.


      This is a convenience which creates an instance of the ListApplicationDpuSizesRequest.Builder avoiding the need to create one manually via ListApplicationDpuSizesRequest.builder()

      Parameters:
      listApplicationDpuSizesRequest - A Consumer that will call methods on ListApplicationDpuSizesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • TooManyRequestsException Indicates that the request was throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCalculationExecutions

      default CompletableFuture<ListCalculationExecutionsResponse> listCalculationExecutions(ListCalculationExecutionsRequest listCalculationExecutionsRequest)

      Lists the calculations that have been submitted to a session in descending order. Newer calculations are listed first; older calculations are listed later.

      Parameters:
      listCalculationExecutionsRequest -
      Returns:
      A Java Future containing the result of the ListCalculationExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCalculationExecutions

      default CompletableFuture<ListCalculationExecutionsResponse> listCalculationExecutions(Consumer<ListCalculationExecutionsRequest.Builder> listCalculationExecutionsRequest)

      Lists the calculations that have been submitted to a session in descending order. Newer calculations are listed first; older calculations are listed later.


      This is a convenience which creates an instance of the ListCalculationExecutionsRequest.Builder avoiding the need to create one manually via ListCalculationExecutionsRequest.builder()

      Parameters:
      listCalculationExecutionsRequest - A Consumer that will call methods on ListCalculationExecutionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListCalculationExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCalculationExecutionsPaginator

      default ListCalculationExecutionsPublisher listCalculationExecutionsPaginator(ListCalculationExecutionsRequest listCalculationExecutionsRequest)

      This is a variant of listCalculationExecutions(software.amazon.awssdk.services.athena.model.ListCalculationExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListCalculationExecutionsPublisher publisher = client.listCalculationExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListCalculationExecutionsPublisher publisher = client.listCalculationExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListCalculationExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListCalculationExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCalculationExecutions(software.amazon.awssdk.services.athena.model.ListCalculationExecutionsRequest) operation.

      Parameters:
      listCalculationExecutionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCalculationExecutionsPaginator

      default ListCalculationExecutionsPublisher listCalculationExecutionsPaginator(Consumer<ListCalculationExecutionsRequest.Builder> listCalculationExecutionsRequest)

      This is a variant of listCalculationExecutions(software.amazon.awssdk.services.athena.model.ListCalculationExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListCalculationExecutionsPublisher publisher = client.listCalculationExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListCalculationExecutionsPublisher publisher = client.listCalculationExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListCalculationExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListCalculationExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCalculationExecutions(software.amazon.awssdk.services.athena.model.ListCalculationExecutionsRequest) operation.


      This is a convenience which creates an instance of the ListCalculationExecutionsRequest.Builder avoiding the need to create one manually via ListCalculationExecutionsRequest.builder()

      Parameters:
      listCalculationExecutionsRequest - A Consumer that will call methods on ListCalculationExecutionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCapacityReservations

      default CompletableFuture<ListCapacityReservationsResponse> listCapacityReservations(ListCapacityReservationsRequest listCapacityReservationsRequest)

      Lists the capacity reservations for the current account.

      Parameters:
      listCapacityReservationsRequest -
      Returns:
      A Java Future containing the result of the ListCapacityReservations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCapacityReservations

      default CompletableFuture<ListCapacityReservationsResponse> listCapacityReservations(Consumer<ListCapacityReservationsRequest.Builder> listCapacityReservationsRequest)

      Lists the capacity reservations for the current account.


      This is a convenience which creates an instance of the ListCapacityReservationsRequest.Builder avoiding the need to create one manually via ListCapacityReservationsRequest.builder()

      Parameters:
      listCapacityReservationsRequest - A Consumer that will call methods on ListCapacityReservationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListCapacityReservations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCapacityReservationsPaginator

      default ListCapacityReservationsPublisher listCapacityReservationsPaginator(ListCapacityReservationsRequest listCapacityReservationsRequest)

      This is a variant of listCapacityReservations(software.amazon.awssdk.services.athena.model.ListCapacityReservationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListCapacityReservationsPublisher publisher = client.listCapacityReservationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListCapacityReservationsPublisher publisher = client.listCapacityReservationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListCapacityReservationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListCapacityReservationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCapacityReservations(software.amazon.awssdk.services.athena.model.ListCapacityReservationsRequest) operation.

      Parameters:
      listCapacityReservationsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCapacityReservationsPaginator

      default ListCapacityReservationsPublisher listCapacityReservationsPaginator(Consumer<ListCapacityReservationsRequest.Builder> listCapacityReservationsRequest)

      This is a variant of listCapacityReservations(software.amazon.awssdk.services.athena.model.ListCapacityReservationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListCapacityReservationsPublisher publisher = client.listCapacityReservationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListCapacityReservationsPublisher publisher = client.listCapacityReservationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListCapacityReservationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListCapacityReservationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCapacityReservations(software.amazon.awssdk.services.athena.model.ListCapacityReservationsRequest) operation.


      This is a convenience which creates an instance of the ListCapacityReservationsRequest.Builder avoiding the need to create one manually via ListCapacityReservationsRequest.builder()

      Parameters:
      listCapacityReservationsRequest - A Consumer that will call methods on ListCapacityReservationsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDataCatalogs

      default CompletableFuture<ListDataCatalogsResponse> listDataCatalogs(ListDataCatalogsRequest listDataCatalogsRequest)

      Lists the data catalogs in the current Amazon Web Services account.

      In the Athena console, data catalogs are listed as "data sources" on the Data sources page under the Data source name column.

      Parameters:
      listDataCatalogsRequest -
      Returns:
      A Java Future containing the result of the ListDataCatalogs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDataCatalogs

      default CompletableFuture<ListDataCatalogsResponse> listDataCatalogs(Consumer<ListDataCatalogsRequest.Builder> listDataCatalogsRequest)

      Lists the data catalogs in the current Amazon Web Services account.

      In the Athena console, data catalogs are listed as "data sources" on the Data sources page under the Data source name column.


      This is a convenience which creates an instance of the ListDataCatalogsRequest.Builder avoiding the need to create one manually via ListDataCatalogsRequest.builder()

      Parameters:
      listDataCatalogsRequest - A Consumer that will call methods on ListDataCatalogsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDataCatalogs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDataCatalogsPaginator

      default ListDataCatalogsPublisher listDataCatalogsPaginator(ListDataCatalogsRequest listDataCatalogsRequest)

      This is a variant of listDataCatalogs(software.amazon.awssdk.services.athena.model.ListDataCatalogsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListDataCatalogsPublisher publisher = client.listDataCatalogsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListDataCatalogsPublisher publisher = client.listDataCatalogsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListDataCatalogsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListDataCatalogsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDataCatalogs(software.amazon.awssdk.services.athena.model.ListDataCatalogsRequest) operation.

      Parameters:
      listDataCatalogsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDataCatalogsPaginator

      default ListDataCatalogsPublisher listDataCatalogsPaginator(Consumer<ListDataCatalogsRequest.Builder> listDataCatalogsRequest)

      This is a variant of listDataCatalogs(software.amazon.awssdk.services.athena.model.ListDataCatalogsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListDataCatalogsPublisher publisher = client.listDataCatalogsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListDataCatalogsPublisher publisher = client.listDataCatalogsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListDataCatalogsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListDataCatalogsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDataCatalogs(software.amazon.awssdk.services.athena.model.ListDataCatalogsRequest) operation.


      This is a convenience which creates an instance of the ListDataCatalogsRequest.Builder avoiding the need to create one manually via ListDataCatalogsRequest.builder()

      Parameters:
      listDataCatalogsRequest - A Consumer that will call methods on ListDataCatalogsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDatabases

      default CompletableFuture<ListDatabasesResponse> listDatabases(ListDatabasesRequest listDatabasesRequest)

      Lists the databases in the specified data catalog.

      Parameters:
      listDatabasesRequest -
      Returns:
      A Java Future containing the result of the ListDatabases operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • MetadataException An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (InvalidRequestException) or from the Athena platform ( InternalServerException). For example, if a user-created Lambda function is missing permissions, the Lambda 4XX exception is returned in a MetadataException.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDatabases

      default CompletableFuture<ListDatabasesResponse> listDatabases(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest)

      Lists the databases in the specified data catalog.


      This is a convenience which creates an instance of the ListDatabasesRequest.Builder avoiding the need to create one manually via ListDatabasesRequest.builder()

      Parameters:
      listDatabasesRequest - A Consumer that will call methods on ListDatabasesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDatabases operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • MetadataException An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (InvalidRequestException) or from the Athena platform ( InternalServerException). For example, if a user-created Lambda function is missing permissions, the Lambda 4XX exception is returned in a MetadataException.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDatabasesPaginator

      default ListDatabasesPublisher listDatabasesPaginator(ListDatabasesRequest listDatabasesRequest)

      This is a variant of listDatabases(software.amazon.awssdk.services.athena.model.ListDatabasesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListDatabasesPublisher publisher = client.listDatabasesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListDatabasesPublisher publisher = client.listDatabasesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListDatabasesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListDatabasesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDatabases(software.amazon.awssdk.services.athena.model.ListDatabasesRequest) operation.

      Parameters:
      listDatabasesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • MetadataException An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (InvalidRequestException) or from the Athena platform ( InternalServerException). For example, if a user-created Lambda function is missing permissions, the Lambda 4XX exception is returned in a MetadataException.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDatabasesPaginator

      default ListDatabasesPublisher listDatabasesPaginator(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest)

      This is a variant of listDatabases(software.amazon.awssdk.services.athena.model.ListDatabasesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListDatabasesPublisher publisher = client.listDatabasesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListDatabasesPublisher publisher = client.listDatabasesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListDatabasesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListDatabasesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listDatabases(software.amazon.awssdk.services.athena.model.ListDatabasesRequest) operation.


      This is a convenience which creates an instance of the ListDatabasesRequest.Builder avoiding the need to create one manually via ListDatabasesRequest.builder()

      Parameters:
      listDatabasesRequest - A Consumer that will call methods on ListDatabasesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • MetadataException An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (InvalidRequestException) or from the Athena platform ( InternalServerException). For example, if a user-created Lambda function is missing permissions, the Lambda 4XX exception is returned in a MetadataException.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEngineVersions

      default CompletableFuture<ListEngineVersionsResponse> listEngineVersions(ListEngineVersionsRequest listEngineVersionsRequest)

      Returns a list of engine versions that are available to choose from, including the Auto option.

      Parameters:
      listEngineVersionsRequest -
      Returns:
      A Java Future containing the result of the ListEngineVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEngineVersions

      default CompletableFuture<ListEngineVersionsResponse> listEngineVersions(Consumer<ListEngineVersionsRequest.Builder> listEngineVersionsRequest)

      Returns a list of engine versions that are available to choose from, including the Auto option.


      This is a convenience which creates an instance of the ListEngineVersionsRequest.Builder avoiding the need to create one manually via ListEngineVersionsRequest.builder()

      Parameters:
      listEngineVersionsRequest - A Consumer that will call methods on ListEngineVersionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListEngineVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEngineVersionsPaginator

      default ListEngineVersionsPublisher listEngineVersionsPaginator(ListEngineVersionsRequest listEngineVersionsRequest)

      This is a variant of listEngineVersions(software.amazon.awssdk.services.athena.model.ListEngineVersionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListEngineVersionsPublisher publisher = client.listEngineVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListEngineVersionsPublisher publisher = client.listEngineVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListEngineVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListEngineVersionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listEngineVersions(software.amazon.awssdk.services.athena.model.ListEngineVersionsRequest) operation.

      Parameters:
      listEngineVersionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEngineVersionsPaginator

      default ListEngineVersionsPublisher listEngineVersionsPaginator(Consumer<ListEngineVersionsRequest.Builder> listEngineVersionsRequest)

      This is a variant of listEngineVersions(software.amazon.awssdk.services.athena.model.ListEngineVersionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListEngineVersionsPublisher publisher = client.listEngineVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListEngineVersionsPublisher publisher = client.listEngineVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListEngineVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListEngineVersionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listEngineVersions(software.amazon.awssdk.services.athena.model.ListEngineVersionsRequest) operation.


      This is a convenience which creates an instance of the ListEngineVersionsRequest.Builder avoiding the need to create one manually via ListEngineVersionsRequest.builder()

      Parameters:
      listEngineVersionsRequest - A Consumer that will call methods on ListEngineVersionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExecutors

      default CompletableFuture<ListExecutorsResponse> listExecutors(ListExecutorsRequest listExecutorsRequest)

      Lists, in descending order, the executors that joined a session. Newer executors are listed first; older executors are listed later. The result can be optionally filtered by state.

      Parameters:
      listExecutorsRequest -
      Returns:
      A Java Future containing the result of the ListExecutors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExecutors

      default CompletableFuture<ListExecutorsResponse> listExecutors(Consumer<ListExecutorsRequest.Builder> listExecutorsRequest)

      Lists, in descending order, the executors that joined a session. Newer executors are listed first; older executors are listed later. The result can be optionally filtered by state.


      This is a convenience which creates an instance of the ListExecutorsRequest.Builder avoiding the need to create one manually via ListExecutorsRequest.builder()

      Parameters:
      listExecutorsRequest - A Consumer that will call methods on ListExecutorsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListExecutors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExecutorsPaginator

      default ListExecutorsPublisher listExecutorsPaginator(ListExecutorsRequest listExecutorsRequest)

      This is a variant of listExecutors(software.amazon.awssdk.services.athena.model.ListExecutorsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListExecutorsPublisher publisher = client.listExecutorsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListExecutorsPublisher publisher = client.listExecutorsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListExecutorsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListExecutorsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listExecutors(software.amazon.awssdk.services.athena.model.ListExecutorsRequest) operation.

      Parameters:
      listExecutorsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExecutorsPaginator

      default ListExecutorsPublisher listExecutorsPaginator(Consumer<ListExecutorsRequest.Builder> listExecutorsRequest)

      This is a variant of listExecutors(software.amazon.awssdk.services.athena.model.ListExecutorsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListExecutorsPublisher publisher = client.listExecutorsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListExecutorsPublisher publisher = client.listExecutorsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListExecutorsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListExecutorsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listExecutors(software.amazon.awssdk.services.athena.model.ListExecutorsRequest) operation.


      This is a convenience which creates an instance of the ListExecutorsRequest.Builder avoiding the need to create one manually via ListExecutorsRequest.builder()

      Parameters:
      listExecutorsRequest - A Consumer that will call methods on ListExecutorsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNamedQueries

      default CompletableFuture<ListNamedQueriesResponse> listNamedQueries(ListNamedQueriesRequest listNamedQueriesRequest)

      Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the specified workgroup. If a workgroup is not specified, lists the saved queries for the primary workgroup.

      Parameters:
      listNamedQueriesRequest -
      Returns:
      A Java Future containing the result of the ListNamedQueries operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNamedQueries

      default CompletableFuture<ListNamedQueriesResponse> listNamedQueries(Consumer<ListNamedQueriesRequest.Builder> listNamedQueriesRequest)

      Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the specified workgroup. If a workgroup is not specified, lists the saved queries for the primary workgroup.


      This is a convenience which creates an instance of the ListNamedQueriesRequest.Builder avoiding the need to create one manually via ListNamedQueriesRequest.builder()

      Parameters:
      listNamedQueriesRequest - A Consumer that will call methods on ListNamedQueriesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListNamedQueries operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNamedQueries

      default CompletableFuture<ListNamedQueriesResponse> listNamedQueries()

      Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the specified workgroup. If a workgroup is not specified, lists the saved queries for the primary workgroup.

      Returns:
      A Java Future containing the result of the ListNamedQueries operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNamedQueriesPaginator

      default ListNamedQueriesPublisher listNamedQueriesPaginator()

      This is a variant of listNamedQueries(software.amazon.awssdk.services.athena.model.ListNamedQueriesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListNamedQueriesPublisher publisher = client.listNamedQueriesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListNamedQueriesPublisher publisher = client.listNamedQueriesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListNamedQueriesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListNamedQueriesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listNamedQueries(software.amazon.awssdk.services.athena.model.ListNamedQueriesRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNamedQueriesPaginator

      default ListNamedQueriesPublisher listNamedQueriesPaginator(ListNamedQueriesRequest listNamedQueriesRequest)

      This is a variant of listNamedQueries(software.amazon.awssdk.services.athena.model.ListNamedQueriesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListNamedQueriesPublisher publisher = client.listNamedQueriesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListNamedQueriesPublisher publisher = client.listNamedQueriesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListNamedQueriesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListNamedQueriesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listNamedQueries(software.amazon.awssdk.services.athena.model.ListNamedQueriesRequest) operation.

      Parameters:
      listNamedQueriesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNamedQueriesPaginator

      default ListNamedQueriesPublisher listNamedQueriesPaginator(Consumer<ListNamedQueriesRequest.Builder> listNamedQueriesRequest)

      This is a variant of listNamedQueries(software.amazon.awssdk.services.athena.model.ListNamedQueriesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListNamedQueriesPublisher publisher = client.listNamedQueriesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListNamedQueriesPublisher publisher = client.listNamedQueriesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListNamedQueriesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListNamedQueriesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listNamedQueries(software.amazon.awssdk.services.athena.model.ListNamedQueriesRequest) operation.


      This is a convenience which creates an instance of the ListNamedQueriesRequest.Builder avoiding the need to create one manually via ListNamedQueriesRequest.builder()

      Parameters:
      listNamedQueriesRequest - A Consumer that will call methods on ListNamedQueriesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNotebookMetadata

      default CompletableFuture<ListNotebookMetadataResponse> listNotebookMetadata(ListNotebookMetadataRequest listNotebookMetadataRequest)

      Displays the notebook files for the specified workgroup in paginated format.

      Parameters:
      listNotebookMetadataRequest -
      Returns:
      A Java Future containing the result of the ListNotebookMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • TooManyRequestsException Indicates that the request was throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNotebookMetadata

      default CompletableFuture<ListNotebookMetadataResponse> listNotebookMetadata(Consumer<ListNotebookMetadataRequest.Builder> listNotebookMetadataRequest)

      Displays the notebook files for the specified workgroup in paginated format.


      This is a convenience which creates an instance of the ListNotebookMetadataRequest.Builder avoiding the need to create one manually via ListNotebookMetadataRequest.builder()

      Parameters:
      listNotebookMetadataRequest - A Consumer that will call methods on ListNotebookMetadataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListNotebookMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • TooManyRequestsException Indicates that the request was throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNotebookSessions

      default CompletableFuture<ListNotebookSessionsResponse> listNotebookSessions(ListNotebookSessionsRequest listNotebookSessionsRequest)

      Lists, in descending order, the sessions that have been created in a notebook that are in an active state like CREATING, CREATED, IDLE or BUSY. Newer sessions are listed first; older sessions are listed later.

      Parameters:
      listNotebookSessionsRequest -
      Returns:
      A Java Future containing the result of the ListNotebookSessions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listNotebookSessions

      default CompletableFuture<ListNotebookSessionsResponse> listNotebookSessions(Consumer<ListNotebookSessionsRequest.Builder> listNotebookSessionsRequest)

      Lists, in descending order, the sessions that have been created in a notebook that are in an active state like CREATING, CREATED, IDLE or BUSY. Newer sessions are listed first; older sessions are listed later.


      This is a convenience which creates an instance of the ListNotebookSessionsRequest.Builder avoiding the need to create one manually via ListNotebookSessionsRequest.builder()

      Parameters:
      listNotebookSessionsRequest - A Consumer that will call methods on ListNotebookSessionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListNotebookSessions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPreparedStatements

      default CompletableFuture<ListPreparedStatementsResponse> listPreparedStatements(ListPreparedStatementsRequest listPreparedStatementsRequest)

      Lists the prepared statements in the specified workgroup.

      Parameters:
      listPreparedStatementsRequest -
      Returns:
      A Java Future containing the result of the ListPreparedStatements operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPreparedStatements

      default CompletableFuture<ListPreparedStatementsResponse> listPreparedStatements(Consumer<ListPreparedStatementsRequest.Builder> listPreparedStatementsRequest)

      Lists the prepared statements in the specified workgroup.


      This is a convenience which creates an instance of the ListPreparedStatementsRequest.Builder avoiding the need to create one manually via ListPreparedStatementsRequest.builder()

      Parameters:
      listPreparedStatementsRequest - A Consumer that will call methods on ListPreparedStatementsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPreparedStatements operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPreparedStatementsPaginator

      default ListPreparedStatementsPublisher listPreparedStatementsPaginator(ListPreparedStatementsRequest listPreparedStatementsRequest)

      This is a variant of listPreparedStatements(software.amazon.awssdk.services.athena.model.ListPreparedStatementsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListPreparedStatementsPublisher publisher = client.listPreparedStatementsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListPreparedStatementsPublisher publisher = client.listPreparedStatementsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListPreparedStatementsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListPreparedStatementsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPreparedStatements(software.amazon.awssdk.services.athena.model.ListPreparedStatementsRequest) operation.

      Parameters:
      listPreparedStatementsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPreparedStatementsPaginator

      default ListPreparedStatementsPublisher listPreparedStatementsPaginator(Consumer<ListPreparedStatementsRequest.Builder> listPreparedStatementsRequest)

      This is a variant of listPreparedStatements(software.amazon.awssdk.services.athena.model.ListPreparedStatementsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListPreparedStatementsPublisher publisher = client.listPreparedStatementsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListPreparedStatementsPublisher publisher = client.listPreparedStatementsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListPreparedStatementsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListPreparedStatementsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPreparedStatements(software.amazon.awssdk.services.athena.model.ListPreparedStatementsRequest) operation.


      This is a convenience which creates an instance of the ListPreparedStatementsRequest.Builder avoiding the need to create one manually via ListPreparedStatementsRequest.builder()

      Parameters:
      listPreparedStatementsRequest - A Consumer that will call methods on ListPreparedStatementsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQueryExecutions

      default CompletableFuture<ListQueryExecutionsResponse> listQueryExecutions(ListQueryExecutionsRequest listQueryExecutionsRequest)

      Provides a list of available query execution IDs for the queries in the specified workgroup. Athena keeps a query history for 45 days. If a workgroup is not specified, returns a list of query execution IDs for the primary workgroup. Requires you to have access to the workgroup in which the queries ran.

      Parameters:
      listQueryExecutionsRequest -
      Returns:
      A Java Future containing the result of the ListQueryExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQueryExecutions

      default CompletableFuture<ListQueryExecutionsResponse> listQueryExecutions(Consumer<ListQueryExecutionsRequest.Builder> listQueryExecutionsRequest)

      Provides a list of available query execution IDs for the queries in the specified workgroup. Athena keeps a query history for 45 days. If a workgroup is not specified, returns a list of query execution IDs for the primary workgroup. Requires you to have access to the workgroup in which the queries ran.


      This is a convenience which creates an instance of the ListQueryExecutionsRequest.Builder avoiding the need to create one manually via ListQueryExecutionsRequest.builder()

      Parameters:
      listQueryExecutionsRequest - A Consumer that will call methods on ListQueryExecutionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListQueryExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQueryExecutions

      default CompletableFuture<ListQueryExecutionsResponse> listQueryExecutions()

      Provides a list of available query execution IDs for the queries in the specified workgroup. Athena keeps a query history for 45 days. If a workgroup is not specified, returns a list of query execution IDs for the primary workgroup. Requires you to have access to the workgroup in which the queries ran.

      Returns:
      A Java Future containing the result of the ListQueryExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQueryExecutionsPaginator

      default ListQueryExecutionsPublisher listQueryExecutionsPaginator()

      This is a variant of listQueryExecutions(software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListQueryExecutionsPublisher publisher = client.listQueryExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListQueryExecutionsPublisher publisher = client.listQueryExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListQueryExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListQueryExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listQueryExecutions(software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQueryExecutionsPaginator

      default ListQueryExecutionsPublisher listQueryExecutionsPaginator(ListQueryExecutionsRequest listQueryExecutionsRequest)

      This is a variant of listQueryExecutions(software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListQueryExecutionsPublisher publisher = client.listQueryExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListQueryExecutionsPublisher publisher = client.listQueryExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListQueryExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListQueryExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listQueryExecutions(software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest) operation.

      Parameters:
      listQueryExecutionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQueryExecutionsPaginator

      default ListQueryExecutionsPublisher listQueryExecutionsPaginator(Consumer<ListQueryExecutionsRequest.Builder> listQueryExecutionsRequest)

      This is a variant of listQueryExecutions(software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListQueryExecutionsPublisher publisher = client.listQueryExecutionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListQueryExecutionsPublisher publisher = client.listQueryExecutionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListQueryExecutionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListQueryExecutionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listQueryExecutions(software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest) operation.


      This is a convenience which creates an instance of the ListQueryExecutionsRequest.Builder avoiding the need to create one manually via ListQueryExecutionsRequest.builder()

      Parameters:
      listQueryExecutionsRequest - A Consumer that will call methods on ListQueryExecutionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSessions

      default CompletableFuture<ListSessionsResponse> listSessions(ListSessionsRequest listSessionsRequest)

      Lists the sessions in a workgroup that are in an active state like CREATING, CREATED, IDLE, or BUSY. Newer sessions are listed first; older sessions are listed later.

      Parameters:
      listSessionsRequest -
      Returns:
      A Java Future containing the result of the ListSessions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSessions

      default CompletableFuture<ListSessionsResponse> listSessions(Consumer<ListSessionsRequest.Builder> listSessionsRequest)

      Lists the sessions in a workgroup that are in an active state like CREATING, CREATED, IDLE, or BUSY. Newer sessions are listed first; older sessions are listed later.


      This is a convenience which creates an instance of the ListSessionsRequest.Builder avoiding the need to create one manually via ListSessionsRequest.builder()

      Parameters:
      listSessionsRequest - A Consumer that will call methods on ListSessionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListSessions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSessionsPaginator

      default ListSessionsPublisher listSessionsPaginator(ListSessionsRequest listSessionsRequest)

      This is a variant of listSessions(software.amazon.awssdk.services.athena.model.ListSessionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListSessionsPublisher publisher = client.listSessionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListSessionsPublisher publisher = client.listSessionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListSessionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListSessionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSessions(software.amazon.awssdk.services.athena.model.ListSessionsRequest) operation.

      Parameters:
      listSessionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSessionsPaginator

      default ListSessionsPublisher listSessionsPaginator(Consumer<ListSessionsRequest.Builder> listSessionsRequest)

      This is a variant of listSessions(software.amazon.awssdk.services.athena.model.ListSessionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListSessionsPublisher publisher = client.listSessionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListSessionsPublisher publisher = client.listSessionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListSessionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListSessionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSessions(software.amazon.awssdk.services.athena.model.ListSessionsRequest) operation.


      This is a convenience which creates an instance of the ListSessionsRequest.Builder avoiding the need to create one manually via ListSessionsRequest.builder()

      Parameters:
      listSessionsRequest - A Consumer that will call methods on ListSessionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTableMetadata

      default CompletableFuture<ListTableMetadataResponse> listTableMetadata(ListTableMetadataRequest listTableMetadataRequest)

      Lists the metadata for the tables in the specified data catalog database.

      Parameters:
      listTableMetadataRequest -
      Returns:
      A Java Future containing the result of the ListTableMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • MetadataException An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (InvalidRequestException) or from the Athena platform ( InternalServerException). For example, if a user-created Lambda function is missing permissions, the Lambda 4XX exception is returned in a MetadataException.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTableMetadata

      default CompletableFuture<ListTableMetadataResponse> listTableMetadata(Consumer<ListTableMetadataRequest.Builder> listTableMetadataRequest)

      Lists the metadata for the tables in the specified data catalog database.


      This is a convenience which creates an instance of the ListTableMetadataRequest.Builder avoiding the need to create one manually via ListTableMetadataRequest.builder()

      Parameters:
      listTableMetadataRequest - A Consumer that will call methods on ListTableMetadataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTableMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • MetadataException An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (InvalidRequestException) or from the Athena platform ( InternalServerException). For example, if a user-created Lambda function is missing permissions, the Lambda 4XX exception is returned in a MetadataException.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTableMetadataPaginator

      default ListTableMetadataPublisher listTableMetadataPaginator(ListTableMetadataRequest listTableMetadataRequest)

      This is a variant of listTableMetadata(software.amazon.awssdk.services.athena.model.ListTableMetadataRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListTableMetadataPublisher publisher = client.listTableMetadataPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListTableMetadataPublisher publisher = client.listTableMetadataPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListTableMetadataResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListTableMetadataResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTableMetadata(software.amazon.awssdk.services.athena.model.ListTableMetadataRequest) operation.

      Parameters:
      listTableMetadataRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • MetadataException An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (InvalidRequestException) or from the Athena platform ( InternalServerException). For example, if a user-created Lambda function is missing permissions, the Lambda 4XX exception is returned in a MetadataException.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTableMetadataPaginator

      default ListTableMetadataPublisher listTableMetadataPaginator(Consumer<ListTableMetadataRequest.Builder> listTableMetadataRequest)

      This is a variant of listTableMetadata(software.amazon.awssdk.services.athena.model.ListTableMetadataRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListTableMetadataPublisher publisher = client.listTableMetadataPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListTableMetadataPublisher publisher = client.listTableMetadataPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListTableMetadataResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListTableMetadataResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTableMetadata(software.amazon.awssdk.services.athena.model.ListTableMetadataRequest) operation.


      This is a convenience which creates an instance of the ListTableMetadataRequest.Builder avoiding the need to create one manually via ListTableMetadataRequest.builder()

      Parameters:
      listTableMetadataRequest - A Consumer that will call methods on ListTableMetadataRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • MetadataException An exception that Athena received when it called a custom metastore. Occurs if the error is not caused by user input (InvalidRequestException) or from the Athena platform ( InternalServerException). For example, if a user-created Lambda function is missing permissions, the Lambda 4XX exception is returned in a MetadataException.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Lists the tags associated with an Athena resource.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Lists the tags associated with an Athena resource.


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResourcePaginator

      default ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)

      This is a variant of listTagsForResource(software.amazon.awssdk.services.athena.model.ListTagsForResourceRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListTagsForResourceResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListTagsForResourceResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTagsForResource(software.amazon.awssdk.services.athena.model.ListTagsForResourceRequest) operation.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResourcePaginator

      default ListTagsForResourcePublisher listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      This is a variant of listTagsForResource(software.amazon.awssdk.services.athena.model.ListTagsForResourceRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListTagsForResourceResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListTagsForResourceResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTagsForResource(software.amazon.awssdk.services.athena.model.ListTagsForResourceRequest) operation.


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkGroups

      default CompletableFuture<ListWorkGroupsResponse> listWorkGroups(ListWorkGroupsRequest listWorkGroupsRequest)

      Lists available workgroups for the account.

      Parameters:
      listWorkGroupsRequest -
      Returns:
      A Java Future containing the result of the ListWorkGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkGroups

      default CompletableFuture<ListWorkGroupsResponse> listWorkGroups(Consumer<ListWorkGroupsRequest.Builder> listWorkGroupsRequest)

      Lists available workgroups for the account.


      This is a convenience which creates an instance of the ListWorkGroupsRequest.Builder avoiding the need to create one manually via ListWorkGroupsRequest.builder()

      Parameters:
      listWorkGroupsRequest - A Consumer that will call methods on ListWorkGroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListWorkGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkGroupsPaginator

      default ListWorkGroupsPublisher listWorkGroupsPaginator(ListWorkGroupsRequest listWorkGroupsRequest)

      This is a variant of listWorkGroups(software.amazon.awssdk.services.athena.model.ListWorkGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListWorkGroupsPublisher publisher = client.listWorkGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListWorkGroupsPublisher publisher = client.listWorkGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListWorkGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListWorkGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listWorkGroups(software.amazon.awssdk.services.athena.model.ListWorkGroupsRequest) operation.

      Parameters:
      listWorkGroupsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listWorkGroupsPaginator

      default ListWorkGroupsPublisher listWorkGroupsPaginator(Consumer<ListWorkGroupsRequest.Builder> listWorkGroupsRequest)

      This is a variant of listWorkGroups(software.amazon.awssdk.services.athena.model.ListWorkGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.athena.paginators.ListWorkGroupsPublisher publisher = client.listWorkGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.athena.paginators.ListWorkGroupsPublisher publisher = client.listWorkGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.athena.model.ListWorkGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.athena.model.ListWorkGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listWorkGroups(software.amazon.awssdk.services.athena.model.ListWorkGroupsRequest) operation.


      This is a convenience which creates an instance of the ListWorkGroupsRequest.Builder avoiding the need to create one manually via ListWorkGroupsRequest.builder()

      Parameters:
      listWorkGroupsRequest - A Consumer that will call methods on ListWorkGroupsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putCapacityAssignmentConfiguration

      default CompletableFuture<PutCapacityAssignmentConfigurationResponse> putCapacityAssignmentConfiguration(PutCapacityAssignmentConfigurationRequest putCapacityAssignmentConfigurationRequest)

      Puts a new capacity assignment configuration for a specified capacity reservation. If a capacity assignment configuration already exists for the capacity reservation, replaces the existing capacity assignment configuration.

      Parameters:
      putCapacityAssignmentConfigurationRequest -
      Returns:
      A Java Future containing the result of the PutCapacityAssignmentConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putCapacityAssignmentConfiguration

      default CompletableFuture<PutCapacityAssignmentConfigurationResponse> putCapacityAssignmentConfiguration(Consumer<PutCapacityAssignmentConfigurationRequest.Builder> putCapacityAssignmentConfigurationRequest)

      Puts a new capacity assignment configuration for a specified capacity reservation. If a capacity assignment configuration already exists for the capacity reservation, replaces the existing capacity assignment configuration.


      This is a convenience which creates an instance of the PutCapacityAssignmentConfigurationRequest.Builder avoiding the need to create one manually via PutCapacityAssignmentConfigurationRequest.builder()

      Parameters:
      putCapacityAssignmentConfigurationRequest - A Consumer that will call methods on PutCapacityAssignmentConfigurationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutCapacityAssignmentConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startCalculationExecution

      default CompletableFuture<StartCalculationExecutionResponse> startCalculationExecution(StartCalculationExecutionRequest startCalculationExecutionRequest)

      Submits calculations for execution within a session. You can supply the code to run as an inline code block within the request.

      The request syntax requires the StartCalculationExecutionRequestinvalid input: '&#36'CodeBlock parameter or the CalculationConfigurationinvalid input: '&#36'CodeBlock parameter, but not both. Because CalculationConfigurationinvalid input: '&#36'CodeBlock is deprecated, use the StartCalculationExecutionRequestinvalid input: '&#36'CodeBlock parameter instead.

      Parameters:
      startCalculationExecutionRequest -
      Returns:
      A Java Future containing the result of the StartCalculationExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startCalculationExecution

      default CompletableFuture<StartCalculationExecutionResponse> startCalculationExecution(Consumer<StartCalculationExecutionRequest.Builder> startCalculationExecutionRequest)

      Submits calculations for execution within a session. You can supply the code to run as an inline code block within the request.

      The request syntax requires the StartCalculationExecutionRequestinvalid input: '&#36'CodeBlock parameter or the CalculationConfigurationinvalid input: '&#36'CodeBlock parameter, but not both. Because CalculationConfigurationinvalid input: '&#36'CodeBlock is deprecated, use the StartCalculationExecutionRequestinvalid input: '&#36'CodeBlock parameter instead.


      This is a convenience which creates an instance of the StartCalculationExecutionRequest.Builder avoiding the need to create one manually via StartCalculationExecutionRequest.builder()

      Parameters:
      startCalculationExecutionRequest - A Consumer that will call methods on StartCalculationExecutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartCalculationExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startQueryExecution

      default CompletableFuture<StartQueryExecutionResponse> startQueryExecution(StartQueryExecutionRequest startQueryExecutionRequest)

      Runs the SQL query statements contained in the Query. Requires you to have access to the workgroup in which the query ran. Running queries against an external catalog requires GetDataCatalog permission to the catalog. For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

      Parameters:
      startQueryExecutionRequest -
      Returns:
      A Java Future containing the result of the StartQueryExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • TooManyRequestsException Indicates that the request was throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startQueryExecution

      default CompletableFuture<StartQueryExecutionResponse> startQueryExecution(Consumer<StartQueryExecutionRequest.Builder> startQueryExecutionRequest)

      Runs the SQL query statements contained in the Query. Requires you to have access to the workgroup in which the query ran. Running queries against an external catalog requires GetDataCatalog permission to the catalog. For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.


      This is a convenience which creates an instance of the StartQueryExecutionRequest.Builder avoiding the need to create one manually via StartQueryExecutionRequest.builder()

      Parameters:
      startQueryExecutionRequest - A Consumer that will call methods on StartQueryExecutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartQueryExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • TooManyRequestsException Indicates that the request was throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startSession

      default CompletableFuture<StartSessionResponse> startSession(StartSessionRequest startSessionRequest)

      Creates a session for running calculations within a workgroup. The session is ready when it reaches an IDLE state.

      Parameters:
      startSessionRequest -
      Returns:
      A Java Future containing the result of the StartSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SessionAlreadyExistsException The specified session already exists.
      • TooManyRequestsException Indicates that the request was throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startSession

      default CompletableFuture<StartSessionResponse> startSession(Consumer<StartSessionRequest.Builder> startSessionRequest)

      Creates a session for running calculations within a workgroup. The session is ready when it reaches an IDLE state.


      This is a convenience which creates an instance of the StartSessionRequest.Builder avoiding the need to create one manually via StartSessionRequest.builder()

      Parameters:
      startSessionRequest - A Consumer that will call methods on StartSessionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SessionAlreadyExistsException The specified session already exists.
      • TooManyRequestsException Indicates that the request was throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopCalculationExecution

      default CompletableFuture<StopCalculationExecutionResponse> stopCalculationExecution(StopCalculationExecutionRequest stopCalculationExecutionRequest)

      Requests the cancellation of a calculation. A StopCalculationExecution call on a calculation that is already in a terminal state (for example, STOPPED, FAILED, or COMPLETED) succeeds but has no effect.

      Cancelling a calculation is done on a best effort basis. If a calculation cannot be cancelled, you can be charged for its completion. If you are concerned about being charged for a calculation that cannot be cancelled, consider terminating the session in which the calculation is running.

      Parameters:
      stopCalculationExecutionRequest -
      Returns:
      A Java Future containing the result of the StopCalculationExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopCalculationExecution

      default CompletableFuture<StopCalculationExecutionResponse> stopCalculationExecution(Consumer<StopCalculationExecutionRequest.Builder> stopCalculationExecutionRequest)

      Requests the cancellation of a calculation. A StopCalculationExecution call on a calculation that is already in a terminal state (for example, STOPPED, FAILED, or COMPLETED) succeeds but has no effect.

      Cancelling a calculation is done on a best effort basis. If a calculation cannot be cancelled, you can be charged for its completion. If you are concerned about being charged for a calculation that cannot be cancelled, consider terminating the session in which the calculation is running.


      This is a convenience which creates an instance of the StopCalculationExecutionRequest.Builder avoiding the need to create one manually via StopCalculationExecutionRequest.builder()

      Parameters:
      stopCalculationExecutionRequest - A Consumer that will call methods on StopCalculationExecutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopCalculationExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopQueryExecution

      default CompletableFuture<StopQueryExecutionResponse> stopQueryExecution(StopQueryExecutionRequest stopQueryExecutionRequest)

      Stops a query execution. Requires you to have access to the workgroup in which the query ran.

      Parameters:
      stopQueryExecutionRequest -
      Returns:
      A Java Future containing the result of the StopQueryExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopQueryExecution

      default CompletableFuture<StopQueryExecutionResponse> stopQueryExecution(Consumer<StopQueryExecutionRequest.Builder> stopQueryExecutionRequest)

      Stops a query execution. Requires you to have access to the workgroup in which the query ran.


      This is a convenience which creates an instance of the StopQueryExecutionRequest.Builder avoiding the need to create one manually via StopQueryExecutionRequest.builder()

      Parameters:
      stopQueryExecutionRequest - A Consumer that will call methods on StopQueryExecutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopQueryExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Adds one or more tags to an Athena resource. A tag is a label that you assign to a resource. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena workgroups, data catalogs, or capacity reservations by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter the resources in your account. For best practices, see Tagging Best Practices. Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one tag, separate them by commas.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      Adds one or more tags to an Athena resource. A tag is a label that you assign to a resource. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena workgroups, data catalogs, or capacity reservations by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter the resources in your account. For best practices, see Tagging Best Practices. Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one tag, separate them by commas.


      This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • terminateSession

      default CompletableFuture<TerminateSessionResponse> terminateSession(TerminateSessionRequest terminateSessionRequest)

      Terminates an active session. A TerminateSession call on a session that is already inactive (for example, in a FAILED, TERMINATED or TERMINATING state) succeeds but has no effect. Calculations running in the session when TerminateSession is called are forcefully stopped, but may display as FAILED instead of STOPPED.

      Parameters:
      terminateSessionRequest -
      Returns:
      A Java Future containing the result of the TerminateSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • terminateSession

      default CompletableFuture<TerminateSessionResponse> terminateSession(Consumer<TerminateSessionRequest.Builder> terminateSessionRequest)

      Terminates an active session. A TerminateSession call on a session that is already inactive (for example, in a FAILED, TERMINATED or TERMINATING state) succeeds but has no effect. Calculations running in the session when TerminateSession is called are forcefully stopped, but may display as FAILED instead of STOPPED.


      This is a convenience which creates an instance of the TerminateSessionRequest.Builder avoiding the need to create one manually via TerminateSessionRequest.builder()

      Parameters:
      terminateSessionRequest - A Consumer that will call methods on TerminateSessionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TerminateSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes one or more tags from an Athena resource.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Removes one or more tags from an Athena resource.


      This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateCapacityReservation

      default CompletableFuture<UpdateCapacityReservationResponse> updateCapacityReservation(UpdateCapacityReservationRequest updateCapacityReservationRequest)

      Updates the number of requested data processing units for the capacity reservation with the specified name.

      Parameters:
      updateCapacityReservationRequest -
      Returns:
      A Java Future containing the result of the UpdateCapacityReservation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateCapacityReservation

      default CompletableFuture<UpdateCapacityReservationResponse> updateCapacityReservation(Consumer<UpdateCapacityReservationRequest.Builder> updateCapacityReservationRequest)

      Updates the number of requested data processing units for the capacity reservation with the specified name.


      This is a convenience which creates an instance of the UpdateCapacityReservationRequest.Builder avoiding the need to create one manually via UpdateCapacityReservationRequest.builder()

      Parameters:
      updateCapacityReservationRequest - A Consumer that will call methods on UpdateCapacityReservationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateCapacityReservation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDataCatalog

      default CompletableFuture<UpdateDataCatalogResponse> updateDataCatalog(UpdateDataCatalogRequest updateDataCatalogRequest)

      Updates the data catalog that has the specified name.

      Parameters:
      updateDataCatalogRequest -
      Returns:
      A Java Future containing the result of the UpdateDataCatalog operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDataCatalog

      default CompletableFuture<UpdateDataCatalogResponse> updateDataCatalog(Consumer<UpdateDataCatalogRequest.Builder> updateDataCatalogRequest)

      Updates the data catalog that has the specified name.


      This is a convenience which creates an instance of the UpdateDataCatalogRequest.Builder avoiding the need to create one manually via UpdateDataCatalogRequest.builder()

      Parameters:
      updateDataCatalogRequest - A Consumer that will call methods on UpdateDataCatalogRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateDataCatalog operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateNamedQuery

      default CompletableFuture<UpdateNamedQueryResponse> updateNamedQuery(UpdateNamedQueryRequest updateNamedQueryRequest)

      Updates a NamedQuery object. The database or workgroup cannot be updated.

      Parameters:
      updateNamedQueryRequest -
      Returns:
      A Java Future containing the result of the UpdateNamedQuery operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateNamedQuery

      default CompletableFuture<UpdateNamedQueryResponse> updateNamedQuery(Consumer<UpdateNamedQueryRequest.Builder> updateNamedQueryRequest)

      Updates a NamedQuery object. The database or workgroup cannot be updated.


      This is a convenience which creates an instance of the UpdateNamedQueryRequest.Builder avoiding the need to create one manually via UpdateNamedQueryRequest.builder()

      Parameters:
      updateNamedQueryRequest - A Consumer that will call methods on UpdateNamedQueryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateNamedQuery operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateNotebook

      default CompletableFuture<UpdateNotebookResponse> updateNotebook(UpdateNotebookRequest updateNotebookRequest)

      Updates the contents of a Spark notebook.

      Parameters:
      updateNotebookRequest -
      Returns:
      A Java Future containing the result of the UpdateNotebook operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • TooManyRequestsException Indicates that the request was throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateNotebook

      default CompletableFuture<UpdateNotebookResponse> updateNotebook(Consumer<UpdateNotebookRequest.Builder> updateNotebookRequest)

      Updates the contents of a Spark notebook.


      This is a convenience which creates an instance of the UpdateNotebookRequest.Builder avoiding the need to create one manually via UpdateNotebookRequest.builder()

      Parameters:
      updateNotebookRequest - A Consumer that will call methods on UpdateNotebookRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateNotebook operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • TooManyRequestsException Indicates that the request was throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateNotebookMetadata

      default CompletableFuture<UpdateNotebookMetadataResponse> updateNotebookMetadata(UpdateNotebookMetadataRequest updateNotebookMetadataRequest)

      Updates the metadata for a notebook.

      Parameters:
      updateNotebookMetadataRequest -
      Returns:
      A Java Future containing the result of the UpdateNotebookMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • TooManyRequestsException Indicates that the request was throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateNotebookMetadata

      default CompletableFuture<UpdateNotebookMetadataResponse> updateNotebookMetadata(Consumer<UpdateNotebookMetadataRequest.Builder> updateNotebookMetadataRequest)

      Updates the metadata for a notebook.


      This is a convenience which creates an instance of the UpdateNotebookMetadataRequest.Builder avoiding the need to create one manually via UpdateNotebookMetadataRequest.builder()

      Parameters:
      updateNotebookMetadataRequest - A Consumer that will call methods on UpdateNotebookMetadataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateNotebookMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • TooManyRequestsException Indicates that the request was throttled.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePreparedStatement

      default CompletableFuture<UpdatePreparedStatementResponse> updatePreparedStatement(UpdatePreparedStatementRequest updatePreparedStatementRequest)

      Updates a prepared statement.

      Parameters:
      updatePreparedStatementRequest -
      Returns:
      A Java Future containing the result of the UpdatePreparedStatement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePreparedStatement

      default CompletableFuture<UpdatePreparedStatementResponse> updatePreparedStatement(Consumer<UpdatePreparedStatementRequest.Builder> updatePreparedStatementRequest)

      Updates a prepared statement.


      This is a convenience which creates an instance of the UpdatePreparedStatementRequest.Builder avoiding the need to create one manually via UpdatePreparedStatementRequest.builder()

      Parameters:
      updatePreparedStatementRequest - A Consumer that will call methods on UpdatePreparedStatementRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdatePreparedStatement operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • ResourceNotFoundException A resource, such as a workgroup, was not found.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateWorkGroup

      default CompletableFuture<UpdateWorkGroupResponse> updateWorkGroup(UpdateWorkGroupRequest updateWorkGroupRequest)

      Updates the workgroup with the specified name. The workgroup's name cannot be changed. Only ConfigurationUpdates can be specified.

      Parameters:
      updateWorkGroupRequest -
      Returns:
      A Java Future containing the result of the UpdateWorkGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateWorkGroup

      default CompletableFuture<UpdateWorkGroupResponse> updateWorkGroup(Consumer<UpdateWorkGroupRequest.Builder> updateWorkGroupRequest)

      Updates the workgroup with the specified name. The workgroup's name cannot be changed. Only ConfigurationUpdates can be specified.


      This is a convenience which creates an instance of the UpdateWorkGroupRequest.Builder avoiding the need to create one manually via UpdateWorkGroupRequest.builder()

      Parameters:
      updateWorkGroupRequest - A Consumer that will call methods on UpdateWorkGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateWorkGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalServerException Indicates a platform issue, which may be due to a transient condition or outage.
      • InvalidRequestException Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AthenaException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default AthenaServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static AthenaAsyncClient create()
      Create a AthenaAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static AthenaAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a AthenaAsyncClient.