Package software.amazon.awssdk.services.marketplaceentitlement

Interface MarketplaceEntitlementAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface MarketplaceEntitlementAsyncClient extends AwsClient
Service client for accessing AWS Marketplace Entitlement Service 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. AWS Marketplace Entitlement Service

This reference provides descriptions of the AWS Marketplace Entitlement Service API.

AWS Marketplace Entitlement Service is used to determine the entitlement of a customer to a given product. An entitlement represents capacity in a product owned by the customer. For example, a customer might own some number of users or seats in an SaaS application or some amount of data capacity in a multi-tenant database.

Getting Entitlement Records

  • GetEntitlements- Gets the entitlements for a Marketplace product.

  • Field Details

  • Method Details

    • getEntitlements

      default CompletableFuture<GetEntitlementsResponse> getEntitlements(GetEntitlementsRequest getEntitlementsRequest)

      GetEntitlements retrieves entitlement values for a given product. The results can be filtered based on customer identifier or product dimensions.

      Parameters:
      getEntitlementsRequest - The GetEntitlementsRequest contains parameters for the GetEntitlements operation.
      Returns:
      A Java Future containing the result of the GetEntitlements 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.
      • InvalidParameterException One or more parameters in your request was invalid.
      • ThrottlingException The calls to the GetEntitlements API are throttled.
      • InternalServiceErrorException An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MarketplaceEntitlementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getEntitlements

      default CompletableFuture<GetEntitlementsResponse> getEntitlements(Consumer<GetEntitlementsRequest.Builder> getEntitlementsRequest)

      GetEntitlements retrieves entitlement values for a given product. The results can be filtered based on customer identifier or product dimensions.


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

      Parameters:
      getEntitlementsRequest - A Consumer that will call methods on GetEntitlementsRequest.Builder to create a request. The GetEntitlementsRequest contains parameters for the GetEntitlements operation.
      Returns:
      A Java Future containing the result of the GetEntitlements 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.
      • InvalidParameterException One or more parameters in your request was invalid.
      • ThrottlingException The calls to the GetEntitlements API are throttled.
      • InternalServiceErrorException An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MarketplaceEntitlementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getEntitlementsPaginator

      default GetEntitlementsPublisher getEntitlementsPaginator(GetEntitlementsRequest getEntitlementsRequest)

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

      Parameters:
      getEntitlementsRequest - The GetEntitlementsRequest contains parameters for the GetEntitlements operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException One or more parameters in your request was invalid.
      • ThrottlingException The calls to the GetEntitlements API are throttled.
      • InternalServiceErrorException An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MarketplaceEntitlementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getEntitlementsPaginator

      default GetEntitlementsPublisher getEntitlementsPaginator(Consumer<GetEntitlementsRequest.Builder> getEntitlementsRequest)

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


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

      Parameters:
      getEntitlementsRequest - A Consumer that will call methods on GetEntitlementsRequest.Builder to create a request. The GetEntitlementsRequest contains parameters for the GetEntitlements operation.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException One or more parameters in your request was invalid.
      • ThrottlingException The calls to the GetEntitlements API are throttled.
      • InternalServiceErrorException An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • MarketplaceEntitlementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

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

    • builder

      static MarketplaceEntitlementAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a MarketplaceEntitlementAsyncClient.