Package software.amazon.awssdk.services.braket

Interface BraketAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface BraketAsyncClient extends AwsClient
Service client for accessing Braket asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference 
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.

The Amazon Braket API Reference provides information about the operations and structures supported in Amazon Braket.

Additional Resources:

  • Field Details

  • Method Details

    • cancelJob

      default CompletableFuture<CancelJobResponse> cancelJob(CancelJobRequest cancelJobRequest)

      Cancels an Amazon Braket job.

      Parameters:
      cancelJobRequest -
      Returns:
      A Java Future containing the result of the CancelJob 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.
      • ResourceNotFoundException The specified resource was not found.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ConflictException An error occurred due to a conflict.
      • ThrottlingException The throttling rate limit is met.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelJob

      default CompletableFuture<CancelJobResponse> cancelJob(Consumer<CancelJobRequest.Builder> cancelJobRequest)

      Cancels an Amazon Braket job.


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

      Parameters:
      cancelJobRequest - A Consumer that will call methods on CancelJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CancelJob 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.
      • ResourceNotFoundException The specified resource was not found.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ConflictException An error occurred due to a conflict.
      • ThrottlingException The throttling rate limit is met.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelQuantumTask

      default CompletableFuture<CancelQuantumTaskResponse> cancelQuantumTask(CancelQuantumTaskRequest cancelQuantumTaskRequest)

      Cancels the specified task.

      Parameters:
      cancelQuantumTaskRequest -
      Returns:
      A Java Future containing the result of the CancelQuantumTask 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.
      • ResourceNotFoundException The specified resource was not found.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ConflictException An error occurred due to a conflict.
      • ThrottlingException The throttling rate limit is met.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelQuantumTask

      default CompletableFuture<CancelQuantumTaskResponse> cancelQuantumTask(Consumer<CancelQuantumTaskRequest.Builder> cancelQuantumTaskRequest)

      Cancels the specified task.


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

      Parameters:
      cancelQuantumTaskRequest - A Consumer that will call methods on CancelQuantumTaskRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CancelQuantumTask 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.
      • ResourceNotFoundException The specified resource was not found.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ConflictException An error occurred due to a conflict.
      • ThrottlingException The throttling rate limit is met.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createJob

      default CompletableFuture<CreateJobResponse> createJob(CreateJobRequest createJobRequest)

      Creates an Amazon Braket job.

      Parameters:
      createJobRequest -
      Returns:
      A Java Future containing the result of the CreateJob 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.
      • ConflictException An error occurred due to a conflict.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling rate limit is met.
      • DeviceOfflineException The specified device is currently offline.
      • DeviceRetiredException The specified device has been retired.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ServiceQuotaExceededException The request failed because a service quota is exceeded.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createJob

      default CompletableFuture<CreateJobResponse> createJob(Consumer<CreateJobRequest.Builder> createJobRequest)

      Creates an Amazon Braket job.


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

      Parameters:
      createJobRequest - A Consumer that will call methods on CreateJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateJob 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.
      • ConflictException An error occurred due to a conflict.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling rate limit is met.
      • DeviceOfflineException The specified device is currently offline.
      • DeviceRetiredException The specified device has been retired.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ServiceQuotaExceededException The request failed because a service quota is exceeded.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createQuantumTask

      default CompletableFuture<CreateQuantumTaskResponse> createQuantumTask(CreateQuantumTaskRequest createQuantumTaskRequest)

      Creates a quantum task.

      Parameters:
      createQuantumTaskRequest -
      Returns:
      A Java Future containing the result of the CreateQuantumTask 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.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling rate limit is met.
      • DeviceOfflineException The specified device is currently offline.
      • DeviceRetiredException The specified device has been retired.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ServiceQuotaExceededException The request failed because a service quota is exceeded.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createQuantumTask

      default CompletableFuture<CreateQuantumTaskResponse> createQuantumTask(Consumer<CreateQuantumTaskRequest.Builder> createQuantumTaskRequest)

      Creates a quantum task.


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

      Parameters:
      createQuantumTaskRequest - A Consumer that will call methods on CreateQuantumTaskRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateQuantumTask 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.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling rate limit is met.
      • DeviceOfflineException The specified device is currently offline.
      • DeviceRetiredException The specified device has been retired.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ServiceQuotaExceededException The request failed because a service quota is exceeded.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDevice

      default CompletableFuture<GetDeviceResponse> getDevice(GetDeviceRequest getDeviceRequest)

      Retrieves the devices available in Amazon Braket.

      For backwards compatibility with older versions of BraketSchemas, OpenQASM information is omitted from GetDevice API calls. To get this information the user-agent needs to present a recent version of the BraketSchemas (1.8.0 or later). The Braket SDK automatically reports this for you. If you do not see OpenQASM results in the GetDevice response when using a Braket SDK, you may need to set AWS_EXECUTION_ENV environment variable to configure user-agent. See the code examples provided below for how to do this for the AWS CLI, Boto3, and the Go, Java, and JavaScript/TypeScript SDKs.

      Parameters:
      getDeviceRequest -
      Returns:
      A Java Future containing the result of the GetDevice 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.
      • ResourceNotFoundException The specified resource was not found.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling rate limit is met.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDevice

      default CompletableFuture<GetDeviceResponse> getDevice(Consumer<GetDeviceRequest.Builder> getDeviceRequest)

      Retrieves the devices available in Amazon Braket.

      For backwards compatibility with older versions of BraketSchemas, OpenQASM information is omitted from GetDevice API calls. To get this information the user-agent needs to present a recent version of the BraketSchemas (1.8.0 or later). The Braket SDK automatically reports this for you. If you do not see OpenQASM results in the GetDevice response when using a Braket SDK, you may need to set AWS_EXECUTION_ENV environment variable to configure user-agent. See the code examples provided below for how to do this for the AWS CLI, Boto3, and the Go, Java, and JavaScript/TypeScript SDKs.


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

      Parameters:
      getDeviceRequest - A Consumer that will call methods on GetDeviceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDevice 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.
      • ResourceNotFoundException The specified resource was not found.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling rate limit is met.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getJob

      default CompletableFuture<GetJobResponse> getJob(GetJobRequest getJobRequest)

      Retrieves the specified Amazon Braket job.

      Parameters:
      getJobRequest -
      Returns:
      A Java Future containing the result of the GetJob 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.
      • ResourceNotFoundException The specified resource was not found.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling rate limit is met.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getJob

      default CompletableFuture<GetJobResponse> getJob(Consumer<GetJobRequest.Builder> getJobRequest)

      Retrieves the specified Amazon Braket job.


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

      Parameters:
      getJobRequest - A Consumer that will call methods on GetJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetJob 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.
      • ResourceNotFoundException The specified resource was not found.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling rate limit is met.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getQuantumTask

      default CompletableFuture<GetQuantumTaskResponse> getQuantumTask(GetQuantumTaskRequest getQuantumTaskRequest)

      Retrieves the specified quantum task.

      Parameters:
      getQuantumTaskRequest -
      Returns:
      A Java Future containing the result of the GetQuantumTask 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.
      • ResourceNotFoundException The specified resource was not found.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling rate limit is met.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getQuantumTask

      default CompletableFuture<GetQuantumTaskResponse> getQuantumTask(Consumer<GetQuantumTaskRequest.Builder> getQuantumTaskRequest)

      Retrieves the specified quantum task.


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

      Parameters:
      getQuantumTaskRequest - A Consumer that will call methods on GetQuantumTaskRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetQuantumTask 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.
      • ResourceNotFoundException The specified resource was not found.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling rate limit is met.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException 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)

      Shows the tags associated with this 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException 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)

      Shows the tags associated with this 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchDevices

      default CompletableFuture<SearchDevicesResponse> searchDevices(SearchDevicesRequest searchDevicesRequest)

      Searches for devices using the specified filters.

      Parameters:
      searchDevicesRequest -
      Returns:
      A Java Future containing the result of the SearchDevices 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.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling rate limit is met.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchDevices

      default CompletableFuture<SearchDevicesResponse> searchDevices(Consumer<SearchDevicesRequest.Builder> searchDevicesRequest)

      Searches for devices using the specified filters.


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

      Parameters:
      searchDevicesRequest - A Consumer that will call methods on SearchDevicesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchDevices 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.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling rate limit is met.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchDevicesPaginator

      default SearchDevicesPublisher searchDevicesPaginator(SearchDevicesRequest searchDevicesRequest)

      This is a variant of searchDevices(software.amazon.awssdk.services.braket.model.SearchDevicesRequest) 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.braket.paginators.SearchDevicesPublisher publisher = client.searchDevicesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.braket.paginators.SearchDevicesPublisher publisher = client.searchDevicesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.braket.model.SearchDevicesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.braket.model.SearchDevicesResponse 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 searchDevices(software.amazon.awssdk.services.braket.model.SearchDevicesRequest) operation.

      Parameters:
      searchDevicesRequest -
      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.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling rate limit is met.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchDevicesPaginator

      default SearchDevicesPublisher searchDevicesPaginator(Consumer<SearchDevicesRequest.Builder> searchDevicesRequest)

      This is a variant of searchDevices(software.amazon.awssdk.services.braket.model.SearchDevicesRequest) 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.braket.paginators.SearchDevicesPublisher publisher = client.searchDevicesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.braket.paginators.SearchDevicesPublisher publisher = client.searchDevicesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.braket.model.SearchDevicesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.braket.model.SearchDevicesResponse 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 searchDevices(software.amazon.awssdk.services.braket.model.SearchDevicesRequest) operation.


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

      Parameters:
      searchDevicesRequest - A Consumer that will call methods on SearchDevicesRequest.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.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling rate limit is met.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchJobs

      default CompletableFuture<SearchJobsResponse> searchJobs(SearchJobsRequest searchJobsRequest)

      Searches for Amazon Braket jobs that match the specified filter values.

      Parameters:
      searchJobsRequest -
      Returns:
      A Java Future containing the result of the SearchJobs 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.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling rate limit is met.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchJobs

      default CompletableFuture<SearchJobsResponse> searchJobs(Consumer<SearchJobsRequest.Builder> searchJobsRequest)

      Searches for Amazon Braket jobs that match the specified filter values.


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

      Parameters:
      searchJobsRequest - A Consumer that will call methods on SearchJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchJobs 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.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling rate limit is met.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchJobsPaginator

      default SearchJobsPublisher searchJobsPaginator(SearchJobsRequest searchJobsRequest)

      This is a variant of searchJobs(software.amazon.awssdk.services.braket.model.SearchJobsRequest) 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.braket.paginators.SearchJobsPublisher publisher = client.searchJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.braket.paginators.SearchJobsPublisher publisher = client.searchJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.braket.model.SearchJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.braket.model.SearchJobsResponse 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 searchJobs(software.amazon.awssdk.services.braket.model.SearchJobsRequest) operation.

      Parameters:
      searchJobsRequest -
      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.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling rate limit is met.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchJobsPaginator

      default SearchJobsPublisher searchJobsPaginator(Consumer<SearchJobsRequest.Builder> searchJobsRequest)

      This is a variant of searchJobs(software.amazon.awssdk.services.braket.model.SearchJobsRequest) 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.braket.paginators.SearchJobsPublisher publisher = client.searchJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.braket.paginators.SearchJobsPublisher publisher = client.searchJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.braket.model.SearchJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.braket.model.SearchJobsResponse 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 searchJobs(software.amazon.awssdk.services.braket.model.SearchJobsRequest) operation.


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

      Parameters:
      searchJobsRequest - A Consumer that will call methods on SearchJobsRequest.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.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling rate limit is met.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchQuantumTasks

      default CompletableFuture<SearchQuantumTasksResponse> searchQuantumTasks(SearchQuantumTasksRequest searchQuantumTasksRequest)

      Searches for tasks that match the specified filter values.

      Parameters:
      searchQuantumTasksRequest -
      Returns:
      A Java Future containing the result of the SearchQuantumTasks 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.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling rate limit is met.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchQuantumTasks

      default CompletableFuture<SearchQuantumTasksResponse> searchQuantumTasks(Consumer<SearchQuantumTasksRequest.Builder> searchQuantumTasksRequest)

      Searches for tasks that match the specified filter values.


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

      Parameters:
      searchQuantumTasksRequest - A Consumer that will call methods on SearchQuantumTasksRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchQuantumTasks 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.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling rate limit is met.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchQuantumTasksPaginator

      default SearchQuantumTasksPublisher searchQuantumTasksPaginator(SearchQuantumTasksRequest searchQuantumTasksRequest)

      This is a variant of searchQuantumTasks(software.amazon.awssdk.services.braket.model.SearchQuantumTasksRequest) 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.braket.paginators.SearchQuantumTasksPublisher publisher = client.searchQuantumTasksPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.braket.paginators.SearchQuantumTasksPublisher publisher = client.searchQuantumTasksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.braket.model.SearchQuantumTasksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.braket.model.SearchQuantumTasksResponse 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 searchQuantumTasks(software.amazon.awssdk.services.braket.model.SearchQuantumTasksRequest) operation.

      Parameters:
      searchQuantumTasksRequest -
      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.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling rate limit is met.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchQuantumTasksPaginator

      default SearchQuantumTasksPublisher searchQuantumTasksPaginator(Consumer<SearchQuantumTasksRequest.Builder> searchQuantumTasksRequest)

      This is a variant of searchQuantumTasks(software.amazon.awssdk.services.braket.model.SearchQuantumTasksRequest) 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.braket.paginators.SearchQuantumTasksPublisher publisher = client.searchQuantumTasksPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.braket.paginators.SearchQuantumTasksPublisher publisher = client.searchQuantumTasksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.braket.model.SearchQuantumTasksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.braket.model.SearchQuantumTasksResponse 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 searchQuantumTasks(software.amazon.awssdk.services.braket.model.SearchQuantumTasksRequest) operation.


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

      Parameters:
      searchQuantumTasksRequest - A Consumer that will call methods on SearchQuantumTasksRequest.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.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling rate limit is met.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException 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)

      Add a tag to the specified resource.

      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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException 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)

      Add a tag to the specified resource.


      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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException 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)

      Remove tags from a 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException 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)

      Remove tags from a 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException The request processing has failed because of an unknown error, exception, or failure.
      • ValidationException The input fails to satisfy the constraints specified by an AWS service.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BraketException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default BraketServiceClientConfiguration 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 BraketAsyncClient create()
      Create a BraketAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static BraketAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a BraketAsyncClient.