Package software.amazon.awssdk.services.marketplaceentitlement

Interface MarketplaceEntitlementClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface MarketplaceEntitlementClient
extends AutoCloseable

Service client for accessing null. 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	Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static MarketplaceEntitlementClientBuilder	builder()	Create a builder that can be used to configure and create a MarketplaceEntitlementClient.
static MarketplaceEntitlementClient	create()	Create a MarketplaceEntitlementClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default GetEntitlementsResponse	getEntitlements(GetEntitlementsRequest getEntitlementsRequest)	GetEntitlements retrieves entitlement values for a given product.
static ServiceMetadata	serviceMetadata()

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static MarketplaceEntitlementClient create()

Create a MarketplaceEntitlementClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static MarketplaceEntitlementClientBuilder builder()

Create a builder that can be used to configure and create a MarketplaceEntitlementClient.

getEntitlements

default GetEntitlementsResponse getEntitlements(GetEntitlementsRequest getEntitlementsRequest)
                                         throws InvalidParameterException,
                                                ThrottlingException,
                                                InternalServiceErrorException,
                                                SdkBaseException,
                                                SdkClientException,
                                                MarketplaceEntitlementException

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:

Result of the GetEntitlements operation returned by the service.

Throws:

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()