Interface ElasticInferenceAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ElasticInferenceAsyncClient extends AwsClient
Service client for accessing Amazon Elastic Inference 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 Elastic Inference is no longer available.

Elastic Inference public APIs.

  • Field Details

  • Method Details

    • describeAcceleratorOfferings

      default CompletableFuture<DescribeAcceleratorOfferingsResponse> describeAcceleratorOfferings(DescribeAcceleratorOfferingsRequest describeAcceleratorOfferingsRequest)

      Amazon Elastic Inference is no longer available.

      Describes the locations in which a given accelerator type or set of types is present in a given region.

      Parameters:
      describeAcceleratorOfferingsRequest -
      Returns:
      A Java Future containing the result of the DescribeAcceleratorOfferings 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.
      • BadRequestException Raised when a malformed input has been provided to the API.
      • ResourceNotFoundException Raised when the requested resource cannot be found.
      • InternalServerException Raised when an unexpected error occurred during request processing.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ElasticInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAcceleratorOfferings

      default CompletableFuture<DescribeAcceleratorOfferingsResponse> describeAcceleratorOfferings(Consumer<DescribeAcceleratorOfferingsRequest.Builder> describeAcceleratorOfferingsRequest)

      Amazon Elastic Inference is no longer available.

      Describes the locations in which a given accelerator type or set of types is present in a given region.


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

      Parameters:
      describeAcceleratorOfferingsRequest - A Consumer that will call methods on DescribeAcceleratorOfferingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAcceleratorOfferings 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.
      • BadRequestException Raised when a malformed input has been provided to the API.
      • ResourceNotFoundException Raised when the requested resource cannot be found.
      • InternalServerException Raised when an unexpected error occurred during request processing.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ElasticInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAcceleratorTypes

      default CompletableFuture<DescribeAcceleratorTypesResponse> describeAcceleratorTypes(DescribeAcceleratorTypesRequest describeAcceleratorTypesRequest)

      Amazon Elastic Inference is no longer available.

      Describes the accelerator types available in a given region, as well as their characteristics, such as memory and throughput.

      Parameters:
      describeAcceleratorTypesRequest -
      Returns:
      A Java Future containing the result of the DescribeAcceleratorTypes 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 Raised when an unexpected error occurred during request processing.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ElasticInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAcceleratorTypes

      default CompletableFuture<DescribeAcceleratorTypesResponse> describeAcceleratorTypes(Consumer<DescribeAcceleratorTypesRequest.Builder> describeAcceleratorTypesRequest)

      Amazon Elastic Inference is no longer available.

      Describes the accelerator types available in a given region, as well as their characteristics, such as memory and throughput.


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

      Parameters:
      describeAcceleratorTypesRequest - A Consumer that will call methods on DescribeAcceleratorTypesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAcceleratorTypes 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 Raised when an unexpected error occurred during request processing.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ElasticInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAccelerators

      default CompletableFuture<DescribeAcceleratorsResponse> describeAccelerators(DescribeAcceleratorsRequest describeAcceleratorsRequest)

      Amazon Elastic Inference is no longer available.

      Describes information over a provided set of accelerators belonging to an account.

      Parameters:
      describeAcceleratorsRequest -
      Returns:
      A Java Future containing the result of the DescribeAccelerators 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.
      • BadRequestException Raised when a malformed input has been provided to the API.
      • ResourceNotFoundException Raised when the requested resource cannot be found.
      • InternalServerException Raised when an unexpected error occurred during request processing.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ElasticInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAccelerators

      default CompletableFuture<DescribeAcceleratorsResponse> describeAccelerators(Consumer<DescribeAcceleratorsRequest.Builder> describeAcceleratorsRequest)

      Amazon Elastic Inference is no longer available.

      Describes information over a provided set of accelerators belonging to an account.


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

      Parameters:
      describeAcceleratorsRequest - A Consumer that will call methods on DescribeAcceleratorsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAccelerators 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.
      • BadRequestException Raised when a malformed input has been provided to the API.
      • ResourceNotFoundException Raised when the requested resource cannot be found.
      • InternalServerException Raised when an unexpected error occurred during request processing.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ElasticInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAcceleratorsPaginator

      default DescribeAcceleratorsPublisher describeAcceleratorsPaginator(DescribeAcceleratorsRequest describeAcceleratorsRequest)

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

      Parameters:
      describeAcceleratorsRequest -
      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.
      • BadRequestException Raised when a malformed input has been provided to the API.
      • ResourceNotFoundException Raised when the requested resource cannot be found.
      • InternalServerException Raised when an unexpected error occurred during request processing.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ElasticInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAcceleratorsPaginator

      default DescribeAcceleratorsPublisher describeAcceleratorsPaginator(Consumer<DescribeAcceleratorsRequest.Builder> describeAcceleratorsRequest)

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


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

      Parameters:
      describeAcceleratorsRequest - A Consumer that will call methods on DescribeAcceleratorsRequest.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.
      • BadRequestException Raised when a malformed input has been provided to the API.
      • ResourceNotFoundException Raised when the requested resource cannot be found.
      • InternalServerException Raised when an unexpected error occurred during request processing.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ElasticInferenceException 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)

      Amazon Elastic Inference is no longer available.

      Returns all tags of an Elastic Inference Accelerator.

      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.
      • BadRequestException Raised when a malformed input has been provided to the API.
      • ResourceNotFoundException Raised when the requested resource cannot be found.
      • InternalServerException Raised when an unexpected error occurred during request processing.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ElasticInferenceException 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)

      Amazon Elastic Inference is no longer available.

      Returns all tags of an Elastic Inference Accelerator.


      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.
      • BadRequestException Raised when a malformed input has been provided to the API.
      • ResourceNotFoundException Raised when the requested resource cannot be found.
      • InternalServerException Raised when an unexpected error occurred during request processing.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ElasticInferenceException 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)

      Amazon Elastic Inference is no longer available.

      Adds the specified tags to an Elastic Inference Accelerator.

      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.
      • BadRequestException Raised when a malformed input has been provided to the API.
      • ResourceNotFoundException Raised when the requested resource cannot be found.
      • InternalServerException Raised when an unexpected error occurred during request processing.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ElasticInferenceException 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)

      Amazon Elastic Inference is no longer available.

      Adds the specified tags to an Elastic Inference Accelerator.


      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.
      • BadRequestException Raised when a malformed input has been provided to the API.
      • ResourceNotFoundException Raised when the requested resource cannot be found.
      • InternalServerException Raised when an unexpected error occurred during request processing.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ElasticInferenceException 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)

      Amazon Elastic Inference is no longer available.

      Removes the specified tags from an Elastic Inference Accelerator.

      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.
      • BadRequestException Raised when a malformed input has been provided to the API.
      • ResourceNotFoundException Raised when the requested resource cannot be found.
      • InternalServerException Raised when an unexpected error occurred during request processing.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ElasticInferenceException 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)

      Amazon Elastic Inference is no longer available.

      Removes the specified tags from an Elastic Inference Accelerator.


      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.
      • BadRequestException Raised when a malformed input has been provided to the API.
      • ResourceNotFoundException Raised when the requested resource cannot be found.
      • InternalServerException Raised when an unexpected error occurred during request processing.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • ElasticInferenceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

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

    • builder

      static ElasticInferenceAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a ElasticInferenceAsyncClient.