software.amazon.awssdk.services.marketplaceentitlement

Interface MarketplaceEntitlementAsyncClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated(value="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. 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 Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_METADATA_ID Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static MarketplaceEntitlementAsyncClientBuilder	builder() Create a builder that can be used to configure and create a MarketplaceEntitlementAsyncClient.
static MarketplaceEntitlementAsyncClient	create() Create a MarketplaceEntitlementAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<GetEntitlementsResponse>	getEntitlements(Consumer<GetEntitlementsRequest.Builder> getEntitlementsRequest) GetEntitlements retrieves entitlement values for a given product.
default CompletableFuture<GetEntitlementsResponse>	getEntitlements(GetEntitlementsRequest getEntitlementsRequest) GetEntitlements retrieves entitlement values for a given product.
default MarketplaceEntitlementServiceClientConfiguration	serviceClientConfiguration()

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

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.

• 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:

AWS API Documentation

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.

• 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:

AWS API Documentation

serviceClientConfiguration

default MarketplaceEntitlementServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

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.