Interface MarketplaceEntitlementClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aMarketplaceEntitlementClient
.static MarketplaceEntitlementClient
create()
Create aMarketplaceEntitlementClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.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.default GetEntitlementsIterable
getEntitlementsPaginator
(Consumer<GetEntitlementsRequest.Builder> getEntitlementsRequest) This is a variant ofgetEntitlements(software.amazon.awssdk.services.marketplaceentitlement.model.GetEntitlementsRequest)
operation.default GetEntitlementsIterable
getEntitlementsPaginator
(GetEntitlementsRequest getEntitlementsRequest) This is a variant ofgetEntitlements(software.amazon.awssdk.services.marketplaceentitlement.model.GetEntitlementsRequest)
operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
getEntitlements
default GetEntitlementsResponse getEntitlements(GetEntitlementsRequest getEntitlementsRequest) throws InvalidParameterException, ThrottlingException, InternalServiceErrorException, AwsServiceException, 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.
- See Also:
-
getEntitlements
default GetEntitlementsResponse getEntitlements(Consumer<GetEntitlementsRequest.Builder> getEntitlementsRequest) throws InvalidParameterException, ThrottlingException, InternalServiceErrorException, AwsServiceException, SdkClientException, MarketplaceEntitlementException 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 viaGetEntitlementsRequest.builder()
- Parameters:
getEntitlementsRequest
- AConsumer
that will call methods onGetEntitlementsRequest.Builder
to create a request. The GetEntitlementsRequest contains parameters for the GetEntitlements operation.- Returns:
- Result of the GetEntitlements operation returned by the service.
- See Also:
-
getEntitlementsPaginator
default GetEntitlementsIterable getEntitlementsPaginator(GetEntitlementsRequest getEntitlementsRequest) throws InvalidParameterException, ThrottlingException, InternalServiceErrorException, AwsServiceException, SdkClientException, MarketplaceEntitlementException This is a variant of
getEntitlements(software.amazon.awssdk.services.marketplaceentitlement.model.GetEntitlementsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.marketplaceentitlement.paginators.GetEntitlementsIterable responses = client.getEntitlementsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.marketplaceentitlement.paginators.GetEntitlementsIterable responses = client .getEntitlementsPaginator(request); for (software.amazon.awssdk.services.marketplaceentitlement.model.GetEntitlementsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.marketplaceentitlement.paginators.GetEntitlementsIterable responses = client.getEntitlementsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
getEntitlementsPaginator
default GetEntitlementsIterable getEntitlementsPaginator(Consumer<GetEntitlementsRequest.Builder> getEntitlementsRequest) throws InvalidParameterException, ThrottlingException, InternalServiceErrorException, AwsServiceException, SdkClientException, MarketplaceEntitlementException This is a variant of
getEntitlements(software.amazon.awssdk.services.marketplaceentitlement.model.GetEntitlementsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.marketplaceentitlement.paginators.GetEntitlementsIterable responses = client.getEntitlementsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.marketplaceentitlement.paginators.GetEntitlementsIterable responses = client .getEntitlementsPaginator(request); for (software.amazon.awssdk.services.marketplaceentitlement.model.GetEntitlementsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.marketplaceentitlement.paginators.GetEntitlementsIterable responses = client.getEntitlementsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaGetEntitlementsRequest.builder()
- Parameters:
getEntitlementsRequest
- AConsumer
that will call methods onGetEntitlementsRequest.Builder
to create a request. The GetEntitlementsRequest contains parameters for the GetEntitlements operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
create
Create aMarketplaceEntitlementClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aMarketplaceEntitlementClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-