@Generated(value="software.amazon.awssdk:codegen") public interface MarketplaceEntitlementClient extends SdkClient, SdkAutoCloseable
builder()
method.
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.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and 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(Consumer<GetEntitlementsRequest.Builder> getEntitlementsRequest)
GetEntitlements retrieves entitlement values for a given product.
|
default GetEntitlementsResponse |
getEntitlements(GetEntitlementsRequest getEntitlementsRequest)
GetEntitlements retrieves entitlement values for a given product.
|
static ServiceMetadata |
serviceMetadata() |
serviceName
close
static final String SERVICE_NAME
static MarketplaceEntitlementClient create()
MarketplaceEntitlementClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from
the DefaultCredentialsProvider
.static MarketplaceEntitlementClientBuilder builder()
MarketplaceEntitlementClient
.default GetEntitlementsResponse getEntitlements(GetEntitlementsRequest getEntitlementsRequest) throws InvalidParameterException, ThrottlingException, InternalServiceErrorException, SdkServiceException, SdkClientException, MarketplaceEntitlementException
GetEntitlements retrieves entitlement values for a given product. The results can be filtered based on customer identifier or product dimensions.
getEntitlementsRequest
- The GetEntitlementsRequest contains parameters for the GetEntitlements operation.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.SdkServiceException
default GetEntitlementsResponse getEntitlements(Consumer<GetEntitlementsRequest.Builder> getEntitlementsRequest) throws InvalidParameterException, ThrottlingException, InternalServiceErrorException, SdkServiceException, SdkClientException, MarketplaceEntitlementException
GetEntitlements retrieves entitlement values for a given product. The results can be filtered based on customer identifier or product dimensions.
getEntitlementsRequest
- The GetEntitlementsRequest contains parameters for the GetEntitlements operation.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.SdkServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.